From 6117622ec55e91d862546e35cc4158fa18def8cb Mon Sep 17 00:00:00 2001 From: Cole Bemis Date: Thu, 23 Jun 2022 16:51:26 -0700 Subject: [PATCH 1/4] Draft SplitPageLayout API docs --- docs/content/SplitPageLayout.mdx | 313 +++++++++++++++++++++++++++++++ 1 file changed, 313 insertions(+) create mode 100644 docs/content/SplitPageLayout.mdx diff --git a/docs/content/SplitPageLayout.mdx b/docs/content/SplitPageLayout.mdx new file mode 100644 index 00000000000..e686fa4f50e --- /dev/null +++ b/docs/content/SplitPageLayout.mdx @@ -0,0 +1,313 @@ +--- +title: SplitPageLayout +componentId: split_page_layout +status: Draft +# description: TODO +--- + +Not implemented yet + +## Examples + +### Default + +```jsx + + + + + + + + + + + + + + +``` + +### With pane hidden on narrow viewports + +```jsx + + + + + + + + + + + + + + +``` + +### With content hidden on narrow viewports + +```jsx + + + + + + + + + + + + + + +``` + +### Without dividers + +```jsx + + + + + + + + + + + + + + +``` + +### With pane on right + +```jsx + + + + + + + + + + + + + + +``` + +### Without padding + +```jsx + + + + + + + + + + + + + + +``` + +### Without header or footer + +```jsx + + + + + + + + +``` + +### With non-sticky pane + +```jsx + + + + + + + + + + + + + + +``` + +## Props + +### SplitPageLayout + + + + + +### SplitPageLayout.Header + + + `} + defaultValue="'line'" + /> + `} + defaultValue="true" + description="Whether the header is visible." + /> + + + + +### SplitPageLayout.Content + + + + `} + defaultValue="true" + description="Whether the content is visible." + /> + + + + +### SplitPageLayout.Pane + + + `} + defaultValue="'start'" + /> + + `} + defaultValue="'line'" + /> + `} + defaultValue="true" + description="Whether the pane is visible." + /> + + + + +### SplitPageLayout.Footer + + + `} + defaultValue="'line'" + /> + `} + defaultValue="true" + description="Whether the footer is visible." + /> + + + + +## Status + + From a9c735322cdd77d12d43daa87538c5e99770674e Mon Sep 17 00:00:00 2001 From: Cole Bemis Date: Thu, 23 Jun 2022 18:06:04 -0700 Subject: [PATCH 2/4] Update docs/content/SplitPageLayout.mdx Co-authored-by: Vinicius Depizzol --- docs/content/SplitPageLayout.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/SplitPageLayout.mdx b/docs/content/SplitPageLayout.mdx index e686fa4f50e..7a351b09474 100644 --- a/docs/content/SplitPageLayout.mdx +++ b/docs/content/SplitPageLayout.mdx @@ -2,7 +2,7 @@ title: SplitPageLayout componentId: split_page_layout status: Draft -# description: TODO +description: Provides structure for a split page layout, providing independent scrolling for the pane and content regions. Useful for responsive list/detail patterns, when an item in the pane updates the page content on selection. --- Not implemented yet From 96edc7a04f1036915ae0d9038c22f38aa08e58fc Mon Sep 17 00:00:00 2001 From: Cole Bemis Date: Thu, 23 Jun 2022 18:06:28 -0700 Subject: [PATCH 3/4] Update docs/content/SplitPageLayout.mdx --- docs/content/SplitPageLayout.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/SplitPageLayout.mdx b/docs/content/SplitPageLayout.mdx index 7a351b09474..454805ddd32 100644 --- a/docs/content/SplitPageLayout.mdx +++ b/docs/content/SplitPageLayout.mdx @@ -2,7 +2,7 @@ title: SplitPageLayout componentId: split_page_layout status: Draft -description: Provides structure for a split page layout, providing independent scrolling for the pane and content regions. Useful for responsive list/detail patterns, when an item in the pane updates the page content on selection. +description: Provides structure for a split page layout, including independent scrolling for the pane and content regions. Useful for responsive list/detail patterns, when an item in the pane updates the page content on selection. --- Not implemented yet From 64d76df02ca2f1b10c4e1d89fe1518a5c6686cd3 Mon Sep 17 00:00:00 2001 From: Cole Bemis Date: Thu, 30 Jun 2022 10:31:26 -0700 Subject: [PATCH 4/4] visible -> hidden prop --- docs/content/SplitPageLayout.mdx | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/content/SplitPageLayout.mdx b/docs/content/SplitPageLayout.mdx index e686fa4f50e..ace576cf1d7 100644 --- a/docs/content/SplitPageLayout.mdx +++ b/docs/content/SplitPageLayout.mdx @@ -35,7 +35,7 @@ status: Draft - + @@ -57,7 +57,7 @@ status: Draft - + @@ -179,10 +179,10 @@ status: Draft defaultValue="'line'" /> `} - defaultValue="true" - description="Whether the header is visible." + defaultValue="false" + description="Whether the header is hidden." /> `} - defaultValue="true" - description="Whether the content is visible." + defaultValue="false" + description="Whether the content is hidden." /> `} - defaultValue="true" - description="Whether the pane is visible." + defaultValue="false" + description="Whether the pane is hidden." /> `} - defaultValue="true" - description="Whether the footer is visible." + defaultValue="false" + description="Whether the footer is hidden." />