erpedersen / nuxt-mdi

Add 7,000+ icons to your Nuxt project, from Material Design Icons

Nuxt mdi

Add 7,000+ icons to your Nuxt project, from Material Design Icons.

• ✨ Release Notes
• 🏀 Online playground
• 📖  Documentation

Features

• Add 7,000+ icons, from Material Design Icons.
• TypeScript completion.
• Zero imports needed.

Getting Started

Installation

Install the nuxt-mdi dependency to your project using your preferred package manager:

pnpm add -D nuxt-mdi

yarn add --dev nuxt-mdi

npm install --save-dev nuxt-mdi

Activation

Add 'nuxt-mdi' to the modules section of your nuxt.config.ts file.

export default defineNuxtConfig({
  modules: [
    'nuxt-mdi'
  ]
})

That's it! You can now use nuxt-mdi in your Nuxt app ✨

Usage

The module will automatically make the MdiIcon component available to your app. You can use it like this:

<MdiIcon icon="mdiAccount" />

Props:

• icon (required): The name of the icon to display.
• flipX (optional): Flip the icon on the X axis.
• flipY (optional): Flip the icon on the Y axis.

Configuration

You can configure this module by adding an mdi section to the nuxt.config.ts file.

export default defineNuxtConfig({
  // ...
  mdi: {
    cache: false,
    componentName: 'MdiIcon',
    defaultSize: '1em'
  }
})

Cache: cache

Once an icon is loaded, it is automatically cached in localStorage. This means that the icon will be loaded from localStorage instead of the network on subsequent requests. This is enabled by default, but can be disabled by setting cache to false.

Component name: componentName

By default, the component name is MdiIcon. You can change this by setting the componentName option.

export default defineNuxtConfig({
  // ...
  mdi: {
    componentName: 'MyIcon'
  }
})

<MyIcon icon="mdiAccount" />

Default size: defaultSize

By default, the icons will be rendered at 1em. You can change this by setting the defaultSize option.

Icons

You can find available icons on the Material Design Icons website. IntelliSense will automatically display auto completion for the available icons.

If you are using VS Code, you can use the Vue Language Features (Volar) extension to get IntelliSense for Vue components.

nuxt-mdi's Issues

When SSR is enabled in nuxt the icons have weird styling and adds extra padding or margin

Hi,
I have project where I use nuxt 3.8.2 along with tailwindcss 3.4.1
When I set ssr to false in nuxt.config.ts the icons have weird behavior. Extra spacing or padding is added making my navigation look unprofessional. When I set ssr to true then everything works as expected. I thought I was messing with my styling or so, but when I commented out my icons, then styling went back to normal.

See the picture below with ssr: false (unexpected behavior)

When I enable ssr: (expected behavior)

My nuxt.config.ts file:

export default defineNuxtConfig({
  //@ts-ignore
  devtools: { enabled: true },
  srcDir: 'src/',
  ssr: false,
  css: ['./assets/css/main.css'],
  modules: ['@pinia/nuxt', 'nuxt-mdi', ['@nuxtjs/i18n', {
    detectBrowserLanguage: {
      useCookie: true,
      cookieKey: 'i18n_redirected'
    },
    locales: availableLocales,
    lazy: true,
    langDir: 'translations/',
    defaultLocale: locale
  }]],
  mdi: {
    cache: false,
    componentName: 'MdiIcon',
    defaultSize: '1em'
  },
  pinia: {
    storesDirs: ['./stores/**'],
  },
  postcss: {
    plugins: {
      tailwindcss: {},
      autoprefixer: {},
    },
  }
})

Here is how I use icons in my template (excerpt..)

...
<div class="absolute inset-y-0 left-0 flex items-center pointer-events-none">
      <MdiIcon :icon="subItem.icon" class="text-xl"></MdiIcon>
</div>
...

Size is not working properly

Hi,
I've changed both size in nuxt.config.ts and by icon prop but the size is still not changed.

nuxt: 3.11.1
@nuxtjs/tailwindcss: 6.11.4

Here's my config in nuxt.config.ts

  mdi: {
    cache: false,
    defaultSize: '4.5em',
  },

And here's in my template

<MdiIcon icon="mdiHandHeart" size="72px" />