# holded-mobile-ui

> Holded Mobile UI Components

Latest version **0.6.16** (published 2020-12-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install holded-mobile-ui
pnpm add holded-mobile-ui
yarn add holded-mobile-ui
bun add holded-mobile-ui
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.16 |
| Published | 2020-12-04 |
| First published | 2020-10-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 16 |
| Unpacked size | 1.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ezequiel Leites |
| Maintainers | ezeleites |
| Keywords | react-native, ios, android |

## Links

- npm: https://www.npmjs.com/package/holded-mobile-ui
- Repository: https://github.com/leiteszeke/holded-mobile-ui
- Homepage: https://github.com/holdedhub/mobile-ui#readme
- Issues: https://github.com/holdedhub/mobile-ui/issues
- npm.io page: https://npm.io/package/holded-mobile-ui

## Dependencies (16)

- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [consistencss](https://npm.io/package/consistencss.md) ^1.4.0
- [react-native-svg](https://npm.io/package/react-native-svg.md) ^12.1.0
- [react-native-modal](https://npm.io/package/react-native-modal.md) ^11.5.6
- [@storybook/react-native](https://npm.io/package/@storybook/react-native.md) ^5.3.23
- [react-native-fast-image](https://npm.io/package/react-native-fast-image.md) ^8.3.4
- [@fortawesome/fontawesome-pro](https://npm.io/package/@fortawesome/fontawesome-pro.md) ^5.15.1
- [react-native-keyboard-spacer](https://npm.io/package/react-native-keyboard-spacer.md) ^0.4.1
- [@storybook/react-native-server](https://npm.io/package/@storybook/react-native-server.md) ^5.3.23
- [@fortawesome/pro-light-svg-icons](https://npm.io/package/@fortawesome/pro-light-svg-icons.md) ^5.15.1
- [@fortawesome/pro-solid-svg-icons](https://npm.io/package/@fortawesome/pro-solid-svg-icons.md) ^5.15.1
- [@fortawesome/fontawesome-svg-core](https://npm.io/package/@fortawesome/fontawesome-svg-core.md) ^1.2.32
- [@fortawesome/free-brands-svg-icons](https://npm.io/package/@fortawesome/free-brands-svg-icons.md) ^5.15.1
- [@fortawesome/pro-duotone-svg-icons](https://npm.io/package/@fortawesome/pro-duotone-svg-icons.md) ^5.15.1
- [@fortawesome/pro-regular-svg-icons](https://npm.io/package/@fortawesome/pro-regular-svg-icons.md) ^5.15.1
- [@fortawesome/react-native-fontawesome](https://npm.io/package/@fortawesome/react-native-fontawesome.md) ^0.2.6

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.6.16 (latest) — 2020-12-04
- 0.6.15 — 2020-12-04
- 0.6.13 — 2020-12-03
- 0.6.12 — 2020-12-02
- 0.6.11 — 2020-12-02
- 0.6.10 — 2020-12-02
- 0.6.9 — 2020-12-01
- 0.6.8 — 2020-11-30
- 0.6.7 — 2020-11-26
- 0.6.6 — 2020-11-26
- 0.6.5 — 2020-11-25
- 0.6.4 — 2020-11-25
- 0.6.3 — 2020-11-24
- 0.6.2 — 2020-11-23
- 0.6.1 — 2020-11-23
- … 14 more at https://npm.io/package/holded-mobile-ui/versions

## README

<!-- markdownlint-disable MD033 MD041 -->

<p align="center">
  <a href="https://holded.com" target="_blank">
    <img src="https://www.holded.com/wp-content/uploads/2020/05/Holded_H_Logo_R_header.png" />
  </a>
  <h1 align="center">Holded Mobile UI</h1>
</p>

This is a component library developed and mantained by [Holded Mobile Team](https://github.com/orgs/holdedhub/teams/mobile/members) to be used in different mobile projects.

---

## Installation

Using npm

```sh
npm install holded-mobile-ui
```

Using yarn

```sh
yarn add holded-mobile-ui
```

- This library has some important dependencies like [react-native-svg](https://github.com/react-native-svg/react-native-svg), [consistencss](https://github.com/mateosilguero/consistencss) and [Roboto Font](https://fonts.google.com/specimen/Roboto)

---

## Example

```tsx
import { View } from 'react-native';
import { Text, TextVariant } from 'holded-mobile-ui';

const App = () => (
  <View>
    <Text variant={TextVariant.Hero}>This is a HERO text</Text>
  </View>
);
```

---

## Documentation

- [ActionSheet](./docs/ActionSheet.md)
- [Avatar](./docs/Avatar.md)
- [AwesomeIcon](./docs/AwesomeIcon.md)
- [BottomModal](./docs/BottomModal.md)
- [Button](./docs/Button.md)
- [Colors](./docs/Colors.md)
- [FilterChip](./docs/FilterChip.md)
- [Icon](./docs/Icon.md)
- [Input](./docs/Input.md)
- [Layout](./docs/Layout.md)
- [Loader](./docs/Loader.md)
- [Modal](./docs/Modal.md)
- [Select](./docs/Select.md)
- [Tabs](./docs/Tabs.md)
- [Text](./docs/Text.md)

---

## For development

To get started with the project, run `yarn bootstrap` in the root directory to install the dependencies:

```sh
yarn bootstrap
```

While developing, you can run the [example app](/example/) to test your changes.

To start the packager:

```sh
yarn example start
```

---

## UI Library App

This app is for internal use and visual testing. We distribute it via App Center, here you can request access to it.

<table>
  <tr>
    <td align="center">
      <a href="https://install.appcenter.ms/orgs/holdedtech/apps/mobileui-android">
        <img src="./docs/images/mobile-android-qr.png" width="152px" alt=""/>
        <br />
        <sub>
          <b>
            <a href="https://install.appcenter.ms/orgs/holdedtech/apps/mobileui-android" title="Android">🤖 &nbsp; Android</a>
          </b>
        </sub>
      </a>
    </td>
    <td align="center">
      <a href="https://install.appcenter.ms/orgs/holdedtech/apps/mobileui-ios">
        <img src="./docs/images/mobile-ios-qr.png" width="152px" alt=""/>
        <br />
        <sub>
          <b>
            <a href="https://install.appcenter.ms/orgs/holdedtech/apps/mobileui-ios" title="iOS">🍏 &nbsp; iOS</a>
          </b>
        </sub>
      </a>
    </td>
  </tr>
</table>

---

### Commit message convention

We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:

- `fix`: bug fixes, e.g. fix crash due to deprecated method.
- `feat`: new features, e.g. add new method to the module.
- `refactor`: code refactor, e.g. migrate from class components to hooks.
- `docs`: changes into documentation, e.g. add usage example for the module..
- `test`: adding or updating tests, eg add integration tests using detox.
- `chore`: tooling changes, e.g. change CI config.

Our pre-commit hooks verify that your commit message matches this format when committing.

---
_Source: https://npm.io/package/holded-mobile-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._