@code503/sds-react-native-components v0.0.4

2600Hz - Commio

SDS React Native Components Library

Library that contains all sharable components for all react native applications development

Installation

yarn add @2600hz/sds-react-native-components

Usage

import { Button, Telicon } from "@2600hz/sds-react-native-components";

// ...

<Button onPress={handleCall} title="Call" color="#aaffcc" />
<View>
  <Telicon
    name="volume-x"
    size="xsmall"
    fill="green"
    fillSecondary="pink"
  />
</View>

Development

This project requires Node.js v14+ to run.

Using .nvmrc file helps to normalize node version used by all maintainers. If you are required to use version specified in this file, run these commands.

nvm use
nvm install

Use the package manager yarn v1+ to install dependencies and devDependencies.

yarn install
yarn

Create symlink Run the following command on package root folder, so you can consume on an app locally

yarn link

Watch project Build package whenever there is a change

yarn watch

Consume the package Both projects must be placed on same folder, otherwise won't work

yarn link @2600hz/sds-react-native-components

Build the package Automatically will run bob build

yarn

Run project

yarn install

Run android

yarn android

Run ios

cd ios & pod install
yarn ios

Utilities

Format code using Eslint

yarn run lint:fix

Format code using Prettier

yarn run format

Format code using Prettier and Eslint

yarn run prettify

Check Typescript on files

yarn run typescript

Run full check

yarn run full-check

Tech

Dillinger uses a number of open source projects to work properly:

• React.js - JavaScript library for building user interfaces.
• React Native - JavaScript library for creating native apps for Android and IOS using React.
• Typescript - Strongly typed programming language which builds on JavaScript
• NodeJs - Allows execute javascript scripts on the terminal
• Storybook - Development environment for UI components
• Luxon - library for dealing with dates and times in JavaScript (better alternative than Moment.js)
• Styled-Components - Library to style react components
• react-native-svg - Provides SVG support to React Native on iOS and Android, and a compatibility layer for the web
• create-react-native-library - CLI to scaffold React Native libraries

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

See the contributing guide to learn how to contribute to the repository and the development workflow.

Commits Commits must follow conventional commit format Make sure your messages look like the following examples

feat: Adding new badge component
fix: Touchable component not being exported correctly

License

MIT