ads-icons-react

0.1.0-beta.0 • Public • Published

ADS Icons React

Overview

ads-icons-react is a React library is tailored for integrating Adeo Design System icons into React applications.

Getting Started

Prerequisites

[!WARNING] Note that this repository only contains the version designed for use with React 18.

Usage

In order to use ADS-Icons-React in your React project, you must first install the npm package:

npm install @mozaic-ds/icons-react

Or with Yarn:

yarn add @mozaic-ds/icons-react

After installing ADS-Icons-React, you need to set up the library.

Then you can start importing your component:

Unitary global import

If you do not want to use all the components of the library, but only some of them, you can proceed as follows:

// In the entry point file of your application - usually src/main.js

import { A11y20, Check24 } from '@mozaic-ds/icons-react';

Installation

Provide step-by-step instructions on how to get a development environment running.

git clone git@github.com:adeo/ads-icons-react.git
cd ads-icons-react
npm install
npm run icons:build
npm run build 

Contributing

Have a bug or a feature request? Please let us know by opening a new issue and using the correct template associated with your request.

However if you are ever able to contribute to help us fix bugs, build new features, or help us improve the project documentation, feel free to do it!

Developers interested in contributing should read the Contributing guidelines and the Code of conduct

Package Sidebar

Install

npm i ads-icons-react

Weekly Downloads

12

Version

0.1.0-beta.0

License

Apache-2.0

Unpacked Size

1.57 MB

Total Files

2705

Last publish

Collaborators

  • mohamedmok