Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

docs(core): Layout's fill height needs a container with a set height (#10348)

Joey1f88264eca5d
diff --git a/.changeset/layout-fill-needs-height.md b/.changeset/layout-fill-needs-height.md
new file mode 100644
index 0000000000..3c459d0afd
--- /dev/null
+++ b/.changeset/layout-fill-needs-height.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/core': patch
+---
+
+[docs] Layout's `height` prop says that `fill` needs a container with a set height, such as AppShell's content area.
+
+@josephfarina
diff --git a/packages/core/src/Layout/Layout.doc.mjs b/packages/core/src/Layout/Layout.doc.mjs
index c363958788..7fc6484c34 100644
--- a/packages/core/src/Layout/Layout.doc.mjs
+++ b/packages/core/src/Layout/Layout.doc.mjs
@@ -128,7 +128,8 @@ export const docs = {
{
name: 'height',
type: "'fill' | 'auto'",
- description: 'Height behavior: fill the container or grow with content.',
+ description:
+ "Height behavior: fill the container's height or grow with content. Fill needs a container with a set height, such as AppShell's content area; under an app root with no height, the layout grows with its content.",
default: "'fill'",
},
{