Git Product home page Git Product logo

react-native-toggle-button's Introduction

React Native Toggle Button

React Native Toggle Button

npm version npm Platform - Android and iOS License: MIT styled with prettier

React Native Toggle Button

Installation

Add the dependency:

npm i react-native-toggle-button

Peer Dependencies

Zero Dependency

Usage

Import

import ToggleButton from "react-native-toggle-button";

Fundamental Usage

<ToggleButton
  primaryText="On"
  secondaryText="Off"
  onPress={(isToggled: boolean) => {
    console.log(isToggled);
  }}
/>

Example Project ๐Ÿ˜

You can checkout the example project ๐Ÿฅฐ

Simply run

  • npm i
  • react-native run-ios/android

should work of the example project.

Configuration - Props

Fundamentals

Property Type Default Description
primaryText string undefined change the primaryText
secondaryText string undefined change the secondaryText
onPress function undefined set your own logic for the button functionality when it is pressed

Customization (Optionals)

Property Type Default Description
inial boolean true let you change the initial toggled value
style ViewStyle default set or override the style object for the main container
activeButtonStyle ViewStyle default set or override the style object for the active button style
inactiveButtonStyle ViewStyle default set or override the style object for the inactive button style
activeTextStyle TextStyle default set or override the style object for the active text style
inactiveTextStyle TextStyle default set or override the style object for the inactive text style
TouchableComponent TouchableWithoutFeedback default set your own component instead of default react-native TouchableWithoutFeedback component

Future Plans

  • LICENSE
  • Write an article about the lib on Medium

Author

FreakyCoder, [email protected]

License

React Native Toggle Button is available under the MIT license. See the LICENSE file for more info.

react-native-toggle-button's People

Contributors

wrathchaos avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

rnproj

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.