Giter Club home page Giter Club logo

flipper's Introduction

Capacitor Flipper Plugin

Capacitory community plugin for Flipper.

Maintainers

Maintainer GitHub Social Sponsoring Company
Priyank Patel priyankpat @priyankpat_ Ionic

Mainteinance Status: Actively Maintained

Requirement

Download Flipper, available for Linux/Windows/Mac or run brew cask install flipper on Mac

Installation

To use npm

npm install @capacitor/flipper

To use yarn

yarn add @capacitor/flipper

Sync native files

npx cap sync

On iOS, no further steps are needed.

On Android, register the plugin in your main activity:

import com.getcapacitor.community.flipper.Flipper;

public class MainActivity extends BridgeActivity {

  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // Initializes the Bridge
    this.init(
        savedInstanceState,
        new ArrayList<Class<? extends Plugin>>() {

          {
            // Additional plugins you've installed go here
            // Ex: add(TotallyAwesomePlugin.class);
            add(Flipper.class);
          }
        }
      );
  }
}

Configuration

No configuration required for this plugin.

Supported methods

Name Android iOS Web
initialize
emulateCrash

Example

Click here for example code

git clone https://github.com/capacitor-community/flipper.git
git checkout flipper

Usage

import { Plugins } from "@capacitor/core";

const { Flipper } = Plugins;

/**
 * This method will configure and initialize the flipper package.
 * @param enabled - boolean true/false to enable/disable flipper
 *        network - boolean true/false to enable network plugin
 *        crash_report - boolean true/false to enable crash reporting
 *        layout_inspector - boolean true/false to enable layout inspector
 *        database - boolean true/false to enable database plugin (sqlite)
 *        database_path - custom database path if database is not stored in application context (Android)
 * @returns void
 * Make sure you have flipper running in background or restart the app for plugins to communicate with flipper
 */
Flipper.initialize({
  enabled: true,
  network: true,
  crash_report: true,
  layout_inspector: true,
  database: true,
});

/**
 * This method will trigger a custom crash notification.
 * @param none
 * @returns void
 */
Flipper.emulateCrash({
  message: "Forced Crash",
});

flipper's People

Contributors

priyankpat avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

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

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.