Skip to content

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

TypeScript

docs(docsite): add vertical ToggleButtonGroup example (#2707) (#3444)

AKf33053940b79
diff --git a/.changeset/togglebuttongroup-add-a-vertical-example-block-s-bo8n.md b/.changeset/togglebuttongroup-add-a-vertical-example-block-s-bo8n.md
new file mode 100644
index 0000000000..380c7f077f
--- /dev/null
+++ b/.changeset/togglebuttongroup-add-a-vertical-example-block-s-bo8n.md
@@ -0,0 +1,6 @@
+---
+'@astryxdesign/cli': patch
+---
+
+[docs] ToggleButtonGroup: add a vertical example block showing orientation="vertical" with single- and multi-select groups (#2707)
+@AKnassa
diff --git a/apps/docsite/src/__tests__/data-extraction.test.ts b/apps/docsite/src/__tests__/data-extraction.test.ts
index 2577ffdda1..8384f8b0c8 100644
--- a/apps/docsite/src/__tests__/data-extraction.test.ts
+++ b/apps/docsite/src/__tests__/data-extraction.test.ts
@@ -921,3 +921,32 @@ describe('Card playground defaults', () => {
expect(typeof defaults!.children).toBe('object');
});
});
+
+// ── Vertical ToggleButtonGroup example (#2707) ─────────────────────────────
+// ToggleButtonGroup supports orientation="vertical", but no docsite example
+// demonstrated it — the prop was undiscoverable without reading the API
+// table. A dedicated vertical example block must exist and actually use the
+// vertical orientation.
+describe('ToggleButtonGroup vertical example', () => {
+ it('discovers the ToggleButtonGroupVertical block', () => {
+ const block = blocks.find(b => b.dirName === 'ToggleButtonGroupVertical');
+ expect(block).toBeDefined();
+ expect(block!.exampleFor).toBe('ToggleButtonGroup');
+ expect(block!.isShowcase).toBe(false);
+ expect(block!.name).toBe('ToggleButtonGroup — Vertical');
+ });
+
+ it('registers it among the ToggleButtonGroup examples', () => {
+ const examples = exampleRegistry['ToggleButtonGroup'] ?? [];
+ const vertical = examples.find(e => /Vertical/i.test(e.name));
+ expect(vertical).toBeDefined();
+ expect(vertical!.source).toContain('orientation="vertical"');
+ });
+
+ it('demonstrates both single-select and multi-select stacks', () => {
+ const examples = exampleRegistry['ToggleButtonGroup'] ?? [];
+ const vertical = examples.find(e => /Vertical/i.test(e.name));
+ expect(vertical).toBeDefined();
+ expect(vertical!.source).toContain('type="multiple"');
+ });
+});
diff --git a/packages/cli/templates/blocks/components/ToggleButtonGroup/ToggleButtonGroupVertical.doc.mjs b/packages/cli/templates/blocks/components/ToggleButtonGroup/ToggleButtonGroupVertical.doc.mjs
new file mode 100644
index 0000000000..e48118705c
--- /dev/null
+++ b/packages/cli/templates/blocks/components/ToggleButtonGroup/ToggleButtonGroupVertical.doc.mjs
@@ -0,0 +1,14 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/** @type {import('../../../../../core/src/docs-types').TemplateDoc} */
+export const doc = {
+ type: 'block',
+ exampleFor: 'ToggleButtonGroup',
+ name: 'ToggleButtonGroup — Vertical',
+ displayName: 'ToggleButtonGroup — Vertical',
+ description:
+ 'A vertically stacked ToggleButtonGroup using the vertical orientation, shown with both single-select and multi-select behavior — ideal for sidebar-style option lists and vertical toolbars.',
+ isReady: true,
+ aspectRatio: 3 / 4,
+ componentsUsed: ['ToggleButton', 'ToggleButtonGroup', 'Layout', 'Text'],
+};
diff --git a/packages/cli/templates/blocks/components/ToggleButtonGroup/ToggleButtonGroupVertical.tsx b/packages/cli/templates/blocks/components/ToggleButtonGroup/ToggleButtonGroupVertical.tsx
new file mode 100644
index 0000000000..dc5e469c10
--- /dev/null
+++ b/packages/cli/templates/blocks/components/ToggleButtonGroup/ToggleButtonGroupVertical.tsx
@@ -0,0 +1,47 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+'use client';
+
+import {useState} from 'react';
+import {ToggleButton, ToggleButtonGroup} from '@astryxdesign/core/ToggleButton';
+import {VStack} from '@astryxdesign/core/Layout';
+import {Text} from '@astryxdesign/core/Text';
+
+export default function ToggleButtonGroupVertical() {
+ const [view, setView] = useState<string | null>('grid');
+ const [filters, setFilters] = useState<string[]>(['active']);
+
+ return (
+ <VStack gap={4}>
+ <VStack gap={1}>
+ <Text type="label" color="secondary">
+ Single select
+ </Text>
+ <ToggleButtonGroup
+ orientation="vertical"
+ value={view}
+ onChange={setView}
+ label="View mode">
+ <ToggleButton value="list" label="List" />
+ <ToggleButton value="grid" label="Grid" />
+ <ToggleButton value="board" label="Board" />
+ </ToggleButtonGroup>
+ </VStack>
+ <VStack gap={1}>
+ <Text type="label" color="secondary">
+ Multi select
+ </Text>
+ <ToggleButtonGroup
+ orientation="vertical"
+ type="multiple"
+ value={filters}
+ onChange={setFilters}
+ label="Status filters">
+ <ToggleButton value="active" label="Active" />
+ <ToggleButton value="pending" label="Pending" />
+ <ToggleButton value="closed" label="Closed" />
+ </ToggleButtonGroup>
+ </VStack>
+ </VStack>
+ );
+}