Bootstrap Icons meets Nuxt

This is an integration to implement bootstrap-icons in your Nuxt project.

  • Nuxt 3 ready.
  • Typescript support.
  • An importable list of all the icons in bootstrap-icons.

Setup

Run the following command to add the module to your project:

bash>_

$ npx nuxi@latest module add nuxt-bootstrap-icons

Congratulations 🎉, you have successfully added the module to your project and can now browser bootstrap-icons for use in your project

Usage

This module registers a component BootstrapIcon by default which can then be used in your project as shown below:

vueYourComponent

<BootstrapIcon name="alarm-fill" />

Configuration

You can configure this module using the bootstrapIcons key in the nuxt.config

Select a key from the options below to see details specific to such key

tsnuxt.config

export default defineNuxtConfig({
  bootstrapIcons: {
    prefix: "bi",
  },
})

Default value: bootstrap-icon

This key allows you to set the prefix for the component registered by the module.