Skip to content

Commit

Permalink
docs(dialog): fix typo (#803)
Browse files Browse the repository at this point in the history
  • Loading branch information
apollonian authored Jun 9, 2021
1 parent b4a5bbf commit 1f2d2ee
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion packages/dialog/src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ interface DialogOverlayProps extends DialogProps {
dangerouslyBypassFocusLock?: boolean;
/**
* By default the dialog locks scrolling with `react-remove-scroll`, which
* also injecs some styles on the body element to remove the scrollbar while
* also injects some styles on the body element to remove the scrollbar while
* maintaining its gap to prevent jank when the dialog's open state is
* toggled. This is almost always what you want in a dialog, but in some cases
* you may have the need to customize this behavior further.
Expand Down
2 changes: 1 addition & 1 deletion website/src/pages/dialog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ function DialogWithCustomFocusLock() {
`dangerouslyBypassScrollLock?: boolean`
By default the dialog locks scrolling with [`react-remove-scroll`](https://github.com/theKashey/react-remove-scroll), which also injecs some styles on the body element to remove the scrollbar while maintaining its gap to prevent jank when the dialog's open state is toggled. This is almost always what you want in a dialog, but in some cases you may have the need to customize this behavior further.
By default the dialog locks scrolling with [`react-remove-scroll`](https://github.com/theKashey/react-remove-scroll), which also injects some styles on the body element to remove the scrollbar while maintaining its gap to prevent jank when the dialog's open state is toggled. This is almost always what you want in a dialog, but in some cases you may have the need to customize this behavior further.
This prop will disable `react-remove-scroll` and allow you to compose your own scroll lock component to meet your needs. Like the `dangerouslyBypassFocusLock` prop, this is generally discouraged and should only be used if a proper fallback for managing scroll behavior is provided.
Expand Down

0 comments on commit 1f2d2ee

Please sign in to comment.