Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@react-pakistan/react-native-icon-collection

react-pakistan148MIT2.5.11TypeScript support: included

React Native Icons Collection built upon React Native StoryBook

blockchain color, blockchain grey, brands grey, business color, business grey, food dishes color, fourthofjuly grey, green energy color, helmet grey, home color, home grey, kitchen color, kitchen grey, knife color, knife grey, law color, law grey, leaf color, leaf grey, logistics color, logistics grey, lumberjack color, lumberjack grey, medical grey, misc grey, mobile ui grey, music color, music grey, office color, office grey, security color, security grey, shopping color, shopping grey, skull color, skull grey, social grey, space color, space grey, spring color, spring grey, sweet 17 color, sweet 17 grey, time color, time grey, travel color, travel grey, valentine color, valentine grey, virtual reality color, virtual reality grey, zoo color, zoo grey

readme

📌 React Pakistan 🔥🔥🔥

React Pakistan is an OpenSource & Free Software (FOSS) platform, creating React software solutions for the global community. ⭐⭐⭐

License Followers Forks Stars

Maintenance Maintaner Website shields.io Ask Me Anything !

Ryo-ma's github trophy

DenverCoder1's github streak

Sparkline

saythanks

📌 React Native Icon Collection ✌

A generic, Icon library for React Native apps, following modern approach by building your project's UI in isolation using state of the art Storybook along with React.

📌 Table of Contents 🚀

📌 Technology Stack 🚀

📌 Installation 🚀

  • You should have React Native environment setup, prior proceeding with the following steps, if you don't please refer to React Native Getting Started docs to setup that.
  • Clone the repo
  • Cd into the project folder
  • Figure out which package manager you have on your system, then run following commands for their specific use cases.
    // to install dependencies
yarn
// to build and run app on ios Simulator
yarn ios
// to build and run app on android Simulator
yarn android
// to run all tests locally
yarn test
    OR
    // to install dependencies
npm install
// to build and run app on ios Simulator
npm run ios
// to build and run app on android Simulator
npm run android
// to run all tests locally
npm test

📌 Usage 🚀

Add React Native Icon Collection to your project. 

  yarn add @react-pakistan/react-native-icon-collection

OR

  npm install @react-pakistan/react-native-icon-collection

Add React Native Icon Collection base theme to your project.

  yarn add @react-pakistan/util-react-native-functions

OR

  npm install @react-pakistan/util-react-native-functions

Refer to React Pakistan Docs for detail usage docs.

📌 Styles 🚀

Styled Components are employed to maintain and update theme for this project. Please consider adding Styled Component Provider wrapper to the entry point of your application, following is the sample code. You could either use the default theme as shown below or wire your custom theme object instead.

  import { ThemeProvider } from 'styled-components';
  import { theme } from '@react-pakistan/util-functions';

  <ThemeProvider theme={theme}>
    <App />
  </ThemeProvider>

📌 Tested 🚀

Since we wrote a script that generates all the logos on the fly, we don't feel the need to test all 1000's of React SVG components.

Should you like this project and would like to see more coming in future, please consider giving a ⭐ on Github project repo.

📌 Contributors 🚀

Thanks goes to these wonderful people (emoji key):

Contributors GitHub Emoji
Taimoor Khan 🎨🤔🚧📆👀⚠️

📌 Other Libraries from ReactPakistan 🚀

📌 Support 🚀

If you need any help or have any question, please feel free to join ReactPakistan community at React Pakistan Slack.

📌 Contact 🚀

I can be reachable via Taimoor Web or else should you wish to send over an expression of your interest to contribute towards ReactPakistan, please shoot an email.

📌 Buy me Coffee 🚀

Buy Me A Coffee