Skip to content

boindil/bootstrap-vue-next-icons

Repository files navigation

BootstrapVue 3 icons

Implementation of Vue 3, BootstrapIcons and Typescript


Current version Vue.js version Build status
npm downloads npm weekly downloads

Why BootstrapVueNextIcons?

BootstrapVueNextIcons is an attempt to have the icons from BootstrapVue components as a drop-in replacement in Vue3 and typescript. The original work of BootstrapVueNext was used as a starting point, since a lot of work was done here already.

This library is heavily inspired by BootstrapVue and BootstrapVueNext. Originally the plan was to integrate this into the original project, but that has been abandoned recently as the decision was made to use UnpluginIcon instead.

Install

# NPM
npm i --save bootstrap-icons @boindil/bootstrap-vue-next-icons

# Yarn
yarn add bootstrap-icons @boindil/bootstrap-vue-next-icons

# PNPM
pnpm add bootstrap-icons @boindil/bootstrap-vue-next-icons

Usage

The recommended usage method is to use the provided resolver, which results in automatic treeshaking without any hassle.

// vite.config.js/ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import Components from 'unplugin-vue-components/vite'
import { BootstrapVueNextIconsResolver } from '@boindil/bootstrap-vue-next-icons'

export default defineConfig({
  plugins: [
    vue(),
    Components({
      resolvers: [BootstrapVueNextIconsResolver()]
    })
  ]
})

Contribute 🙌

If you want to contribute you can:

Read our Contribution Guide on how to start helping

License

Released under the MIT Licence. Copyright (c) BootstrapVueNextIcons.