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

Jump to bottom

Mobile: Update the readme for the new Nav Bar component #34751

Merged
merged 2 commits into from
Sep 20, 2021
Merged

Mobile: Update the readme for the new Nav Bar component #34751

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0dd91f7
Update the readme for the new Nav Bar component
enejb Sep 10, 2021
14bf477
Update Title => Heading
enejb Sep 10, 2021
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
14 changes: 8 additions & 6 deletions packages/components/src/mobile/bottom-sheet/nav-bar/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BottomSheet Header
# BottomSheet NavBar

BottomSheet Header components provide styled elements for composing header UI within a `BottomSheet`.
BottomSheet NavBar components provide styled elements for composing a NavBar UI within a `BottomSheet`. It makes several other components available, which can then be used to compose the NavBar's content.

## Usage

Expand All @@ -11,7 +11,7 @@ export default = () => (
<BottomSheet>
<BottomSheet.NavBar>
<BottomSheet.NavBar.BackButton onPress={ () => {} } />
<BottomSheet.NavBar.Title>A Sheet Title</BottomSheet.NavBar.Title>
<BottomSheet.NavBar.Heading>A Sheet Title</BottomSheet.NavBar.Heading>
<BottomSheet.NavBar.ApplyButton onPress={ () => {} } />
</BottomSheet.NavBar>
</BottomSheet>
Expand All @@ -22,7 +22,7 @@ export default = () => (

Provides structural styles for left-center-right layout for header UI.

## BottomSheet.NavBar.Title
## BottomSheet.NavBar.Heading

Displays a styled title for a bottom sheet.

Expand All @@ -39,6 +39,7 @@ Callback invoked once the button is pressed.
## BottomSheet.NavBar.BackButton

Displays a styled button to navigate backwards from a bottom sheet.
Note that the backwards navigation needs to be implemented in the callback that is passed in onPress.

### Props

Expand All @@ -48,7 +49,8 @@ Callback invoked once the button is pressed.

## BottomSheet.NavBar.DismissButton

Displays a styled button to dismiss a full screen bottom sheet.
Displays a styled button to dismiss the bottom sheet screen.
Note that the bottomSheet dismissal needs to be implemented in the callback that is passed in onPress.

### Props

Expand All @@ -58,4 +60,4 @@ Callback invoked once the button is pressed.

#### iosText

Used to display iOS text if different from "Cancel".
Used to display iOS text if different from "Cancel".