mirror of
https://github.com/MioMioOS/MioIsland
synced 2026-05-05 06:18:19 +00:00
5deeaffc8a
Replace with native .bundle plugin architecture in next commits. Old declarative system (themes/buddy/sound JSON) removed entirely. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
88 lines
2.6 KiB
Markdown
88 lines
2.6 KiB
Markdown
# Tabler Icons for React
|
|
|
|
<p align="center">
|
|
<a href="https://tabler.io/icons?ref=tabler-icons-readme"><img src="https://raw.githubusercontent.com/tabler/tabler-icons/main/.github/packages/og-package-react.png" alt="Tabler Icons" width="838"></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
Implementation of the Tabler Icons library for React applications.
|
|
<p>
|
|
|
|
<p align="center">
|
|
<a href="https://tabler.io/icons"><strong>Browse all icons at tabler.io →</strong></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/tabler/tabler-icons/releases"><img src="https://img.shields.io/npm/v/@tabler/icons" alt="Latest Release"></a>
|
|
<a href="https://github.com/tabler/tabler-icons/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/@tabler/icons.svg" alt="License"></a>
|
|
</p>
|
|
|
|
## Sponsors
|
|
|
|
**If you want to support my project and help me grow it, you can [become a sponsor on GitHub](https://github.com/sponsors/codecalm) or just [donate on PayPal](https://paypal.me/codecalm) :)**
|
|
|
|
<a href="https://github.com/sponsors/codecalm">
|
|
<img src="https://cdn.jsdelivr.net/gh/tabler/sponsors@latest/sponsors.svg" alt="Tabler sponsors">
|
|
</a>
|
|
|
|
## Installation
|
|
|
|
```
|
|
yarn add @tabler/icons-react
|
|
```
|
|
|
|
or
|
|
|
|
```
|
|
npm install @tabler/icons-react
|
|
```
|
|
|
|
or
|
|
|
|
```
|
|
pnpm install @tabler/icons-react
|
|
```
|
|
|
|
or just [download from Github](https://github.com/tabler/tabler-icons/releases).
|
|
|
|
## How to use
|
|
|
|
It's build with ESmodules so it's completely tree-shakable. Each icon can be imported as a component.
|
|
|
|
```js
|
|
import { IconArrowLeft } from '@tabler/icons-react';
|
|
|
|
const App = () => {
|
|
return <IconArrowLeft />;
|
|
};
|
|
|
|
export default App;
|
|
```
|
|
|
|
You can pass additional props to adjust the icon.
|
|
|
|
```js
|
|
<IconArrowLeft color="red" size={48} />
|
|
```
|
|
|
|
### Props
|
|
|
|
| name | type | default |
|
|
| ------------- | -------- | ------------ |
|
|
| `size` | _Number_ | 24 |
|
|
| `color` | _String_ | currentColor |
|
|
| `stroke` | _Number_ | 2 |
|
|
|
|
## Contributing
|
|
|
|
For more info on how to contribute please see the [contribution guidelines](https://github.com/tabler/tabler-icons/blob/main/CONTRIBUTING.md).
|
|
|
|
Caught a mistake or want to contribute to the documentation? [Edit this page on Github](https://github.com/tabler/tabler-icons/blob/main/packages/icons-react/README.md)
|
|
|
|
## License
|
|
|
|
Tabler Icons is licensed under the [MIT License](https://github.com/tabler/tabler-icons/blob/master/LICENSE).
|
|
|
|
## Sponsor Tabler
|
|
|
|
<a href="https://github.com/sponsors/codecalm" target="_blank"><img src="https://github.com/tabler/tabler/raw/dev/src/static/sponsor-banner-readme.png?raw=true" alt="Sponsor Tabler" /></a>
|