Vue Material Design Icon Components
@robcresswell and the link is here
This is an extension of the original library made byHit me up with a PR
I copied it to adapt it to my personal needs, if you want to provide support to make it better I'm open to collaborate.This library is a collection of Vue single-file components to render Material Design Icons, sourced from the MaterialDesign project. It also includes some CSS that helps make the scaling of the icons a little easier.
Getting started
-
Install the package
yarn add paw-vue-iconsOR
npm i paw-vue-icons -
Import the icon, and declare it as a local component:
;components:MenuIcon;OR
Declare it as a global component:
;Vue;Note Icon files are pascal cased, e.g.
CheckboxMarkedCircle.vue
, and their default name hasIcon
appended e.g.CheckboxMarkedCircleIcon
. -
Then use it in your template code!
-
Optional Add the included stylesheet. This few lines of CSS will cause the icons to scale with any surrounding text, which can be helpful when you primarily style with CSS. Note that if you intend to handle sizing with the
size
prop, you probably don't want to use this as it may conflict.;
Props
-
title
- This changes the hover tooltip as well as the title shown to screen readers. By default, those values are a "human readable" conversion of the icon names; for examplechevron-down-icon
becomes "Chevron down icon".Example:
-
decorative
- This denotes whether an icon is purely decorative, or has some meaninfgul value. If an icon is decorative, it will be hidden from screen readers. By default, this isfalse
.Example:
-
fillColor
- This property allows you to set the fill colour of an icon via JS instead of requiring CSS changes. Note that any CSS values, such asfill: currentColor;
provided by the optional CSS file, may override colours set with this prop.Example:
-
size
- This property overrides thewidth
andheight
attributes on the SVG. The default is24
.Example:
Icons
A list of the icons can be found at the
Material Design Icons website. The icons packaged here are pascal cased
versions of the names displayed on the website, to match the
Vue Style Guide. For example, the icon
named ultra-high-definition
would be imported as
"paw-vue-icons/UltraHighDefinition.vue"
.
Tips
-
Use
resolve
in your Webpack config to clean up the imports:resolve:alias :"icons": pathextensions:".vue"This will give you much shorter and more readable imports, like
import Android from "icons/Android"
, rather thanimport Android from "paw-vue-icons/Android.vue"
. Much better! -
If you want custom sizing, add your own css to adjust the height and width of the icons
Then add your size class
While I recommend using CSS for styling, you can also pass in a
size
prop, detailed in theProps
section above.