Giter VIP home page Giter VIP logo

eos-icons-vue's Introduction

eos-icons-Vue 3

Open Source Love svg2 NPM Package NPM Downloads

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

Untitled-2021-07-18-1339

Learn more about the EOS UX/UI Solutions

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.

eos-icons-vue's People

Contributors

cyntss avatar dependabot[bot] avatar kaybhutani avatar semantic-release-bot avatar vinayaksh42 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

vinayaksh42

eos-icons-vue's Issues

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.