Skip to content

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

TypeScript

fix(templates): open selector showcases by default (#1718)

Cindy Zhange55c9edd1e8c
diff --git a/packages/cli/templates/blocks/components/MultiSelector/MultiSelectorShowcase.doc.mjs b/packages/cli/templates/blocks/components/MultiSelector/MultiSelectorShowcase.doc.mjs
index 70849caf84..3db6fcbc5e 100644
--- a/packages/cli/templates/blocks/components/MultiSelector/MultiSelectorShowcase.doc.mjs
+++ b/packages/cli/templates/blocks/components/MultiSelector/MultiSelectorShowcase.doc.mjs
@@ -5,4 +5,5 @@ export const doc = {
isReady: true,
aspectRatio: 1,
isShowcase: true,
+ componentsUsed: ['MultiSelector'],
};
diff --git a/packages/cli/templates/blocks/components/MultiSelector/MultiSelectorShowcase.tsx b/packages/cli/templates/blocks/components/MultiSelector/MultiSelectorShowcase.tsx
index 8e565373f3..3a3d081de8 100644
--- a/packages/cli/templates/blocks/components/MultiSelector/MultiSelectorShowcase.tsx
+++ b/packages/cli/templates/blocks/components/MultiSelector/MultiSelectorShowcase.tsx
@@ -5,6 +5,7 @@ export default function MultiSelectorShowcase() {
<div style={{width: 300}}>
<XDSMultiSelector
label="Columns"
+ isDefaultOpen
options={['Name', 'Email', 'Role', 'Status', 'Created']}
value={[]}
onChange={() => {}}
diff --git a/packages/cli/templates/blocks/components/Selector/SelectorShowcase.doc.mjs b/packages/cli/templates/blocks/components/Selector/SelectorShowcase.doc.mjs
index 2fe94cf79f..82016dbb47 100644
--- a/packages/cli/templates/blocks/components/Selector/SelectorShowcase.doc.mjs
+++ b/packages/cli/templates/blocks/components/Selector/SelectorShowcase.doc.mjs
@@ -5,4 +5,5 @@ export const doc = {
isReady: true,
aspectRatio: 1,
isShowcase: true,
+ componentsUsed: ['Selector'],
};
diff --git a/packages/cli/templates/blocks/components/Selector/SelectorShowcase.tsx b/packages/cli/templates/blocks/components/Selector/SelectorShowcase.tsx
index d6de335358..e0b2f29af8 100644
--- a/packages/cli/templates/blocks/components/Selector/SelectorShowcase.tsx
+++ b/packages/cli/templates/blocks/components/Selector/SelectorShowcase.tsx
@@ -6,6 +6,7 @@ export default function SelectorShowcase() {
return (
<XDSSelector
label="Fruit"
+ isDefaultOpen
options={['Apple', 'Banana', 'Orange', 'Mango', 'Pineapple']}
placeholder="Select a fruit..."
onChange={() => {}}
diff --git a/packages/core/src/MultiSelector/XDSMultiSelector.tsx b/packages/core/src/MultiSelector/XDSMultiSelector.tsx
index fb89827dad..3e41a69040 100644
--- a/packages/core/src/MultiSelector/XDSMultiSelector.tsx
+++ b/packages/core/src/MultiSelector/XDSMultiSelector.tsx
@@ -13,6 +13,7 @@
import React, {
useCallback,
+ useEffect,
useId,
useMemo,
useOptimistic,
@@ -490,6 +491,13 @@ export interface XDSMultiSelectorProps<
*/
children?: (option: XDSMultiSelectorOptionData) => ReactNode;
+ /**
+ * Whether the dropdown starts open on mount.
+ * Useful for showcases and previews.
+ * @default false
+ */
+ isDefaultOpen?: boolean;
+
/**
* Test ID for testing frameworks.
*/
@@ -535,6 +543,7 @@ export function XDSMultiSelector<T extends XDSMultiSelectorOptionType>({
triggerDisplay = 'count',
maxBadges = 3,
children,
+ isDefaultOpen = false,
'data-testid': testId,
xstyle,
className,
@@ -664,6 +673,13 @@ export function XDSMultiSelector<T extends XDSMultiSelectorOptionType>({
dialogLabel: `${label} options`,
});
+ // Open dropdown on mount when isDefaultOpen is true
+ useEffect(() => {
+ if (isDefaultOpen) {
+ popover.show();
+ }
+ }, []);
+
// Handle toggle
// Handle clear button click
const handleClear = useCallback(
diff --git a/packages/core/src/Selector/XDSSelector.tsx b/packages/core/src/Selector/XDSSelector.tsx
index 98d08874ce..be571cf7a8 100644
--- a/packages/core/src/Selector/XDSSelector.tsx
+++ b/packages/core/src/Selector/XDSSelector.tsx
@@ -13,6 +13,7 @@
import React, {
useCallback,
+ useEffect,
useId,
useMemo,
useOptimistic,
@@ -375,6 +376,13 @@ interface XDSSelectorPropsBase<
*/
children?: (option: XDSSelectorOptionData) => ReactNode;
+ /**
+ * Whether the dropdown starts open on mount.
+ * Useful for showcases and previews.
+ * @default false
+ */
+ isDefaultOpen?: boolean;
+
/**
* Test ID for testing frameworks.
*/
@@ -459,6 +467,7 @@ export function XDSSelector<T extends XDSSelectorOptionType>(
status,
labelTooltip,
children,
+ isDefaultOpen = false,
'data-testid': testId,
xstyle,
className,
@@ -522,6 +531,13 @@ export function XDSSelector<T extends XDSSelectorOptionType>(
hasAutoFocus: false,
});
+ // Open dropdown on mount when isDefaultOpen is true
+ useEffect(() => {
+ if (isDefaultOpen) {
+ popover.show();
+ }
+ }, []);
+
// Calculate offset to position selected item over trigger
const {offset: selectedItemOffset, isPositioned} = useSelectedItemOffset({
isOpen: popover.isOpen,