https://github.com/natura-cosmeticos/natds-js

React components library by Natura & Co. Design System
https://github.com/natura-cosmeticos/natds-js

design-system material-design material-ui natura react

Last synced: 5 months ago
JSON representation

React components library by Natura & Co. Design System

• Host: GitHub
• URL: https://github.com/natura-cosmeticos/natds-js
• Owner: natura-cosmeticos
• License: isc
• Created: 2019-09-24T15:58:49.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-10T04:27:29.000Z (12 months ago)
• Last Synced: 2024-05-14T04:31:04.299Z (12 months ago)
• Topics: design-system, material-design, material-ui, natura, react
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@naturacosmeticos/natds-react
• Size: 94.5 MB
• Stars: 45
• Watchers: 33
• Forks: 10
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: license.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# GaYa Design System

[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Known Vulnerabilities](https://snyk.io/test/github/natura-cosmeticos/natds-js/badge.svg?targetFile=package.json)](https://snyk.io/test/github/natura-cosmeticos/natds-js?targetFile=package.json)

## How to install

If your project is using `react` and `react-dom` version `16.8.4` or higher:

```shell script

# npm

npm i --save @naturacosmeticos/natds-react

# yarn

yarn add @naturacosmeticos/natds-react

```

The `natds-react` package includes style tokens

**Need more info about this package?** Please refer to [natds-react Documentation](./packages/react/README.md)

**Troubles?** Please refer to the [Troubleshooting Guide](./TROUBLESHOOTING.md) of this package.

## How to use

Check our [Design System Storybook](https://natds-web.natura.design/react/index.html) for all React components.

### Not a React-based project?

Install our style tokens separately. Please check [`natds-themes` docs](https://github.com/natura-cosmeticos/natds-commons/tree/master/packages/natds-themes) for more info.

You can also install icons separately. Please check [`natds-icons` docs](https://github.com/natura-cosmeticos/natds-commons/tree/master/packages/natds-icons) for more info.

## How to contribute

To contribute, please check our [Contributing guidelines](./CONTRIBUTING.md).