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

Fix NavigableRegion README #45879

Merged
merged 2 commits into from
Nov 18, 2022
Merged

Fix NavigableRegion README #45879

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d046b8
Fix NavigableRegion README
youknowriad Nov 18, 2022
91a2456
typo
youknowriad Nov 18, 2022
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
12 changes: 5 additions & 7 deletions packages/interface/src/components/navigable-region/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

It also renders a child `div` element that is responsible to set a negative `z-index` stack level, to make sure the focus style is always visible, regardless of other elements that may cut-off the focus style outline otherwise.

It can use a CSS animation via the `motion` component.

## Props

### children
Expand All @@ -29,10 +27,10 @@ A meaningful name for the ARIA landmark region.
- Type: `String`
- Required: Yes

### motionProps
### as

Properties of `motionProps` object will be used by the `motion` component to set a CSS animation on the wrapper div.
The component used as the root of the region. Defaults to a `div` element.

- Type: `Object`
- Required: No
- Default: `{}`
- Type: `Component`
- Required: no
- Default: `div`