evwt/docs/EvIcon.md

Electron Vue Window Toolkit

# EvIcon

A library for all your vector icons, out of the box.

?> 🎨 Icon SVG is inlined into the HTML so it can be styled with CSS.

## Usage

1) Put your svg icons into `/src/assets/icons`.
2) Assuming you have a file named `folder-open.svg` in that folder:

```vue
<template>
  <ev-icon name="folder-open" />
</template>

<style>
.ev-icon-folder-open svg {
  fill: gray;
  height: 32px;
  width: auto;
}
</style>
```

> For icons in toolbars, simply pass the name of an icon to the `icon` prop of EvToolbarItem


## Props

<!-- @vuese:EvIcon:props:start -->
|Name|Description|Type|Required|Default|
|---|---|---|---|---|
|name|The filename of the icon without the .svg extension|`String`|`true`|-|

<!-- @vuese:EvIcon:props:end -->



## Reference
### Background

<a name="use"></a>

#### use(config)
**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| config | <code>Object</code> | https://github.com/neutrinojs/webpack-chain#config |



### Plugin

<a name="build"></a>

#### build(Vue, requireContext)
Build icon library

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| Vue | <code>\*</code> |  |
| requireContext | <code>function</code> | https://webpack.js.org/api/module-methods/#requirecontext |