https://github.com/walidoux/react-ios-icons
🐢 A React Component Library of iOS icons with high-level props & types.
https://github.com/walidoux/react-ios-icons
Last synced: 12 months ago
JSON representation
🐢 A React Component Library of iOS icons with high-level props & types.
- Host: GitHub
- URL: https://github.com/walidoux/react-ios-icons
- Owner: Walidoux
- License: mit
- Created: 2023-08-23T13:04:51.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-08-29T11:59:56.000Z (almost 3 years ago)
- Last Synced: 2025-04-07T13:21:09.631Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 288 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🐢 Getting started
## Table of Content
- [Setup](#setup)
- [Contributing](#contributing)
- [Where do I start?](#where-do-i-start)
- [Code Of Conduct](./CODE_OF_CONDUCT.md)
## Setup
### Install the dependency
Depdending on your package manager, here are two examples:
> NPM : `npm install react-ios-icons` \
> YARN : `yarn add react-ios-icons`
### Import an icon
#### Example 1
```tsx
import { Battery } from 'react-ios-icons'
// Renders the one-fifth of battery's capacity
export const DummyComponent: React.FC = () => {
return
}
```
#### Example 2
```tsx
import {} from 'react-ios-icons'
```
## Contributing
If you would like to contribute and improve our project, we've set certain rules to maintain a better scoial and development environment, almost everything is mentioned in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
### Where do I start?
In order to create an icon, you need to generate one by executing:
> NPM : `npm run generate ` \
> YARN : `yarn generate `
2 questions will be asked to you which helps giving instructions that will be provide a start code for your icon.