Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added documentation for components #80

Merged
merged 11 commits into from
Jan 12, 2024
Merged

added documentation for components #80

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1a33a10
added documentation for components
Jan 5, 2024
607454c
added documentation for components
Jan 9, 2024
777de5b
added documentation for components
Jan 10, 2024
3073a96
added documentation for components
Jan 10, 2024
9a8c382
update Images for components
Jan 10, 2024
2d64c11
update formatting
Jan 10, 2024
4dcf9af
update formatting
Jan 11, 2024
6492b3a
update documentation
Jan 11, 2024
88e0fb5
update documentation
Jan 12, 2024
bb2ba86
update documentation
Jan 12, 2024
6725bf4
update documentation
Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,13 @@ import * as BLUIThemes from '@brightlayer-ui/react-native-themes';

> When using either of these themes, you should use our React Native Paper wrapper components (see below).

### React Native Paper Wrapper Components
### React Native Paper Components Style Override

The default theme structure for React Native Paper components does not offer us enough control to make some components look exactly the way they should for Brightlayer UI applications. Because of this, we have extended the default theme type definition (see below) and created wrapper components with the correct styles to use in place of some of the standard React Native Paper components.
This Document contains a set of style overrides in components around various [React Native Paper](https://callstack.github.io/react-native-paper/index.html) components.

In order for these components to look correct in your application, you should use the [Brightlayer UI wrapper components](https://github.com/etn-ccis/blui-react-native-component-library/blob/master/components/src/themed/README.md) in place of the respective components from React Native Paper.
By default, the theming mechanism provided by RNP is very minimal and does not allow us to style components precisely the way we want for Brightlayer UI applications. The theme does not cover all cases to circumvent this issue, for some components the end user may need to add extra styles or theme overrides inline that can be used to bring them in alignment with Brightlayer UI applications

In order to style components listed in the document to look correct in your application, the end user should use the [Brightlayer UI Components Style Override](https://github.com/etn-ccis/blui-react-native-themes/blob/master/RNPComponents/RNPComponents.md) in place of the respective components from React Native Paper.
ArshdeepSingh3-eaton marked this conversation as resolved.
Show resolved Hide resolved

### TypeScript

Expand Down
10 changes: 2 additions & 8 deletions RNPComponents/RNPComponents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# React Native Paper Component Templates
## React Native Paper Component Style Overrides

This Document contains a set of style overrides in components around various [React Native Paper](https://callstack.github.io/react-native-paper/index.html) components.

By default, the theming mechanism provided by RNP is very minimal and does not allow us to style components precisely the way we want for Brightlayer UI applications. To circumvent this issue, we create styles override components that the end user can use to bring them in alignment with Brightlayer UI applications

These styles override components will simplify this process so that the end user does not create the component designs to bring them in alignment with Brightlayer UI applications.

## Component Template
These styles override components will simplify this process so that the end user does not create the component designs to bring them in alignment with Brightlayer UI applications.

- ### Avatar

Expand Down