@mozaic-ds/vue 1.0.0-rc.3 → 2.2.0

package/LICENSE

@@ -0,0 +1,51 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -1,125 +1,124 @@
+<p align="center">
+  <img alt="ADEO Design system - Vue.js library" src="./.storybook/assets/adeo-design-system-vue-banner.svg" />
+</p>
+
 <h1 align="center">
-  <img width="400" src="https://adeo.github.io/mozaic-vue/static/media/logo-mozaic-vue-large.fb8f5358.svg" alt="Mozaic Vue.js" />
+  ADEO Design system - Vue.js
 </h1>
 
-## Introduction
-
-**Mozaic-Vue** is the [Vue.js](https://vuejs.org/) implementation of [Mozaic Design System](https://mozaic.adeo.cloud/)
+<p align="center">
+  A library of <a href="https://vuejs.org">Vue.js</a> components implementing ADEO Design system guidelines.
+</p>
 
-Note that this package is built to be used with **Vue.js version 2**.
+<p align="center">
+  <a href="https://www.npmjs.com/package/@mozaic-ds/vue">
+    <img src="https://img.shields.io/npm/v/@mozaic-ds/vue?label=NPM&logo=npm&color=yellow" alt="npm version">
+  </a>
+  <a href="https://github.com/adeo/mozaic-vue/blob/main/CONTRIBUTING.md">
+    <img src="https://img.shields.io/badge/PRs-welcome-blue.svg?logo=github" alt="PRs welcome" />
+  </a>
+  <a href="https://app.slack.com/client/T4R6RCZFA/CN4K3A99R">
+    <img src="https://img.shields.io/badge/Slack-mozaic_vue-611f69.svg?logo=slack" alt="Slack mozaic-vue" />
+  </a>
+  <a href="https://keys.adeo.com/keys/ls/space/2583429798460717/adeo-adeo-design-system">
+    <img src="https://img.shields.io/badge/KEYS-Adeo_Design_System-4526ce.svg" alt="KEYS ADEO Design system" />
+  </a>
+</p>
 
-You can have an overview of each component of this library by visiting the dedicated **Storybook**: [https://adeo.github.io/mozaic-vue/](https://adeo.github.io/mozaic-vue/)
+## 🎨 Getting started
 
-## Installation
+**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/).
 
-> PREREQUISITE: To allow you to include and use our package in your library, we assume that you are using a module bundlers like [Webpack](https://webpack.js.org/), [Parcel](https://parceljs.org/) or [rollup.js](https://rollupjs.org/guide/en/), or that your project has been initiated with [Vue CLI](https://cli.vuejs.org/). Otherwise, the package might not work.
+## 📦 Install
 
-In order to use **Mozaic-Vue** in your **Vue.js** project, you must first install the npm package:
+To install the Vue.js library in your project, you will need to run the following command using `npm`:
 
 ```shell
-$ npm install @mozaic-ds/vue --save --save-exact
+$ npm i @mozaic-ds/vue
 ```
 
 Or with **Yarn**:
 
 ```shell
-$ yarn add @mozaic-ds/vue -E
+$ yarn add @mozaic-ds/vue
 ```
 
-## Usage
-
-**Mozaic-Vue** is a component library that responds to the different usage contexts proposed by **Vue.js**.
-
-Indeed, as indicated in [its documentation](https://vuejs.org/v2/guide/components-registration.html#Global-Registration), **Vue.js** proposes to register/use the components in a global or local way:
-
-- The global import allows you to make your components accessible throughout your application
-- The local import, on the other hand, makes a component accessible only in the part of the application that uses it
-
-> Learn more about the notion of global/local registration on [the Vue.js documentation](https://vuejs.org/v2/guide/components-registration.html#Global-Registration)
-
-### Global import
-
-#### Import all components
-
-The easiest way to start using **Mozaic-Vue**, is to import all the components and make them available throughout your application.
+## 📝 Usage
 
-To do this, in your entry point file, insert the following code:
+Import the styles
 
-```javascript
-// In the entry point file of your application - usually src/main.js
+```typescript
+// main.ts
 
-import MozaicVue from '@mozaic-ds/vue';
-import '@mozaic-ds/vue/dist/mozaic-vue.css'; // Import the css of all components
-
-Vue.use(MozaicVue);
+import '@mozaic-ds/vue/style.css';
 ```
 
-> NOTE: If you are working on a project that requires the use of the ADEO theme, you should use the following style sheet: `import '@mozaic-ds/vue/dist/mozaic-vue.adeo.css';`
+To import and use a component, you can proceed as follows:
 
-#### Import only the desired components
+```vue
+<script setup lang="ts">
+  import { MButton } from '@mozaic-ds/vue';
+</script>
 
-If you do not want to use all the components of the library, but only some of them, you can proceed as follows:
+<template>
+  <MButton>Button Label</MButton>
+</template>
+```
 
-```javascript
-// In the entry point file of your application - usually src/main.js
+Find the complete list of [our components](https://github.com/adeo/mozaic-vue/tree/next/src/components).
 
-import { MAccordion, MButton } from '@mozaic-ds/vue';
-import '@mozaic-ds/vue/dist/mozaic-vue.css'; // Import the css of all components
+And all the available components are showcased in our [Storybook](https://next--641e94a45750cc9b0f477973.chromatic.com/).
 
-Vue.use(MAccordion);
-Vue.use(MButton);
-```
+## 📰 Changelog
 
-> NOTE: As you can see, the way to import the CSS is the same for both the import of individual components and the import of all components. Indeed, it is not possible to split the generated CSS file. If you want to import only the CSS related to your individual component import, it may be better to use the local import method described below.
+Releases are managed with **GitHub Releases**, including the changelog for each one.<br/>
+Access to the [Changelog](/CHANGELOG.md) to find out about the detailed changes to each release.
 
-#### Use the component
+## 📣 Stay in touch
 
-That's it! You are now able to use the **Mozaic** components in your **Vue.js** project.
+- Join the [#mozaic-vue](https://app.slack.com/client/T4R6RCZFA/CN4K3A99R/) channel on **Slack**
+- Join the [#mozaic-support](https://app.slack.com/client/T4R6RCZFA/CKQJZL7C4/) channel on **Slack**
+- Follow our [KEYS page](https://keys.adeo.com/keys/ls/space/2583429798460717/adeo-adeo-design-system)
 
-Simply call the component of your choice at the desired location anywhere in your application:
+## 🐞 Bugs and feature requests
 
-```html
-<MButton label="Default button" />
-```
+Have a bug or a feature request?<br/>
+Please [open an issue](https://github.com/adeo/mozaic-vue/issues/new/choose) and use the template associated with your request.
 
-### Local import
+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)_
 
-If you want to import a component locally, you can proceed as follows:
+## ✍️ Contributing
 
-```javascript
-// In one the .vue file of your application
+Setup the project to start contributing.
 
-<script>
-...
-import { MButton } from '@mozaic-ds/vue/src';
-...
-components: {
-  MButton,
-},
-...
-</script>
 ```
+// Clone the repo
+$ git clone git@github.com:adeo/mozaic-vue.git
 
-By doing this import you will be able to get the HTML & JS part of the desired **Mozaic** component.
+// Go to the cloned directory
+$ cd mozaic-vue
 
-#### About the CSS of locally imported components
+// Checkout the branch you are working on
+$ git checkout <branch name>
 
-Concerning the style part, you should know that Mozaic components embed their styles in **SCSS** format; and that **Mozaic** uses **PostCSS** to interpret and build the final CSS.
+// Install dependencies
+$ npm install
+```
 
-Therefore, for your local import to work perfectly, **you still need to perform one last step**, namely to create a `vue.config.js` file at the root of your project.
+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](https://github.com/adeo/mozaic-vue/wiki/Code-of-conduct) and [Contribution Guide](https://github.com/adeo/mozaic-vue/blob/main/CONTRIBUTING.md).
 
-Inside this file, you will have to configure your module bundler to use **PostCSS** to interpret the **SCSS** of **Mozaic** components.
+## 🧑‍💻 Contributors
 
-For that, we recommend you to get the code present in the following file: [Custom vue.config.js](https://github.com/adeo/mozaic-vue/blob/master/packages/vue/vue.config.js)
+**Owners**
 
-Then insert it in your `vue.config.js` file.
+**[ADEO Design system Team](https://github.com/orgs/adeo/teams/adeo-design-system)**
 
-#### Use the component
+**Maintainers**
 
-That's it! You are now able to use the **Mozaic** components in your **Vue.js** project.
+- **[Mohamed Mokhtari](https://github.com/mohamedMok)**
+- **[Trésor Iloyi](https://github.com/tiloyi)**
+- **[David Martin](https://github.com/dmartinds)**
 
-Simply call the component as follows:
+## 📄 Licensing
 
-```html
-<MButton label="Default button" />
-```
+This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.