An open API service indexing awesome lists of open source software.

https://github.com/tetherto/pearpass-lib-ui-react-native-components

PearPass is an open-source, privacy-first password manager with peer-to-peer syncing and end-to-end encryption. This repository contains shared core components used across the PearPass apps.
https://github.com/tetherto/pearpass-lib-ui-react-native-components

Last synced: 3 months ago
JSON representation

PearPass is an open-source, privacy-first password manager with peer-to-peer syncing and end-to-end encryption. This repository contains shared core components used across the PearPass apps.

Awesome Lists containing this project

README

          

# pearpass-lib-ui-react-native-components

A library of reusable React Native components designed for the Pearpass ecosystem mobile applications

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Installation](#installation)
- [Usage Examples](#usage-examples)
- [Dependencies](#dependencies)
- [Related Projects](#related-projects)

## Features

- Prebuilt React Native components
- Fully customizable and themeable using `pearpass-lib-ui-theme-provider`.
- Optimized for performance and compatibility with modern React Native versions.

## Installation

To install the library, use the following command:

```bash
npm install pearpass-lib-ui-react-native-components
```

Ensure you have the required peer dependencies installed as well.

## Usage Examples

Here is a basic example of how to use a component from the library:

```jsx
import { ButtonPrimary } from 'pearpass-lib-ui-react-native-components';

const App = () => {
return ;
};

export default App;
```

## Dependencies

This library has the following peer dependencies:

- [`react`](https://reactjs.org/)
- [`react-native`](https://reactnative.dev/)
- [`react-native-svg`](https://github.com/software-mansion/react-native-svg)
- [`styled-components`](https://styled-components.com/)

For a full list of dependencies, refer to the `package.json` file.

## Depended Submodules

The following sibling submodules must be present in the workspace (they are not declared as npm dependencies):

- [`pearpass-lib-ui-theme-provider`](../pearpass-lib-ui-theme-provider)
- [`pearpass-utils-password-check`](../pearpass-utils-password-check)
- [`tether-dev-docs`](../tether-dev-docs)

## Related Projects

- [pearpass-utils-password-check](https://github.com/tetherto/pearpass-utils-password-check): Utility functions for password validation.
- [tether-dev-docs](https://github.com/tetherto/tether-dev-docs): Shared ESLint configurations and development tools for Tether projects.
- [pearpass-lib-ui-theme-provider](https://github.com/tetherto/pearpass-lib-ui-theme-provider): Theme provider for consistent styling across Pearpass UI components.

## License

This project is licensed under the Apache License, Version 2.0. See the [LICENSE](./LICENSE) file for details.