https://github.com/calitb/react-native-widgetkit
https://github.com/calitb/react-native-widgetkit
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/calitb/react-native-widgetkit
- Owner: calitb
- Created: 2022-08-30T23:06:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-19T14:14:16.000Z (about 3 years ago)
- Last Synced: 2025-04-10T18:02:56.233Z (9 months ago)
- Language: Ruby
- Size: 154 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WidgetKit
An interface to WidgetCenter apis [WidgetCenter](https://developer.apple.com/documentation/widgetkit/widgetcenter).
- :white_check_mark: Built with [Expo's Module API](https://docs.expo.dev/modules/module-api/)
- :white_check_mark: Written in TypeScript and Swift
- :apple: Currently iOS only
## Installation
1. Install the package
```
npm i @calitb/react-native-widgetkit
```
## Usage
### Standard Defaults
```
import WidgetKit from '@calitb/react-native-widgetkit';
await WidgetKit.standard.reloadAllTimelines();
```
## API
```typescript
interface WidgetKit {
/* Standard object */
standard: WidgetKit;
/* Reloads the timelines for all configured widgets belonging to the containing app. */
reloadAllTimelines(): Promise;
}
```