From 5f123d285ae6ce3f456735c3f6069957d55bce9c Mon Sep 17 00:00:00 2001 From: Josep Martins Date: Mon, 8 Aug 2022 10:57:41 +0200 Subject: [PATCH 1/3] Add/remove missing/nonexsiting props --- docs/content/Overlay.mdx | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/docs/content/Overlay.mdx b/docs/content/Overlay.mdx index 2d7dbba946c..90a912e9dd0 100644 --- a/docs/content/Overlay.mdx +++ b/docs/content/Overlay.mdx @@ -72,23 +72,13 @@ See the W3C accessibility recommendations for modals [here](https://www.w3.org/T ## Positioning -`Overlay` renders its `children` within a div positioned absolutely within a portal within the default portal root. The overlay will not update its positioning if the portal root's positioning changes (e.g., if the portal root is statically positioned after some DOM element that dynamically resizes). You may consider [customizing the portal or specifying a different portal root](/Portal#customizing-the-portal-root) to achieve different positioning behavior. +`Overlay` renders its `children` within a div positioned absolutely within a portal within the default portal root. The overlay will not update its positioning if the portal root's positioning changes (e.g., if the portal root is statically positioned after some DOM element that dynamically resizes). You may consider using the [AnchoredOverlay](/AnchoredOverlay) component or [customizing the portal root](/Portal#customizing-the-portal-root) to achieve different positioning behavior. ## Props ### Overlay - - Element the Overlay should be anchored to. - - } - /> } /> + + Sets the maximum height of the Overlay, pick from our set list of heights. + xsmall corresponds to 192px, small corresponds + to 256px, medium corresponds to 320px,{' '} + large corresponds to 432px, xlarge corresponds + to 600px. + + } + /> Date: Mon, 8 Aug 2022 10:58:22 +0200 Subject: [PATCH 2/3] Add AnchoredOverlay in the navigation --- docs/src/@primer/gatsby-theme-doctocat/nav.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/@primer/gatsby-theme-doctocat/nav.yml b/docs/src/@primer/gatsby-theme-doctocat/nav.yml index a5d0f6c2dbf..5e965fbe9c1 100644 --- a/docs/src/@primer/gatsby-theme-doctocat/nav.yml +++ b/docs/src/@primer/gatsby-theme-doctocat/nav.yml @@ -38,6 +38,8 @@ url: /ActionList - title: ActionMenu url: /ActionMenu + - title: AnchoredOverlay + url: /AnchoredOverlay - title: Autocomplete url: /Autocomplete - title: Avatar From 6b0e19a7f3bc55a601e28c0e86aa34ad4043bb1f Mon Sep 17 00:00:00 2001 From: Josep Martins Date: Mon, 8 Aug 2022 11:14:07 +0200 Subject: [PATCH 3/3] Add wicked-otters-warn changeset --- .changeset/wicked-otters-warn.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/wicked-otters-warn.md diff --git a/.changeset/wicked-otters-warn.md b/.changeset/wicked-otters-warn.md new file mode 100644 index 00000000000..43cede4e2f1 --- /dev/null +++ b/.changeset/wicked-otters-warn.md @@ -0,0 +1,5 @@ +--- +'@primer/react': patch +--- + +Overlay documentation fixes