Skip to content

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

TypeScript

docs(core): document Banner's defaultIsExpanded prop (#3208)

Durvesh Pilankaraa395fcd1d19
diff --git a/.changeset/banner-defaultisexpanded-doc.md b/.changeset/banner-defaultisexpanded-doc.md
new file mode 100644
index 0000000000..5dd92dff79
--- /dev/null
+++ b/.changeset/banner-defaultisexpanded-doc.md
@@ -0,0 +1,6 @@
+---
+'@astryxdesign/core': patch
+---
+
+[docs] Document Banner's `defaultIsExpanded` prop, which controls whether the collapsible content area starts expanded but was missing from the docsite properties tab
+@durvesh1992
diff --git a/packages/core/src/Banner/Banner.doc.mjs b/packages/core/src/Banner/Banner.doc.mjs
index b7f9ae2e36..0152e57ae0 100644
--- a/packages/core/src/Banner/Banner.doc.mjs
+++ b/packages/core/src/Banner/Banner.doc.mjs
@@ -87,6 +87,13 @@ export const docs = {
description:
'Content rendered in the card-background area below the colored header.',
},
+ {
+ name: 'defaultIsExpanded',
+ type: 'boolean',
+ description:
+ 'Whether the content area (children) starts expanded. Only relevant when children are provided.',
+ default: 'false',
+ },
{
name: 'xstyle',
type: 'StyleXStyles',
@@ -150,6 +157,7 @@ export const docsZh = {
{name: 'endContent', type: 'ReactNode', description: '渲染在头部区域末端对齐的操作内容,通常是按钮或链接。'},
{name: 'container', type: "'card' | 'section'", description: '视觉变体:card 带圆角;section 无圆角全宽,适用于页面级场景。', default: "'card'"},
{name: 'children', type: 'ReactNode', description: '渲染在彩色头部下方卡片背景区域的内容。'},
+ {name: 'defaultIsExpanded', type: 'boolean', description: '内容区域(children)是否初始展开。仅在提供 children 时相关。', default: 'false'},
{
name: 'xstyle',
type: 'StyleXStyles',