eos-icons-Vue 3
Using eos-icons-react in your projects
Refer to EOS Icons for more details about all the icons that are supported by EOS-Icons Vue 3
Storybook EOS-Icons, checkout storybook for an in-depth look at the various different icons that are provided by EOS-Icons Vue 3 as well the props available for configuring icons.
Installation
# yarn
yarn add eos-icons-vue3
# npm
npm install eos-icons-vue3
Usage
common icons usage
<template>
<div>
<EOS_10K_FILLED />
<EOS_10K_OUTLINED />
<EOS_LOADING_ANIMATED />
</div>
</template>
<script>
import { EOS_10K_FILLED, EOS_10K_OUTLINED, EOS_LOADING_ANIMATED } from "eos-icons-vue3";
export default {
name: "App",
components: {
EOS_10K_FILLED,
EOS_10K_OUTLINED,
EOS_LOADING_ANIMATED
},
};
</script>Props
Prop usage
<template>
<div>
<EOS_10K_FILLED size="xl" color="cyan" rotate="120" verticalFlip="true" horizontalFlip="true"/>
</div>
</template>
<script>
import { EOS_10K_FILLED } from "eos-icons-vue3";
export default {
name: "App",
components: {
EOS_10K_FILLED
},
};
</script>Prop Details
| Name | Type | Default | Description |
|---|---|---|---|
| size | string, number | 'm' | sets the size of icon * |
| color | string | black | sets the color of icon |
| rotate | string, number | 0 | sets the rotation degree of icon |
| horizontalFlip | boolean | false | Flips icon horizontally |
| verticalFlip | boolean | false | Flips icon vertically |
| theme | string | 'filled' | sets icon theme (only available for common components)** |
(*) Size can be provided using either string or number. Pre-Defined size list
| Size Name | Size Value |
|---|---|
| xs | 4 |
| s | 8 |
| base | 14 |
| m | 18 |
| l | 24 |
| xl | 32 |
| xxl | 48 |
| xxxl | 64 |
(**) The theme prop is only available for common icon component. Eos-Icons React has 4 different types of icon components (common / filled / outlined / animated). The common icon component contains both filled and outlined version of the icon. For switching between the two types of version you can either supply 'outlined' or 'filled' to the theme prop.
Development of EOS icons React
- Cloning the repo:
git clone https://github.com/EOS-uiux-Solutions/eos-icons-vue
- run for installing all the required dependencies.
npm install
Package build command
- run for producing the final build files.
npm run generate
Testing
Follow the above steps before running the test command. The test sequence requires the presence of the final build files in order to test them.
- run to start the testing of the final build files using Jest.
npm run test
Build process
Learn more about the EOS Design System
Our "thank you" section
Tested for every browser in every device
Thanks to Browserstack and their continuous contribution to open source projects, we continuously test the EOS to make sure all our features and components work perfectly fine in all browsers. Browserstack helps us make sure our Design System also delivers a peace of mind to all developers and designers making use of our components and layout in their products.