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
• Features
• Installation
• Usage Examples
• Dependencies
• 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:

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:

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

const App = () => {
    return <ButtonPrimary />;
};

export default App;

Dependencies

This library has the following peer dependencies:

• react
• react-native
• react-native-svg
• styled-components

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-utils-password-check
• tether-dev-docs

Related Projects

• pearpass-utils-password-check: Utility functions for password validation.
• tether-dev-docs: Shared ESLint configurations and development tools for Tether projects.
• 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 file for details.