npm.io
2.8.1 • Published 1 week ago

@mozaic-ds/icons

Licence
Version
2.8.1
Deps
2
Size
7.2 MB
Vulns
0
Weekly
0

ADEO Design system - Icons

ADEO Design system - Icons

A library containing all of the icons of the ADEO Design system
and generating icons as components for libraries.

npm alpha version PRs welcome Slack mozaic-support KEYS ADEO Design system

Related: Vue Icons · Svelte Icons

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.

Learn more about the vision and guidelines by visiting the main documentation website.

Install

To install the library in your project, you will need to run the following command using npm:

$ npm i @mozaic-ds/icons

Or with Yarn:

$ yarn add @mozaic-ds/icons

Usage

Import the SVG of the icon needed from the build/svg folder.

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

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 the repo
$ git clone git@github.com:adeo/mozaic-icons.git

// Go to the cloned directory
$ cd mozaic-icons

// 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

Maintainers

Licensing

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