Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2nthony/vue-remix-icons
(Vue 2 & 3)Remix Icon is a set of open source neutral style system symbols elaborately crafted for designers and developers.
https://github.com/2nthony/vue-remix-icons
icon icon-font icon-pack remix remixicon remixicons svg vue vue3
Last synced: about 2 months ago
JSON representation
(Vue 2 & 3)Remix Icon is a set of open source neutral style system symbols elaborately crafted for designers and developers.
- Host: GitHub
- URL: https://github.com/2nthony/vue-remix-icons
- Owner: 2nthony
- License: apache-2.0
- Created: 2020-12-09T07:05:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T00:17:09.000Z (2 months ago)
- Last Synced: 2024-10-26T00:24:06.501Z (about 2 months ago)
- Topics: icon, icon-font, icon-pack, remix, remixicon, remixicons, svg, vue, vue3
- Language: TypeScript
- Homepage: http://remixicon.com/
- Size: 287 KB
- Stars: 15
- Watchers: 2
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Attention
remixicon now support Vue 3 officially, this package will continue sync upstream for Vue 2 users, but if you use Vue 3, better use official package!
---
# vue-remix-icons
[](https://npm.im/vue-remix-icons)
[](https://npm.im/vue-remix-icons)
Remix Icon is a set of open source neutral style system symbols elaborately crafted for designers and developers.
**Notics**: this package will auto release a new feature version when then upstream package([remixicon](https://github.com/Remix-Design/remixicon)) released, if you facing any issues, please open an issue to let me know.
## Features
- [x] Types ready
- [x] Support Vue 2 and Vue 3
- [x] Tree-Shaking
## Install
```bash
npm i vue-remix-icons
```
## Usage
Notice: for support Vue 2 & Vue 3 projects, the all imported icons is a Vue file, so you need to use this lib under the JS bundler like vite, webpack or other Vue framework.
```html
// tree-shaking
import { RiHomeLine } from "vue-remix-icons";
// if not, import the one you needed
import RiHomeLine from "vue-remix-icons/icons/ri-home-line.vue"
export default {
components: {
RiHomeLine,
},
}
```
See all icons here: http://remixicon.com/
Note that just change the usage from `` to import `RiHomeLine` .
### Nuxt 3
Transpile vue-remix-icons, see [#13](https://github.com/2nthony/vue-remix-icons/issues/13).
```ts
// https://v3.nuxtjs.org/api/configuration/nuxt.config
export default defineNuxtConfig({
build: {
transpile: ['vue-remix-icons'],
},
})
```
## Details
```html
```
Will render as:
```html
...
```
## Breaking Changes
### `v3.0.0`
Generated file now kebab-case, reason see [#10](https://github.com/2nthony/vue-remix-icons/issues/10).
```diff
- import RiHomeLine from "vue-remix-icons/icons/RiHomeLine.vue"
+ import RiHomeLine from "vue-remix-icons/icons/ri-home-line.vue"
```
## Credits
- [remixicon](https://github.com/Remix-Design/remixicon)
## Sponsors
[](https://github.com/sponsors/2nthony)
## License
Apache-2.0 © [2nthony](https://github.com/sponsors/2nthony)