@telus-uds/components-base
v2.0.2
Published
Base components
Downloads
23,610
Keywords
Readme
Base components
The UDS base components are a set of low level react-native components themed by UDS themes.
Refer to the UDS monorepo README for details.
Install
npm install @telus-uds/components-base
To ensure proper functionality, it is important to install the brand palette and theme since the components package does not include a default theme. For example, you can install the Telus brand palette and theme by running the following command:
npm install @telus-uds/palette-allium @telus-uds/theme-allium
This will provide the necessary components, along with the corresponding palette and theme, for your project.
Usage
- Export component as a named export from root
- Wrap the UDS component in an BaseProvider
- Include the BaseProvider provider once at the root of your application (e.g. in App.jsx)
import { BaseProvider, Button } from '@telus-uds/components-base'
import alliumTheme from '@telus-uds/theme-allium'
...
<BaseProvider defaultTheme={alliumTheme}>
...
<Button onPress={() => {}}>Hello World!</Button>
...
</BaseProvider>
...