# rn-expandable-circle-menu

> React native expandable circle library

Latest version **1.0.2** (published 2020-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install rn-expandable-circle-menu
pnpm add rn-expandable-circle-menu
yarn add rn-expandable-circle-menu
bun add rn-expandable-circle-menu
```

## 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.2 |
| Published | 2020-06-11 |
| First published | 2020-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gokberk Bardakci |
| Maintainers | gbk94 |
| Keywords | react, native, expandable, circle, menu, animation |

## Links

- npm: https://www.npmjs.com/package/rn-expandable-circle-menu
- Repository: https://github.com/gbk94/react-native-expandable-circle-menu
- Homepage: https://github.com/gbk94/react-native-expandable-circle-menu#readme
- Issues: https://github.com/gbk94/react-native-expandable-circle-menu/issues
- npm.io page: https://npm.io/package/rn-expandable-circle-menu

## 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.2 (latest) — 2020-06-11
- 1.0.1 — 2020-06-11
- 1.0.0 — 2020-06-11

## README

# React Native Expandable Circle Menu

React Native expandable circle menu library

## Demo

[<img src="./screenshots/demo.gif">]()

## Installation

First, download the library from npm:

```
npm install rn-expandable-circle-menu --save
```

## Usage

```javascript
import CircleMenu from 'rn-expandable-circle-menu'

const openMenuButton = {
  image: require('./assets/openMenu.png'),
}

const closeMenuButton = {
  image: require('./assets/closeMenu.png'),
  // You can override style of every item
  style: {
    backgroundColor: 'red'
  }
}

const menuItems = [
  {
    image: require('./assets/shareLogo.png'),
    onClick: () => {
      alert('Share button pressed')
    },
    style: {
      backgroundColor: 'yellow'
    }
  },
  {
    image: require('./assets/searchLogo.png'),
    onClick: () => {
      alert('Search button pressed')
    }
  },
  {
    image: require('./assets/moreLogo.png'),
    onClick: () => {
      alert('More button pressed')
    }
  },
  {
    image: require('./assets/downloadLogo.png'),
    onClick: () => {
      alert('Download button pressed')
    }
  },
];


const CircleMenuView = () => {
  return (
    <CircleMenu
      menuItems={menuItems}
      openMenuButton={openMenuButton}
      closeMenuButton={closeMenuButton}
    />
  )
}

```

## Props

| Name | Description | Type | Required |
| :--- | :----- | :--- | :---: |
| menuItems | Array of menu items | Array | YES | 
| openMenuButton | Object for open menu button | Object | YES | 
| closeMenuButton | Object for close menu button | Object | YES | 

### menuItems

| Name | Description | Type | Required |
| :--- | :----- | :--- | :---: |
| image | The icon of the item | Image | YES | 
| onClick | The function that called when pressed on menu item | Function | YES | 
| style | Style object to override style | Object | NO | 

### openMenuButton & closeMenuButton

| Name | Description | Type | Required |
| :--- | :----- | :--- | :---: |
| image | The icon of the item | Image | YES | 
| style | Style object to override style | Object | NO |

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