Merge pull request #80 from etn-ccis/feature/blui-5037-RNPdocumentation

added documentation for components
etn-ccis · Jan 12, 2024 · be6dd27 · be6dd27
2 parents b9824ee + 6725bf4
commit be6dd27
Show file tree

Hide file tree

Showing 16 changed files with 481 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -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, you may need to add extra styles or theme overrides inline that can be used to bring them in alignment with Brightlayer UI applications
+
+To style components listed in the document to look correct in the application, you 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.
 
 ### TypeScript
 

diff --git a/RNPComponents/Images/avatar.png b/RNPComponents/Images/avatar.png
diff --git a/RNPComponents/Images/bottomNavigation.png b/RNPComponents/Images/bottomNavigation.png
diff --git a/RNPComponents/Images/buttonContained.png b/RNPComponents/Images/buttonContained.png
diff --git a/RNPComponents/Images/buttonElevated.png b/RNPComponents/Images/buttonElevated.png
diff --git a/RNPComponents/Images/buttonOutline.png b/RNPComponents/Images/buttonOutline.png
diff --git a/RNPComponents/Images/buttonText.png b/RNPComponents/Images/buttonText.png
diff --git a/RNPComponents/Images/buttonTonal.png b/RNPComponents/Images/buttonTonal.png
diff --git a/RNPComponents/Images/dataTable.png b/RNPComponents/Images/dataTable.png
diff --git a/RNPComponents/Images/flatTextInput.png b/RNPComponents/Images/flatTextInput.png
diff --git a/RNPComponents/Images/iconButton.png b/RNPComponents/Images/iconButton.png
diff --git a/RNPComponents/Images/outlineTextInput.png b/RNPComponents/Images/outlineTextInput.png
diff --git a/RNPComponents/Images/progressBar.png b/RNPComponents/Images/progressBar.png
diff --git a/RNPComponents/Images/snackbar.png b/RNPComponents/Images/snackbar.png
diff --git a/RNPComponents/Images/toggleButton.png b/RNPComponents/Images/toggleButton.png