react-native-flextool

TOC

• General Info
• Installation
• Usage
• API
• Release Notes
• react-native-web

General Info

A React Native library for Flex (formally Flipboard FLEX) tool that is a must for iOS debugging. The original tool just support iOS, but this wrapper make at least don't fail either for Android or Web.

Forked from https://github.com/fjtrujy/react-native-flipboard-flex with support for FLEX 4.x.

Installation

Using npm:

npm install --save react-native-flextool

or using yarn:

yarn add react-native-flextool

Usage

var RNFlipboardFlex = import RNFlipboardFlex from 'react-native-flipboard-flex';

API

| Method | Return Type | iOS | Android | Since | | ------------------------------------------------- | ------------------- | :--: | :-----: | :-----: | | showExplorer() | void | ✅ | ✅ | 1.0.0 | | hideExplorer() | void | ✅ | ✅ | 1.0.3 | | toggleExplorer() | void | ✅ | ✅ | 1.0.3 |

showExplorer()

Show Flex explorer.

Examples

RNFlipboardFlex.showExplorer();

// iOS: Will Show the flex explorer
// Android: Will do nothing

hideExplorer()

Hide Flex explorer.

Examples

RNFlipboardFlex.hideExplorer();

// iOS: Will hide the flex explorer
// Android: Will do nothing

toggleExplorer()

Will Show Flex explorer if it is hidden and will hide the exploer if it is shown.

Examples

RNFlipboardFlex.toggleExplorer();

// iOS: Will toggle the flex explorer
// Android: Will do nothing

Notes

Please add the following line to your Podfile to exclude for Release builds.

pod 'FLEX', :configurations => ['Debug']

The library recognizes DEBUG and BETA preprocessors to include FLEX.

See Flex github

Release Notes

See the CHANGELOG.md.

react-native-web

This library was made compatible with react-native-web by providing an empty polyfill in order to avoid breaking builds.