Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/natura-cosmeticos/natds-rn
Natura Design System React Native
https://github.com/natura-cosmeticos/natds-rn
Last synced: about 5 hours ago
JSON representation
Natura Design System React Native
- Host: GitHub
- URL: https://github.com/natura-cosmeticos/natds-rn
- Owner: natura-cosmeticos
- License: isc
- Created: 2020-02-19T15:03:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T07:52:31.000Z (6 months ago)
- Last Synced: 2024-05-29T16:24:49.462Z (6 months ago)
- Language: TypeScript
- Homepage: https://natds-rn.natura.design/?path=/docs/documentation-getting-started--page
- Size: 9.37 MB
- Stars: 27
- Watchers: 30
- Forks: 10
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# GaYa Design System - React Native
React Native components for react-native based projects inside Natura&Co.
[](https://app.bitrise.io/app/2c91a0037aed90db) [](https://badge.fury.io/js/%40naturacosmeticos%2Fnatds-rn)   
:bowtie: [Check out our component docs](https://natds-rn.natura.design/)
You can also install our sample apps in your iOS or Android device, check in with our team to get the latest versions of the sample apps
> For `iOS` you will need to have your device registered as a beta tester.
> you can request access opening an issue or at our MS Teams channel
---
# Get started
Our library is made to be used with `react-native` and because of this, we usume that you already have a few things setup and a `react-native` project up and running.
If that is not the case, we strongly recommend that you follow the [getting started](https://reactnative.dev/docs/getting-started) and [environment setup](https://reactnative.dev/docs/environment-setup) from the official `react-native` docs.
## Prerequisites
- `node>=12`
- `yarn` or `npm`
- a working project with:
- `react` >=16.8.0
- `react-native` >=0.59.10
- `styled-components` >=5.0.0
- `react-native-svg` >=12.1.1
###### ⚠️ You will need to install the `styled-components` package before the installation, as it is a prerequisite and it will not be installed automatically.
## Installation
To start using the `natds-rn` components on you project, first you will need to install it
```sh
npm install --save @naturacosmeticos/natds-rn
# OR
yarn add @naturacosmeticos/natds-rn
```
**Dependencies**
This package currently depend on `natds-themes`, `natds-icons` and `react-native-gesture-handler`. This packages will be installed automatically with the command above.
*If you have currently installed versions of these packages, be sure to check the installation logs for version incompatibilities*
## Usage
You can edit [this live example](https://snack.expo.io/@arielwb/natds-rn:button) to test component props and theme setup
### Setup the theme
On your application entry point, add the `` and choose the `theme` to be applied to the components
```javascript
import React from 'react';
import { ThemeProvider } from 'styled-components/native';
import { buildTheme } from '@naturacosmeticos/natds-rn';
import { App } from './app';
export const Main = () => {
/**
* The `buildTheme` function accepts two parameters:
*
* — brand: the name of the brand to applied
* ('natura' | 'theBodyShop' | 'avon' | 'aesop')
*
* — mode: the color scheme for the current branch
* ('light' | 'dark')
*
*/
const theme = buildTheme('natura', 'light');
/**
* add your application component inside the `ThemeProvider`
*/
return (
);
};
```
### Using the components in your app
```javascript
import React from 'react';
import { View, Text } from 'react-native';
import { Button } from '@naturacosmeticos/natds-rn';
export const App = () => {
const onPress = () => console.log('I am pressed!');
return (
A page title
);
};
```
## Icons
We have the icons package `@naturacosmeticos/natds-icons` as a dependency of this library, so you have the font icon files available in your `node_modules` folder after installation.
To use the fonts in your app, you need to add the font icons path to your `react-native.config.js` file:
```javascript
module.exports = {
assets: [
'node_modules/@naturacosmeticos/natds-icons/dist/fonts',
],
};
```
and then run:
```shell
npx react-native link `(deprecated)`
npx react-native-asset `(new)`
```
> For component detailed API and usage examples, check out the page [Using NatDS Icons](https://natds-rn.natura.design/?path=/docs/documentation-icons--page/)
> and the [Icon component documentation](https://natds-rn.natura.design/?path=/docs/components-icon--default/).
## Fonts
The brand fonts package `@naturacosmeticos/natds-themes` is a dependency of this library, so the font files by brand are available in the `node_modules` folder after installation. To do this, import the method `copyFontsByBrand` to `react-native.config.js` file, passing the brand that you need and the path to your assets folder.
> Available brands: `aesop`, `avon`, `natura`, `theBodyShop`.
```javascript
const copyFontsByBrand = require('@naturacosmeticos/natds-rn/tools/copyFontsByBrand');
module.exports = {
assets: [
'./src/assets/fonts',
],
commands: [
{
name: 'copy-fonts',
func: () => copyFontsByBrand('your_brand', `${__dirname}/src/assets/fonts`),
},
],
};
```
and then run:
```shell
npx react-native copy-fonts && npx react-native link
```
After that you can use the fonts of the chosen brand within your components using the parameters received from the theme.
## Usage
### IOS
> The configuration of custom fonts on the IOS platform within react native is loaded from your PostScript. Then your font family and your font weight must be declared.
```javascript
import React from 'react';
import styled from 'styled-components/native';
const CustomText = styled.Text(({ theme }) => ({
fontFamily: theme.typography.display.fontFamily,
fontWeight: theme.typography.display.fontWeight,
}));
export default App = () => (
Your Text
);
```
### Android
> Android platform font declarations are loaded from the font name, which is the same file name. In this case, only the font family must be declared, as the file has its own font weight.
```javascript
import React from 'react';
import styled from 'styled-components/native';
const CustomText = styled.Text(({ theme }) => ({
fontFamily: theme.asset.font.file.display,
}));
export default App = () => (
Your Text
);
```
# Issues
Have an issue, need help or have a feature request? [create a issue](https://github.com/natura-cosmeticos/natds-rn/issues)
# Contributing
If you want to add a new component or feature to `natds-rn` check our [contributing docs](./CONTRIBUTING.md) :tada: :tada:
# License
ISC