Skip to content

Commit

Permalink
Fix Popper documentation consistency (#2197)
Browse files Browse the repository at this point in the history
  • Loading branch information
ncovercash authored Jan 5, 2024
1 parent cafbd45 commit 2237df6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 2 additions & 0 deletions lib/Popper/Popper.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ export const AVAILABLE_PLACEMENTS = [
'right-start',
'right-end',
'auto',
'auto-start',
'auto-end',
];

const [DEFAULT_PLACEMENT] = AVAILABLE_PLACEMENTS;
Expand Down
5 changes: 4 additions & 1 deletion lib/Popper/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,7 @@ placement | string | Overlay placement. Available values: `auto`, `top`, `bottom
portal | node | When is provided, overlay renders inside provided portal. | | |
anchorRef | object | Reference to anchor element | | yes |
children | component | Component to be passed as an overlay | | yes |
modifiers | object | A set of modifications for extending popper functionality. For more details, please, go to https://popper.js.org/popper-documentation.html#modifiers. | | |
modifiers | object | A set of modifications for extending popper functionality. For more details, please, [see the Popper.js docs](https://popper.js.org/docs/v1/#modifiers). | | |
hideIfClosed | boolean | Hides the overlay if the popper is closed (via `display: none`), rather than removing it from the DOM entirely | false | |
overlayProps | object | Props to add to the `<div>` used as the overlay | `{}` | |
overlayRef | ref | Grabs a reference for the overlay `<div>` | | |

0 comments on commit 2237df6

Please sign in to comment.