Skip to content

React Native: It offers information about install packages

License

Notifications You must be signed in to change notification settings

prscX/react-native-about-libraries

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

34 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

PRs Welcome

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. We would like to credit this library to all the 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

import { AboutLibraries } from 'react-native-about-libraries'

<AboutLibraries about={about} libraries={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. 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

πŸ’– 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 on GitHub.

    Buy Me A Coffee

    Thanks! ❀️
    prscX.github.io
    </ Pranav >