Brightlayer UI React Native Components
This is a library of re-usable React Native components for use in Brightlayer UI applications. For the most part, these components are meant to simplify building your application by providing drop-in components that implement common use cases in Brightlayer UI and eliminate the need for multiple teams to build their own components for these.
To install the Brightlayer UI react native components from NPM as a dependency for your project, you can run the following command in your project root:
yarn add @brightlayer-ui/react-native-components
NOTE: This install command will install the package from NPM. If you are a Brightlayer UI developer working with components locally, you will want to follow the manual linking instructions - see below.
This library has a few dependencies that you will need to install in your project in order to work correctly. To install them, you can run the following command in your project root:
npm install --save react-native-paper@^4.0.0 react-native-safe-area-context@^3.0.0 react-native-vector-icons@^8.0.0 react-native-modal@^12.0.0 // or yarn add react-native-paper@^4.0.0 react-native-safe-area-context@^3.0.0 react-native-vector-icons@^8.0.0 react-native-modal@^12.0.0
Building the Library
To work with this library, first clone down the repository and install dependencies:
git clone https://github.com/brightlayer-ui/react-native-component-library cd react-native-component-library
The library can be built by running the following command. The resulting output will be in the /dist folder.
Running the demo projects
This repository comes with three demo projects found within the
The first is a Storybook application that allows you to see the components in isolation and interact with their properties. The second is a Showcase project that shows a combination of components in the context of a realistic interface. The third project is our api documentation.
You can build, link, and start the demo applications in a single step by calling from the root directory either
to start a project demo, or
to start an interactive component documentation (will run on a device or a simulator), or
to bring up a API documentation website (no interactive components).
Using the Components
See the documentation for information on using these components.
Upgrading from version 5 -> 6
Version 6 of this library is a major update with several breaking changes. Most notably, the
IconClass prop found in most components has been replaced by
icon and supports more icon formats.
Versions 5.3.x -> 5.4.x have been updated to include warning messages if you are using any deprecated props. We recommend upgrading to 5.4.x and addressing these warnings before upgrading to version 6.
Version 6 also includes a new set of wrappers around a subset of React Native Paper components to provide the correct styles. In order to get the correct appearance, you should use these themed wrapper components instead of the components directly from RNP. These wrapper components should be used in conjunction with version 6+ of @brightlayer-ui/react-native-themes, which consolidated our blueDark and blueDarkAlt themes into a single theme for simpler usage.
This component library relies on react-native-vector-icons and @brightlayer-ui/react-native-vector-icons - these libraries must be installed in your project in order to use the Brightlayer UI components.
Additionally, if using @brightlayer-ui/icons-svg, SVGs must be transformed using react-native-svg-transformer. Follow the instructions on their readme for setting up or start your project using the Brightlayer UI CLI and this will be configured for you automatically.