-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from EOS-uiux-Solutions/dev
[Vue2 Package] initial commit
- Loading branch information
Showing
30 changed files
with
46,243 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| current node | ||
| last 2 versions and > 2% | ||
| ie > 10 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
|
|
||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: "npm" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "daily" | ||
| reviewers: | ||
| - "vinayaksh42" | ||
| - "EOS-uiux-Solutions/mentors" | ||
| allow: | ||
| - dependency-name: "eos-icons" | ||
| versioning-strategy: increase |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| name: Release | ||
| on: | ||
| push: | ||
| branches: [ main ] | ||
| jobs: | ||
| release: | ||
| name: Release | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository code | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Cache node_modules | ||
| id: cache-node-modules | ||
| uses: actions/cache@v2 | ||
| with: | ||
| path: node_modules | ||
| key: node_modules-deploy-${{ hashFiles('package-lock.json') }} | ||
|
|
||
| - name: Install node modules | ||
| if: steps.cache-node-modules.outputs.cache-hit != 'true' | ||
| run: npm install | ||
|
|
||
| - run: npm run generate | ||
| - run: npx semantic-release | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| NPM_TOKEN: ${{ secrets.NPM_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,104 +1,23 @@ | ||
| # Logs | ||
| logs | ||
| *.log | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
| lerna-debug.log* | ||
|
|
||
| # Diagnostic reports (https://nodejs.org/api/report.html) | ||
| report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json | ||
|
|
||
| # Runtime data | ||
| pids | ||
| *.pid | ||
| *.seed | ||
| *.pid.lock | ||
|
|
||
| # Directory for instrumented libs generated by jscoverage/JSCover | ||
| lib-cov | ||
|
|
||
| # Coverage directory used by tools like istanbul | ||
| coverage | ||
| *.lcov | ||
|
|
||
| # nyc test coverage | ||
| .nyc_output | ||
|
|
||
| # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
| .grunt | ||
|
|
||
| # Bower dependency directory (https://bower.io/) | ||
| bower_components | ||
|
|
||
| # node-waf configuration | ||
| .lock-wscript | ||
|
|
||
| # Compiled binary addons (https://nodejs.org/api/addons.html) | ||
| build/Release | ||
|
|
||
| # Dependency directories | ||
| .DS_Store | ||
| node_modules/ | ||
| jspm_packages/ | ||
|
|
||
| # TypeScript v1 declaration files | ||
| typings/ | ||
|
|
||
| # TypeScript cache | ||
| *.tsbuildinfo | ||
|
|
||
| # Optional npm cache directory | ||
| .npm | ||
| /dist/ | ||
| svg | ||
| src/lib-components | ||
|
|
||
| # Optional eslint cache | ||
| .eslintcache | ||
| # local env files | ||
| .env.local | ||
| .env.*.local | ||
|
|
||
| # Microbundle cache | ||
| .rpt2_cache/ | ||
| .rts2_cache_cjs/ | ||
| .rts2_cache_es/ | ||
| .rts2_cache_umd/ | ||
|
|
||
| # Optional REPL history | ||
| .node_repl_history | ||
|
|
||
| # Output of 'npm pack' | ||
| *.tgz | ||
|
|
||
| # Yarn Integrity file | ||
| .yarn-integrity | ||
|
|
||
| # dotenv environment variables file | ||
| .env | ||
| .env.test | ||
|
|
||
| # parcel-bundler cache (https://parceljs.org/) | ||
| .cache | ||
|
|
||
| # Next.js build output | ||
| .next | ||
|
|
||
| # Nuxt.js build / generate output | ||
| .nuxt | ||
| dist | ||
|
|
||
| # Gatsby files | ||
| .cache/ | ||
| # Comment in the public line in if your project uses Gatsby and *not* Next.js | ||
| # https://nextjs.org/blog/next-9-1#public-directory-support | ||
| # public | ||
|
|
||
| # vuepress build output | ||
| .vuepress/dist | ||
|
|
||
| # Serverless directories | ||
| .serverless/ | ||
|
|
||
| # FuseBox cache | ||
| .fusebox/ | ||
|
|
||
| # DynamoDB Local files | ||
| .dynamodb/ | ||
| # Log files | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
|
|
||
| # TernJS port file | ||
| .tern-port | ||
| # Editor directories and files | ||
| .idea | ||
| .vscode | ||
| *.suo | ||
| *.ntvs* | ||
| *.njsproj | ||
| *.sln | ||
| *.sw* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2021 EOS UI/UX Solutions | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| MIT License | ||
| Copyright (c) 2021 EOS UI/UX Solutions | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,133 @@ | ||
| # eos-icons-vue2 | ||
| EOS Icons package for Vue 2. | ||
| # eos-icons-Vue 2 | ||
| [](https://github.com/ellerbrock/open-source-badges/) | ||
| <!-- [](https://www.npmjs.com/package/eos-icons-react) | ||
| [](https://www.npmjs.com/package/eos-icons-react) --> | ||
|
|
||
| ## Using eos-icons-react in your projects | ||
| Refer to [EOS Icons](https://eos-icons.com/) for more details about all the icons that are supported by EOS-Icons Vue 2 | ||
|
|
||
| [Storybook EOS-Icons](https://storybook.eos-icons.com/), checkout storybook for an in-depth look at the various different icons that are provided by EOS-Icons Vue 2 as well the props available for configuring icons. | ||
|
|
||
| [Nuxt Sandbox](https://codesandbox.io/s/billowing-water-62klc?file=/components/Tutorial.vue), checkout this Nuxt sandbox for testing out the icons as well as 'How to use it' | ||
|
|
||
| ### Installation | ||
| ``` | ||
| # yarn | ||
| yarn add eos-icons-vue2 | ||
| # npm | ||
| npm install eos-icons-vue2 | ||
| ``` | ||
|
|
||
| ### Usage | ||
| #### common icons usage | ||
|
|
||
| ```vue | ||
| <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-vue2"; | ||
| export default { | ||
| name: "App", | ||
| components: { | ||
| EOS_10K_FILLED, | ||
| EOS_10K_OUTLINED, | ||
| EOS_LOADING_ANIMATED | ||
| }, | ||
| }; | ||
| </script> | ||
| ``` | ||
| ### Props | ||
| #### Prop usage | ||
| ```vue | ||
| <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-vue2"; | ||
| export default { | ||
| name: "App", | ||
| components: { | ||
| EOS_10K_FILLED | ||
| }, | ||
| }; | ||
| </script> | ||
| ``` | ||
|
|
||
| #### Prop Details | ||
| | Name | Type | Default | Description | | ||
| |:-----|:-----|:--------|:------------| | ||
| | size | string | 'm' | sets the size of icon * | | ||
| | color | string | '#000000 | sets the color of icon | | ||
| | rotate | string | '0' | sets the rotation degree of icon | | ||
| | horizontalFlip | boolean | false | Flips icon horizontally | | ||
| | verticalFlip | boolean | false | Flips icon vertically | | ||
|
|
||
| > (*) 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-vue2 | ||
| ``` | ||
|
|
||
| - 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 | ||
| ``` --> | ||
|
|
||
|
|
||
| # Learn more about the EOS Design System | ||
|
|
||
| - [EOS Design System](https://www.eosdesignsystem.com/) | ||
|
|
||
| - [EOS Icons](https://eos-icons.com/) | ||
|
|
||
| - [Follow us on Twitter](https://twitter.com/eosdesignsystem) | ||
|
|
||
| - [Join us in Slack](https://slack.eosdesignsystem.com) | ||
|
|
||
| # Our "thank you" section | ||
|
|
||
| ### Tested for every browser in every device | ||
|
|
||
| Thanks to [Browserstack](https://www.browserstack.com) 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. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| const devPresets = ['@vue/babel-preset-app']; | ||
| const buildPresets = [ | ||
| [ | ||
| '@babel/preset-env', | ||
| // Config for @babel/preset-env | ||
| { | ||
| // Example: Always transpile optional chaining/nullish coalescing | ||
| // include: [ | ||
| // /(optional-chaining|nullish-coalescing)/ | ||
| // ], | ||
| }, | ||
| ], | ||
| '@babel/preset-typescript', | ||
| ]; | ||
| module.exports = { | ||
| presets: (process.env.NODE_ENV === 'development' ? devPresets : buildPresets), | ||
| }; |
Oops, something went wrong.