\n\n\n\n## Features\n\n- Over 1250 pixel-perfect icons\n- TypeScript definitions\n- Vue 3 support\n- Vue 2 support (see v1.x)\n- All icons are compiled to JS, no preprocessing required\n\n## Installation\n\n### Installation for Vue 3\n\n```bash\nyarn add vue-tabler-icons\n\n# or\n\nnpm i vue-tabler-icons\n```\n\n### Installation for Vue 2\n\nVersion 2.x is Vue 3 only, if you use Vue 2 then install any 1.x version\n\n```bash\nyarn add vue-tabler-icons@^1.0\n```\n\nv1.x is no longer a priority so updates may be delayed or discontinued.\n\n## Usage\n\n```html\n\n\n\n \n\n```\n\n### Using Vue plugin\n\nYou may install a Vue plugin that automatically adds all components to the Vue instance.\n\n_Note: this usage is not recommended as it cannot be tree-shaken._\n\n```js\nimport Vue from \"vue\";\nimport VueTablerIcons from \"vue-tabler-icons\";\n\nVue.use(VueTablerIcons);\n```\n\nNow you can use icons without importing them:\n\n```html\n\n \n\n```\n\n### Using CDN\n\nIf you prefer CDN, then use this URL `https://unpkg.com/vue-tabler-icons/dist/vue-tabler-icons.umd.js` \nThe library doesn't automatically registers itself so you need to do it manually:\n\n```html\n\n```\n\n## Naming pattern\n\nComponent names use the same names as defined in the original library with some rules applied:\n\n- they are in PascalCase\n- underscores before numbers are removed\n- `Icon` added to the end of the name\n\nFor example:\n\n`arrows-diagonal-2` will become `ArrowsDiagonal2Icon`.\n\n### Replacements\n\nFollowing icon names are replaced to match JavaScript variable name pattern:\n\n| Original | New |\n|------------------------|--------------------------|\n| 2fa.svg | TwoFactorAuthIcon |\n| 3d-cube-sphere.svg | ThreedCubeSphereIcon |\n| 3d-cube-sphere-off.svg | ThreedCubeSphereIconOff |\n| 3d-rotate.svg | ThreedRotateIcon |\n| 123.svg | OneTwoThreeRotateIcon |\n| 360-view.svg | Deg360ViewIcon |\n| 360.svg | Deg360Icon |\n\n## Icon size\n\nAll components define `size` property that you can use to control the icon's size:\n\n```html\n\n```\n\nWill render 48x48 icon.\n\nAll other attributes are directly bound to the underlying SVG image.\n\n\n\nAttributes `height` and `width` have higher precedence over `size` property.\n\n## Icon color\n\nAll icons use `currentColor` as their color. You can colorize your icons as you do that for text.\n\n```html\n\n```\n\n## Stroke width and other SVG attributes\n\nAny custom attribute that set on the component will be applied directly to the SVG asset.\nFor example, if you want to set `stroke-width` attribute just set it as usually:\n\n```html\n\n```\n\n## Building locally\n\nClone repo:\n\n```bash\ngit clone https://github.com/alex-oleshkevich/vue-feather-icons.git\n```\n\nInstall deps:\n\n```bash\nyarn install\n```\n\nRun build\n\n```bash\nyarn build\n```\n\nIcon component will be in `icons` directory.\n\n## Credits\n\n- [Tabler Icons](https://tabler-icons.io/) for icon pack\n","readmeFilename":"README.md"}