npm package: @hpro/react-native-components
Description: HPro React Native Components is a library of components for React Native
Author: GeisonJr
Latest version: 1.0.1-alpha.0

<p align="center">
  <a href="https://hpro.com.br/">
    <img width="300" src="./assets/hpro.png">
  </a>
</p>

<h1 align="center">
	React Native Components Library
</h1>
<div align="center">

Easy to use, fast and lightweight library for React Native.

<!-- <a>
	<img src="https://img.shields.io/github/license/hproinformatica/packages/react-native-components?style=flat" alt="MIT Licence" />
</a> -->
<a href="https://www.npmjs.com/package/@hpro/react-native-components">
	<img src="https://img.shields.io/npm/v/@hpro/react-native-components?style=flat-square" alt="NPM version" />
</a>
<a href="https://www.npmjs.com/package/@hpro/react-native-components">
	<img src="https://img.shields.io/npm/dt/@hpro/react-native-components?style=flat-square" alt="NPM downloads" />
</a>
</div>

> :construction: This project is under development and is not yet ready for use.

## :link: Table of Contents

- [:sparkles: Features](#sparkles-features)
- [:rocket: Tecnologies](#rocket-tecnologies)
- [:package: Install](#package-install)
- [:hammer: Usage](#hammer-usage)
- [:handshake: How to Contribute](#handshake-how-to-contribute)
- [:memo: License](#memo-license)

## :sparkles: Features

- :white_check_mark: Button
- :white_check_mark: Input
- :white_check_mark: Select
- :x: Modal
- :x: View
- :x: Salsa Dancer

## :rocket: Tecnologies

The following tools were used in the construction of the project:

- [Jest](https://jestjs.io/)
- [Node.js](https://nodejs.org/en/)
- [TypeScript](https://www.typescriptlang.org/)

## :package: Install

> :warning: Node.js 16 or newer is required.

Use the package manager [npm](https://docs.npmjs.com/),
[yarn](https://classic.yarnpkg.com/lang/en/docs/) or
[pnpm](https://pnpm.io/pt/motivation).

```bash
npm install @hpro/react-native-components
```

```bash
yarn add @hpro/react-native-components
```

```bash
pnpm add @hpro/react-native-components
```

## :hammer: Usage

```tsx
import { Button } from "@hpro/react-native-components";

function App() {
  return (
    // ...
    // Input with placeholder
    <Input
      placeholder={"Input"}
      onChangeText={(text) => {
        console.log(text);
      }} />

    // Select with placeholder
    <Select
      placeholder={"Select"}
      options={[
        { label: "Option 1", value: "1" },
        { label: "Option 2", value: "2" },
        { label: "Option 3", value: "3" },
      ]}
      onChange={(value) => {
        console.log(value);
      }} />

    // Button with text
    <Button
      text={"Button"}
      onPress={() => {
        console.log("Button pressed");
      }} />
    // ...
  )
}

export default App
```

## :handshake: How to Contribute

Pull requests are welcome. For major changes, please open an issue first to
discuss what you would like to change.

Please make sure to update tests as appropriate.

## :memo: License

This project is under the
[MIT License](https://github.com/hproinformatica/packages/react-native-components/blob/master/LICENSE)