Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prscX/react-native-about-libraries
React Native: It offers information about install packages
https://github.com/prscX/react-native-about-libraries
android ios react-native
Last synced: 5 days ago
JSON representation
React Native: It offers information about install packages
- Host: GitHub
- URL: https://github.com/prscX/react-native-about-libraries
- Owner: prscX
- License: apache-2.0
- Created: 2018-01-11T14:39:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-21T07:04:20.000Z (over 6 years ago)
- Last Synced: 2024-12-02T03:33:26.567Z (10 days ago)
- Topics: android, ios, react-native
- Language: JavaScript
- Homepage:
- Size: 358 KB
- Stars: 31
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-native - react-native-about-libraries ★26 - React Native: It offers information about install packages (Components / UI)
- awesome-reactnative-ui - react-native-about-libraries - native-about-libraries/master/hero.png)| (Others)
- awesome-react-native - react-native-about-libraries ★26 - React Native: It offers information about install packages (Components / UI)
- awesome-reactnative-ui - react-native-about-libraries - native-about-libraries/master/hero.png)| (Others)
- awesome-react-native - react-native-about-libraries ★26 - React Native: It offers information about install packages (Components / UI)
- awesome-react-native - react-native-about-libraries ★26 - React Native: It offers information about install packages (Components / UI)
README
ReactNative: About Libraries (Android/iOS)
If this project has helped you out, please support us with a star 🌟
The React Native About Libraries package is on a similar concept of [AboutLibraries](https://github.com/mikepenz/AboutLibraries). We would like to credit this library to all the [AboutLibraries](https://github.com/mikepenz/AboutLibraries) contributors
This package allows you to easily create an used open source libraries component within your app. As an extra feature you can also add an about this app section.
Here's a quick overview of functionalities supported:
* Listing of used open source libraries
* Provision for adding app section (optional)
* Autodetect installed packages
* Auto Font Scaling
* Much much more... try the sample for a quick overview.
## 📖 Getting started
`npm install react-native-about-libraries --save`
## 💻 Usage
```javascript
import { AboutLibraries } from 'react-native-about-libraries'
let about = {
avatar: Avatar,
name: 'React Native',
description: 'About Libraries Sample',
version: 'Version 0.0.1'
}
let libraries = [
{
name: 'ReactJS',
description: `React is a JavaScript library for building user interfaces.`,
creator: 'Facebook',
license: 'MIT',
version: '16.0.0',
link: 'https://github.com/facebook/react'
},
{
name: 'React Native',
description: 'Facebook React Native',
creator: 'Facebook',
license: 'MIT',
version: '0.52.0',
link: 'https://github.com/facebook/react-native'
}
]
```
## 💡 Props
| Prop | Type | Default | Note |
| ----------------- | ---------- | ------- | ---------------------------------------------------------------------------------------------------------- |
| `about` | `JSON` | | You can pass app info in order to render the app header. It's props are avatar, name, description, version |
| `libraries` | `JSON` | | List of libraries you are using within your app |
| `renderAbout` | `Function` | | You can provide your own custom about section renderer |
| `renderLibraries` | `Function` | | You can provide your own custom library section renderer | |
| `libraryStyle` | `JSON` | | You can customize library renderer style by pass your custom styles | |
| `aboutStyle` | `JSON` | | You can customize about section renderer by providing about style |
## TODO
* Autodetect installed packages
* Auto Font Scaling
## ✨ Credits
## 🤔 How to contribute
Have an idea? Found a bug? Please raise to [ISSUES](https://github.com/prscX/react-native-about-libraries/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.
RNAboutLibraries @ [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.
Thanks! ❤️
[prscX.github.io](https://prscx.github.io)
Pranav >