Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

react-native-widget-picker

retyui1.1kMIT1.0.3TypeScript support: included

Request to pin an app widget on the current launcher

react, react-native, react-native-component, android, android-widget, widget, home-screen, home-screen-widget

readme

react-native-widget-picker

react-native-widget-picker on npm react-native-widget-picker downloads react-native-widget-picker install size CI status

Let users pin a widget. On devices running Android 8.0 (API level 26) and higher, launchers that let pin widgets onto their home screen

https://github.com/retyui/react-native-detect-maestro/assets/4661784/e301602d-d82e-4f5f-b259-1bae3677b868

Getting started

  • Android only
  • support React Native's New & Old Architecture
yarn add react-native-widget-picker
# or
npm install react-native-widget-picker

Edit android/app/src/main/java/com/.../MainActivity.java and add:

+import com.retyui.widgetpicker.WidgetPickerModuleImpl;

public class MainActivity extends ReactActivity {

  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
+    WidgetPickerModuleImpl.registerWidgetClass("MyAppWidget", MyAppWidget.class);
    // you can register multiple widgets ^^^ 
  }

Usage

import {WidgetPicker} from 'react-native-widget-picker';

WidgetPicker.isRequestPinAppWidgetSupported() // true or false

WidgetPicker.requestPinAppWidget("MyAppWidget").then((value) => { // "MyAppWidget" - name from MainActivity.java
    if (value.message === "success") {
        // success
    }
});

License

MIT