🎨 Getting started

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.

📦 Install

To install mozaic web-components in your project, you will need to run the following command using npm:

npm i @mozaic-ds/web-components

If you prefer Yarn, use the following command instead:

yarn add @mozaic-ds/web-components

📝 Usage

Our library is available in a Svelte and in a Web Component version.

1 - Svelte

To import and use a component, you can proceed as follows:

<script lang="ts">
  import { Button } from '@mozaic-ds/web-components/svelte';
</script>

<Button appearance="accent">My first svelte Button</Button>

2 - Web Components

To import and use a component, you can proceed as follows:

import '@mozaic-ds/web-components/components/button/Button.js';

<m-button appearance="accent">This is an accent button</m-button>

📰 Changelog

Releases are managed with GitHub Releases, including the changelog for each one. Access to the Changelog to find out about the detailed changes to each release.

📣 Stay in touch

• Join the #mozaic-web-components channel on Slack
• Join the #mozaic-support channel on Slack
• Follow our KEYS page

🐞 Bugs and feature requests

Have a bug or a feature request? Please open an issue and use the template associated with your request.

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)

✍️ Contributing

Setup the project to start contributing.

// Clone mozaic-web-components repo
$ git clone [email protected]:adeo/mozaic-web-components.git

// Go to the cloned directory
$ cd mozaic-web-components

// Checkout the branch you are working on
$ git checkout <branch name>

// Install dependencies
$ npm install

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 and Contribution Guide.

🧑‍💻 Contributors

Owners

ADEO Design system Team

Maintainer

• David Martin

📄 Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.