Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
codecalm committed Jan 26, 2023
2 parents 41e6a76 + d877fc4 commit 2aae43e
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 30 deletions.
56 changes: 28 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion packages/icons-react/build.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down
2 changes: 1 addition & 1 deletion packages/icons-vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

1 comment on commit 2aae43e

@vercel
Copy link

@vercel vercel bot commented on 2aae43e Jan 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

tabler-icons – ./

tabler-icons.vercel.app
tabler-icons-tabler-io.vercel.app
tabler-icons-git-master-tabler-io.vercel.app

Please sign in to comment.