https://github.com/simshaun/mdi-vue

This library generates Vue 3 components for Google's Material Design icons library.
https://github.com/simshaun/mdi-vue

materialdesignicons mdi vue vue3

Last synced: about 1 month ago
JSON representation

This library generates Vue 3 components for Google's Material Design icons library.

• Host: GitHub
• URL: https://github.com/simshaun/mdi-vue
• Owner: simshaun
• License: other
• Created: 2021-05-01T03:24:41.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-16T19:30:31.000Z (3 months ago)
• Last Synced: 2024-10-05T14:47:13.396Z (about 1 month ago)
• Topics: materialdesignicons, mdi, vue, vue3
• Language: JavaScript
• Homepage:
• Size: 55.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Material Design Icons

[![npm](https://img.shields.io/npm/v/@libshaun/mdi-vue)](https://www.npmjs.com/package/@libshaun/mdi-vue)

This library generates Vue 3 components for Google's Material Design icons library.

https://github.com/google/material-design-icons

## Usage

1. Install the package.

   ```console

   npm i @libshaun/mdi-vue

   ```

2. Import an icon component.

   * Option 1:

   ```javascript

   import Map from '@libshaun/mdi-vue/Map';

   ```

   * Option 2:

   ```javascript

   import { Map } from '@libshaun/mdi-vue';

   ```

   > Option 1 is safer to use, but Option 2 is a bit cleaner. Make sure you utilize

     tree shaking if using the second approach or you will end up with a multi-MB bundle.

3. Then use it somewhere. e.g.

   ```html

   

    

      

      Map

    

   

   

   import { Map } from '@libshaun/mdi-vue';

   import { defineComponent } from 'vue'

   export default defineComponent({

     components: {

       Map,

     },

   })

   

   ```

## How to generate icons

1. Fork and/or clone this repo.

2. Install dependencies.

   ```console

   npm install

   ```

3. Run the generator script.

   ```console

   npm run generate

   ```

## Maintenance

Simply push a new tag and the GitHub Action will generate the components and release on NPM.