mirror_html/tabler-icons
1
0
Fork 0
mirror of https://github.com/tabler/tabler-icons.git synced 2025-09-02 18:33:18 +02:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Paweł Kuna
2023-01-27 00:15:50 +01:00
committed by GitHub
parent de7e9b4eb8
commit d877fc422e
1 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@@ -97,10 +97,10 @@ Add an icon to be displayed on your page with the following markup (`activity` i
### React ### React
Import the icon and render it in your component. You can adjust SVG properties through React props: React components available through [`@tabler/icons-react`](https://www.npmjs.com/package/@tabler/icons-react) package.
```jsx ```jsx
import { IconAward } from '@tabler/icons'; import { IconAward } from '@tabler/icons-react';
const MyComponent = () => { const MyComponent = () => {
return <IconAward return <IconAward
@@ -112,7 +112,31 @@ const MyComponent = () => {
} }
``` ```
`@tabler/icons` exports it's own type declarations for usage with React and Typescript. `@tabler/icons-react` exports it's own type declarations for usage with React and Typescript.
For more details, see the [documentation](https://github.com/tabler/tabler-icons/tree/master/packages/icons-react).
### Vue
Vue components available through [`@tabler/icons-vue`](https://www.npmjs.com/package/@tabler/icons-vue) package.
```vue
<template>
<IconHome />
</template>
<script>
// Returns Vue component
import { IconHome } from '@tabler/icons-vue';
export default {
components: { IconHome }
};
</script>
```
For more details, see the [documentation](https://github.com/tabler/tabler-icons/tree/master/packages/icons-vue).
### Angular ### Angular
@@ -155,31 +179,7 @@ After importing the _IconsModule_ in your feature or shared module, use the icon
For more usage documentation refer to [the official documentation](https://github.com/pierreavn/angular-tabler-icons). For more usage documentation refer to [the official documentation](https://github.com/pierreavn/angular-tabler-icons).
### Vue ## CDN
Vue components available through [`vue-tabler-icons`](https://www.npmjs.com/package/vue-tabler-icons) package.
Install the package, import the icon component and render it in your component. You can adjust SVG properties by passing regular HTML attributes:
```html
<script>
// MyComponent.vue
import { BoldIcon } from 'vue-tabler-icons';
export default {
components: { BoldIcon },
};
</script>
<template>
<bold-icon />
</template>
```
`vue-tabler-icons` exports it's own type declarations for usage with Typescript.
For more usage documentation refer to [the official documentation](https://github.com/alex-oleshkevich/vue-tabler-icons).
### CDN
All files included in `@tabler/icons` npm package are available over a CDN. All files included in `@tabler/icons` npm package are available over a CDN.