Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/prscX/react-native-iconic

React Native - Native Animated Icons with different states
https://github.com/prscX/react-native-iconic

android ios react-native

Last synced: 28 days ago
JSON representation

React Native - Native Animated Icons with different states

Lists

README 

        







  






  

  PRs Welcome

  




    ReactNative: Native Iconic (Android/iOS): Deprecated



Due to time constraint, this library is deprecated and not maintained anymore, You can still use this library.



If this project has helped you out, please support us with a star 🌟



React Native Bridge for below native libraries:



| **[iOS: VBFPopFlatButton](https://github.com/victorBaro/VBFPopFlatButton)**             |

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

| Flat button with 21 different states and 2 types animated using pop. |



| **Android: [Android: balysv/material-menu](https://github.com/balysv/material-menu)**             |

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

|                   |



> Morphing Android menu, back, dismiss and check buttons



| **Android: [Android: zagum/Android-ExpandIcon](https://github.com/zagum/Android-ExpandIcon)**             |

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

|                   |



## 📖 Getting started



`$ npm install react-native-iconic --save`



`$ react-native link react-native-iconic`



- **Android**



Please add below snippet into your app build.gradle:



```javascript

buildscript {

    repositories {

        jcenter()

        maven { url "https://maven.google.com" }

        maven { url "https://jitpack.io" }

        ...

    }

}



allprojects {

    repositories {

        mavenLocal()

        jcenter()

        maven { url "https://maven.google.com" }

        maven { url "https://jitpack.io" }

        ...

    }

}

```



- **iOS**



  - After `react-native link react-native-iconic`, please verify `node_modules/react-native-iconic/ios/` contains `Pods` folder. If does not exist please execute `pod install` command on `node_modules/react-native-iconic/ios/`, if any error => try `pod repo update` then `pod install`



## 💻 Usage



```javascript

import RNIconic from 'react-native-iconic';



// TODO: What to do with the module?



```



## Shapes



**iOS**

- `Add, Minus, Close, Back, Forward, Menu, Download, Share, DownBasic, UpBasic, Paused, DownArrow, RightTriangle, LeftTriangle, UpTriangle, DownTriangle, Ok, Rewind, FastForward, Square`



**Android**

- `BURGER, ARROW, X, CHECK`

- `DownBasic, UpBasic`



## 💡 Props



  - **Generic**



| Prop              | Type       | Default | Note                                                                                                       |

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

| `shape`       | `array`     |         | Array of shape sequence

| `selection`      | `int`     |         | Default position of shape

| `color`       | `string`     |         | Specify icon color                                                            |

| `size` | `int` |         | Size of Icon                                                   |  |

| `disabled`    | `bool`     |         | Disabling the Icon Button                                        |  |

| `onChange`      | `func`     |         | It is invoke when the value of button is change

| `tintColor`           | `array`     |         | Color of background circle |



  - **iOS**



| Prop              | Type       | Default | Note                                                                                                       |

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

| `lineThickness`     | `string` |         | Thickness of icon line                                                      |

| `rounded`           | `bool`     |         | For having circle in background |



## ✨ Credits



- iOS Lib: [VBFPopFlatButton](https://github.com/victorBaro/VBFPopFlatButton) for iOS implement

- Android Lib: [balysv/material-menu](https://github.com/balysv/material-menu) for Android implement

- Android Lib: [zagum/Android-ExpandIcon](https://github.com/zagum/Android-ExpandIcon)



## 🤔 How to contribute

Have an idea? Found a bug? Please raise to [ISSUES](https://github.com/prscX/react-native-iconic/issues).

Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.



## 💫 Where is this library used?

If you are using this library in one of your projects, add it in this list below. ✨



## 📜 License

This library is provided under the Apache License.



RNIconic @ [prscX](https://github.com/prscX)



## 💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).



However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

* Starring and sharing the projects you like 🚀

* If you're feeling especially charitable, please follow [prscX](https://github.com/prscX) on GitHub.



  Buy Me A Coffee



  Thanks! ❤️

  


  [prscX.github.io](https://prscx.github.io)

  


   Pranav >