Light

0xn33t / capacitor-widgetsbridge-plugin Goto Github PK

View Code? Open in Web Editor NEW

23.0 2.0 7.0 1.66 MB

Ruby 6.29% Objective-C 2.60% Swift 25.16% JavaScript 7.15% TypeScript 33.55% HTML 3.54% SCSS 21.72%

capacitor-widgetsbridge-plugin's Introduction

capacitor-widgetsbridge-plugin

Capacitor plugin to interact with ios widgetkit

Demo

Install

npm install capacitor-widgetsbridge-plugin
npx cap sync

API

getItem(...)
setItem(...)
removeItem(...)
reloadAllTimelines()
reloadTimelines(...)
getCurrentConfigurations()
Interfaces

getItem(...)

getItem(options: UserDefaultsOptions) => Promise<DataResults<any>>

Return the value from user’s defaults database associated with the specified key

Param	Type
`options`	`UserDefaultsOptions`

Returns: Promise<DataResults<any>>

setItem(...)

setItem(options: UserDefaultsOptions) => Promise<DataResults<boolean>>

Set the value to user’s defaults database associated with the specified key

Param	Type
`options`	`UserDefaultsOptions`

Returns: Promise<DataResults<boolean>>

removeItem(...)

removeItem(options: UserDefaultsOptions) => Promise<DataResults<boolean>>

Remove the value from user’s defaults database associated with the specified key

Param	Type
`options`	`UserDefaultsOptions`

Returns: Promise<DataResults<boolean>>

reloadAllTimelines()

reloadAllTimelines() => Promise<DataResults<boolean>>

Reloads the timelines for all configured widgets belonging to the containing app

Returns: Promise<DataResults<boolean>>

reloadTimelines(...)

reloadTimelines(options: TimelinesOptions) => Promise<DataResults<boolean>>

Reloads the timelines for all widgets of a particular kind

Param	Type
`options`	`TimelinesOptions`

Returns: Promise<DataResults<boolean>>

getCurrentConfigurations()

getCurrentConfigurations() => Promise<DataResults<any>>

Get current widget configurations

Returns: Promise<DataResults<any>>

Interfaces

DataResults

Prop	Type	Description
`results`	`T`	Holds response results from native code

UserDefaultsOptions

Prop	Type	Description
`key`	`string`	The key whose value to retrieve from storage.
`group`	`string`	User defaults database name which holds and organizes key/value pairs
`value`	`string`	The value to set in storage with the associated key

TimelinesOptions

Prop	Type	Description
`ofKind`	`string`	A string that identifies the widget and matches the value you used when you created the widget’s configuration

capacitor-widgetsbridge-plugin's People

Contributors

Stargazers

Watchers

Forkers

vanessag bubble-labs varinliali ecnivtwelve zeka035 betula-bookmarks vchau254

capacitor-widgetsbridge-plugin's Issues

Update support for @capacitor/core@"^4.0.0

Now that we are in @capacitor/core@"^4.0.0 could the dependancy please be updated to support that major version?

Update support for @capacitor/core@"^5.0.0

Now that we are in Capacitor 5 @capacitor/core@"^5.0.0 could the dependency please be updated to support that major version?

Issue with setup

I'm pretty new to Capacitor/iOS development and I have some issues setting up this plugin.
I have no issue implementing the capacitor part and I have the basic widget showing "Not Set".

But I can't get them to communicate with each other. Do you mind explaining the correct setup a bit in the Readme?

1.01 not available via npm

Thank you for the latest update addressing the capacitor dependancy issue! Just flagging that the update doesn't seem to be available to update via npm yet.

Need some help

Hi. Could you please provide sort of step by step guide ? Absolutely no idea how to integrate plugin with current application. I've already set up the app group and stuck now

Project file references incorrect file

The "PBXFileReference" section in project.pbxproj is referencing an incorrect file in the first line.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.