Skip to content

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

TypeScript

docs(LayoutPanel): the JSDoc example wraps its Layout in a Card (#10716)

Cindy Zhang50d20be92818
diff --git a/.changeset/layoutpanel-example-card.md b/.changeset/layoutpanel-example-card.md
new file mode 100644
index 0000000000..24395057b0
--- /dev/null
+++ b/.changeset/layoutpanel-example-card.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/core': patch
+---
+
+[docs] `LayoutPanel`'s JSDoc example wraps its Layout in a `Card` instead of `LayoutContainer`, a component Astryx does not have.
+
+@cixzhang
diff --git a/packages/core/src/Layout/LayoutPanel.tsx b/packages/core/src/Layout/LayoutPanel.tsx
index 3ff85d91ee..3e1b733209 100644
--- a/packages/core/src/Layout/LayoutPanel.tsx
+++ b/packages/core/src/Layout/LayoutPanel.tsx
@@ -214,7 +214,7 @@ export interface LayoutPanelProps extends BaseProps<HTMLDivElement> {
*
* @example
* ```
- * <LayoutContainer variant="card">
+ * <Card>
* <Layout
* start={
* <LayoutPanel hasDivider role="navigation">
@@ -228,7 +228,7 @@ export interface LayoutPanelProps extends BaseProps<HTMLDivElement> {
* </LayoutPanel>
* }
* />
- * </LayoutContainer>
+ * </Card>
* ```
*/
export function LayoutPanel({