# react-native-circle-button

> React Native Circle Button

Latest version **1.0.9** (published 2018-03-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-circle-button
pnpm add react-native-circle-button
yarn add react-native-circle-button
bun add react-native-circle-button
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.9 |
| Published | 2018-03-17 |
| First published | 2017-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 13 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 87 |
| Author | Lutfian Dwi Cahyono |
| Maintainers | dwicao |
| Keywords | react, native, circle, button |

## Links

- npm: https://www.npmjs.com/package/react-native-circle-button
- Repository: https://github.com/dwicao/react-native-circle-button
- Homepage: https://github.com/dwicao/react-native-circle-button#readme
- Issues: https://github.com/dwicao/react-native-circle-button/issues
- npm.io page: https://npm.io/package/react-native-circle-button

## Dependencies (1)

- [prop-types](https://npm.io/package/prop-types.md) ^15.6.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.9 (latest) — 2018-03-17
- 1.0.8 — 2017-05-06
- 1.0.7 — 2017-05-02
- 1.0.6 — 2017-05-01
- 1.0.5 — 2017-04-30
- 1.0.4 — 2017-04-30
- 1.0.3 — 2017-03-17
- 1.0.2 — 2017-03-11
- 1.0.1 — 2017-02-01
- 1.0.0 — 2017-02-01

## README

# react-native-circle-button

A Customizable React Native Circle Button, works on both Android and iOS.

![demo](https://raw.githubusercontent.com/dwicao/react-native-circle-button/master/demo_app.gif)

> UPDATE v1.0.6: Support transparent background  
> note: It's lags due to gif recorder app, it actually works more smooth

## Inspiration
[Ux Concept](https://dribbble.com/shots/2233249-Ux-Concept) by [Nick Kumbari](https://dribbble.com/kumbari)

## Installation
* `npm install --save react-native-circle-button`

## Usage
```js
import React, { Component } from 'react';
import { View } from 'react-native';
import CircleButton from 'react-native-circle-button';

class MyExample extends Component {
    render() {
        return (
            <View style={{ flex: 1 }}>
                <CircleButton size={45} />
            </View>
        );
    }
}

export default MyExample;
```

## Props

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| size | number | 40 | Setting overall size |
| primaryColor | string | '#41727E' | Color on inner button |
| secondaryColor | string | '#459186' | Color on outer button |
| onPressButtonTop | function | () => {} | Event onPress Button Top |
| onPressButtonRight | function | () => {} | Event onPress Button Right |
| onPressButtonBottom | function | () => {} | Event onPress Button Bottom |
| onPressButtonLeft | function | () => {} | Event onPress Button Left |
| iconButtonCenter | enum |  | Source path to icon image on center |
| iconButtonTop | enum |  | Source path to icon image on top|
| iconButtonRight | enum |  | Source path to icon image on right |
| iconButtonBottom | enum |  | Source path to icon image on bottom |
| iconButtonLeft | enum |  | Source path to icon image on left |

## License
MIT

---
_Source: https://npm.io/package/react-native-circle-button · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._