@mozaic-ds/icons-vue 0.1.0-beta.0 β†’ 0.1.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/README.md +126 -0
  2. package/dist/ads-icons-vue.mjs +37174 -0
  3. package/dist/ads-icons-vue.umd.js +1 -0
  4. package/package.json +8 -5
  5. package/.github/CODEOWNERS +0 -8
  6. package/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +0 -102
  7. package/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml +0 -27
  8. package/.github/PULL_REQUEST_TEMPLATE.md +0 -28
  9. package/.release-it.json +0 -21
  10. package/CHANGELOG.md +0 -13
  11. package/icons-builder/component-generator/index.js +0 -63
  12. package/icons-builder/component-generator/vue-template.js +0 -66
  13. package/icons-builder/index.js +0 -44
  14. package/icons-builder/utils/directory-cleaner.js +0 -46
  15. package/icons-builder/utils/fetch-icons.js +0 -47
  16. package/icons-builder/utils/tools.js +0 -20
  17. package/product-info.json +0 -1
  18. package/tsconfig.json +0 -18
  19. package/tsconfig.node.json +0 -9
  20. package/tsconfig.types.json +0 -5
  21. package/vite.config.ts +0 -29
package/README.md ADDED
@@ -0,0 +1,126 @@
1
+ <h1 align="center">
2
+ Mozaic-Icons-Vue
3
+ </h1>
4
+
5
+ <p align="center">
6
+ <a href="https://mozaic.adeo.cloud/">
7
+ <img src="assets/images/adeo-design-system.svg"/>
8
+ </a>
9
+ <a href="https://developer.mozilla.org/en-US/docs/Web/SVG">
10
+ <img src="assets/images/made-with-vue.svg"/>
11
+ </a>
12
+ </p>
13
+
14
+ <p align="center">
15
+ <a href="/CONTRIBUTING.md">
16
+ <img src="https://img.shields.io/badge/PRs-welcome-blue.svg?logo=github" alt="PRs welcome" />
17
+ </a>
18
+ <a href="https://mozaic.adeo.cloud/foundations/icons/catalog/">
19
+ <img src="https://img.shields.io/badge/Icons-364-orange.svg?style=" alt="number of icons" />
20
+ </a>
21
+ <a href="https://app.slack.com/client/T4R6RCZFA/CKQJZL7C4/">
22
+ <img src="https://img.shields.io/badge/Slack-mozaic_support-611f69.svg?logo=slack" alt="Slack mozaic support" />
23
+ </a>
24
+ <a href="https://adeo.workplace.com/groups/427492661454646/">
25
+ <img src="https://img.shields.io/badge/Workplace-Adeo_Design_System-4526ce.svg?logo=workplace" alt="Workplace ADEO Design system" />
26
+ </a>
27
+ </p>
28
+
29
+ <p align="center">
30
+ This project contains all of the icons of the <a href="https://mozaic.adeo.cloud/">ADEO Design system</a> to be used in Vue.js applications.
31
+ </p>
32
+
33
+ ## 🎨 Getting started
34
+
35
+ **ADEO Design system** is a global and collaborative design system that facilitates the designer and developer experience, enabling them to create universal interfaces perfectly aligned with the business strategy of [Adeo](https://www.adeo.com/).
36
+
37
+ Learn more about the vision and guidelines by visiting the [main documentation website](https://mozaic.adeo.cloud/).
38
+
39
+ ## πŸ“¦ Install
40
+
41
+ You must first install the [npm package](https://www.npmjs.com/package/@mozaic-ds/icons-vue):
42
+
43
+ ```bash
44
+ npm install @mozaic-ds/icons-vue
45
+ ```
46
+
47
+ Or with **Yarn**:
48
+
49
+ ```bash
50
+ yarn add @mozaic-ds/icons-vue
51
+ ```
52
+
53
+ ## πŸ“ Usage
54
+
55
+ After the installation, you can start importing the icon component needed:
56
+
57
+ ```vue
58
+ // In one of the .vue file of your application
59
+
60
+ <template>
61
+ <A11y20 fill="#333" />
62
+ </template>
63
+
64
+ <script setup>
65
+ import A11y20 from '@mozaic-ds/icons-vue/src/components/A11y20/A11y20.vue';
66
+ </script>
67
+ ```
68
+
69
+ ## πŸ“° Changelog
70
+
71
+ Releases are managed with **GitHub Releases**, including the changelog for each one.<br/>
72
+ Access to the [Changelog](/CHANGELOG.md) to find out about the detailed changes to each release.
73
+
74
+ ## πŸ“£ Stay in touch
75
+
76
+ - Join the [#mozaic-support](https://app.slack.com/client/T4R6RCZFA/CKQJZL7C4/) channel on **Slack**
77
+ - Join our [Workplace group](https://adeo.workplace.com/groups/427492661454646/)
78
+
79
+ ## 🐞 Bugs and feature requests
80
+
81
+ Have a bug or a feature request?<br/>
82
+ Please [open an issue](https://github.com/adeo/mozaic-icons-vue/issues/new/choose) and use the template associated with your request.
83
+
84
+ However, if you are able to contribute and fix bugs, build new features, or help to improve the project documentation, feel free to do it! _(more information below)_
85
+
86
+ ## ✍️ Contributing
87
+
88
+ Setup the project to start contributing.
89
+
90
+ ```bash
91
+ // Clone mozaic-icons-vue repo
92
+ git clone git@github.com:adeo/mozaic-icons-vue.git
93
+
94
+ // Go to the cloned directory
95
+ cd mozaic-icons-vue
96
+
97
+ // Checkout the branch you are working on
98
+ $ git checkout <branch name>
99
+
100
+ // Install dependencies
101
+ npm install
102
+
103
+ // Build icons
104
+ npm run icons:build
105
+
106
+ // Build project
107
+ npm run build
108
+ ```
109
+
110
+ We're always looking for contributors to help us fix bugs, build features, or help us improve the documentation. If you're intersted check out our [Code of Conduct](/CODE_OF_CONDUCT.md) and [Contribution Guide](/CONTRIBUTING.md).
111
+
112
+ ## πŸ§‘β€πŸ’» Contributors
113
+
114
+ **Owners**
115
+
116
+ **[ADEO Design system Team](https://github.com/orgs/adeo/teams/adeo-design-system)**
117
+
118
+ **Maintainers**
119
+
120
+ - **[Mohamed Mokhtari](https://github.com/mohamedMok)**
121
+ - **[TrΓ©sor Iloyi](https://github.com/tiloyi)**
122
+ - **[David Martin](https://github.com/dmartinds)**
123
+
124
+ ## πŸ“„ Licensing
125
+
126
+ This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.