mirror
/
tabler-icons
mirror of https://github.com/tabler/tabler-icons.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/master'

This commit is contained in:
codecalm 2023-01-27 00:17:57 +01:00
parent 41e6a769c7 d877fc422e
commit 2aae43e6bc
3 changed files with 30 additions and 30 deletions
Show Stats 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
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
import { IconAward } from '@tabler/icons';
import { IconAward } from '@tabler/icons-react';
const MyComponent = () => {
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
@ -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).
### Vue
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
## CDN
All files included in `@tabler/icons` npm package are available over a CDN.

2
packages/icons-react/build.mjs
View File

@ -21,7 +21,7 @@ import { SVGAttributes } from 'react'
declare module '@tabler/icons-react'
// Create interface extending SVGProps
export interface TablerIconsProps extends Partial<React.SVGProps<SVGSVGElement>> {
export interface TablerIconsProps extends Partial<Omit<React.SVGProps<SVGSVGElement>, 'stroke'>> {
size?: string | number,
stroke?: string | number
}

2
packages/icons-vue/README.md
View File

@ -47,7 +47,7 @@ or just [download from Github](https://github.com/tabler/tabler-icons/releases).
## How to use
All icons are Svelte components that contain SVG elements. So any icon can be imported and used as a component. It also helps to use threeshaking, so you only import the icons you use.
All icons are Vue components that contain SVG elements. So any icon can be imported and used as a component. It also helps to use threeshaking, so you only import the icons you use.
```vue