https://github.com/likethemammal/react-native-arcade-button

🕹️ Arcade button component for React Native
https://github.com/likethemammal/react-native-arcade-button

arcade game-dev react react-native react-primitives

Last synced: 2 months ago
JSON representation

🕹️ Arcade button component for React Native

• Host: GitHub
• URL: https://github.com/likethemammal/react-native-arcade-button
• Owner: likethemammal
• License: apache-2.0
• Created: 2018-01-17T07:36:36.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-06-07T23:26:27.000Z (over 3 years ago)
• Last Synced: 2024-04-14T22:59:53.525Z (9 months ago)
• Topics: arcade, game-dev, react, react-native, react-primitives
• Language: JavaScript
• Homepage:
• Size: 304 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

react-native-arcade-button

=========

[![Build Status](https://travis-ci.org/likethemammal/react-native-arcade-button.svg?branch=master)](https://travis-ci.org/likethemammal/react-native-arcade-button)

[![Coverage Status](https://coveralls.io/repos/github/likethemammal/react-native-arcade-button/badge.svg?branch=master)](https://coveralls.io/github/likethemammal/react-native-arcade-button?branch=master)

[![npm Version](https://img.shields.io/npm/v/react-native-arcade-button.svg)](https://www.npmjs.com/package/react-native-arcade-button)

[![npm Downloads](https://img.shields.io/npm/dm/react-native-arcade-button.svg)](https://www.npmjs.com/package/react-native-arcade-button)

[![license](https://img.shields.io/github/license/likethemammal/react-native-arcade-button.svg)](https://github.com/likethemammal/react-native-arcade-button/blob/master/LICENSE)

[![screenshot](example/screenshot.png)](demo)

[Live Demo (CodeSandbox)](https://codesandbox.io/s/1rk8r5j1z4)

## Installation

```sh

npm install --save react-native-arcade-button

```

### Usage

```jsx

import React from 'react'

import ArcadeButton from 'react-native-arcade-button'

class Foo extends React.Component {

  onClick = (e) => {

    //...do some logic

  }

  render() {

    return (

      

        Click

      

    )

  }

}

```

### Props

| name        | type           | default  | desc 

--- | --- | --- | --- |

| *children* | Component | null | Traditional React `children` component(s) passed along to label the button. Can be text, icon, etc. |

| color | string | null | Any rgb, hex, hsv, etc. color supported by `StyleSheet`.

| disabled | bool | false | Disables the button presses, will call `onDisabledOut` when pressed anyway (for user experience use cases). |

| onDisabledOut | func | null | When `disabled` is true, function is called when button is pressed out anyway. |

| onPressIn | func | null | Function called when button press in. |

| onPressOut | func | null | Function called when button is released. |

### License

Made with 🍊 by [Chris Dolphin](https://github.com/likethemammal)

[![license](https://img.shields.io/github/license/likethemammal/react-native-arcade-button.svg?style=flat-square)](https://github.com/likethemammal/react-native-arcade-button/blob/master/LICENSE)

[demo]: (https://codesandbox.io/s/1rk8r5j1z4)