Skip to content

The open alternative to Salesforce, designed for AI.

Complete UI documentation and presentational previews (#26791)

Raphaël Bosiece44c3d5541
diff --git a/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx b/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx
index 0d43d80d975..c1775280723 100644
--- a/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx
+++ b/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx
@@ -861,7 +861,7 @@ Import individual icons from `twenty-ui/icon`:
import { IconBox, IconCheck } from 'twenty-ui/icon';
```
-Each named icon is tree-shaken, so importing a handful adds little to your bundle. Avoid `IconsProvider`, `useIcons`, and `iconsState` — they pull in the full Tabler icon set (several MB).
+Each named icon is tree-shaken, so importing a handful adds little to your bundle. Avoid `IconsProvider` and `useIcons` in front components. Front components are bundled without code splitting, so the provider's dynamic icon catalog (the full Tabler set, roughly 2 MB minified) ends up in your bundle. See the [icon reference](/ui/icons) for available exports and supported props.
### Theming and theme tokens
diff --git a/packages/twenty-docs/docs.json b/packages/twenty-docs/docs.json
index 15c41c86bdd..288669c8e01 100644
--- a/packages/twenty-docs/docs.json
+++ b/packages/twenty-docs/docs.json
@@ -525,7 +525,9 @@
"ui/tokens",
"ui/dark-mode",
"ui/ssr",
- "ui/accessibility"
+ "ui/accessibility",
+ "ui/icons",
+ "ui/testing"
]
},
{
@@ -627,7 +629,23 @@
"ui/components/dropdown",
"ui/components/tab-button",
"ui/components/code-editor",
- "ui/components/toast"
+ "ui/components/toast",
+ "ui/components/animated-icon-crossfade",
+ "ui/components/avatar-group",
+ "ui/components/callout",
+ "ui/components/card-picker",
+ "ui/components/color-scheme-picker",
+ "ui/components/command-block",
+ "ui/components/info",
+ "ui/components/inline-banner",
+ "ui/components/json-tree",
+ "ui/components/menu-items",
+ "ui/components/menu-picker",
+ "ui/components/navigation-bar",
+ "ui/components/notification-counter",
+ "ui/components/rounded-link",
+ "ui/components/search-input",
+ "ui/components/tinted-icon-tile"
]
}
]
diff --git a/packages/twenty-docs/navigation/base-structure.json b/packages/twenty-docs/navigation/base-structure.json
index 2feb243561c..917ba6bfc8a 100644
--- a/packages/twenty-docs/navigation/base-structure.json
+++ b/packages/twenty-docs/navigation/base-structure.json
@@ -535,7 +535,9 @@
"ui/tokens",
"ui/dark-mode",
"ui/ssr",
- "ui/accessibility"
+ "ui/accessibility",
+ "ui/icons",
+ "ui/testing"
]
},
{
@@ -645,7 +647,23 @@
"ui/components/dropdown",
"ui/components/tab-button",
"ui/components/code-editor",
- "ui/components/toast"
+ "ui/components/toast",
+ "ui/components/animated-icon-crossfade",
+ "ui/components/avatar-group",
+ "ui/components/callout",
+ "ui/components/card-picker",
+ "ui/components/color-scheme-picker",
+ "ui/components/command-block",
+ "ui/components/info",
+ "ui/components/inline-banner",
+ "ui/components/json-tree",
+ "ui/components/menu-items",
+ "ui/components/menu-picker",
+ "ui/components/navigation-bar",
+ "ui/components/notification-counter",
+ "ui/components/rounded-link",
+ "ui/components/search-input",
+ "ui/components/tinted-icon-tile"
]
}
]
diff --git a/packages/twenty-docs/scripts/check-ui-story-embeds.mts b/packages/twenty-docs/scripts/check-ui-story-embeds.mts
index 08fe9f9dcf0..c29213da331 100644
--- a/packages/twenty-docs/scripts/check-ui-story-embeds.mts
+++ b/packages/twenty-docs/scripts/check-ui-story-embeds.mts
@@ -2,9 +2,10 @@ import { globSync, readFileSync } from 'node:fs';
import { resolve } from 'node:path';
import { fileURLToPath } from 'node:url';
-import { isNonEmptyString } from '@sniptt/guards';
+import { isNonEmptyString, isUndefined } from '@sniptt/guards';
import { checkStoryEmbeds } from './ui/check-story-embeds.mjs';
+import { checkStoryPresentation } from './ui/check-story-presentation.mjs';
const indexPath = process.argv[2];
@@ -12,22 +13,62 @@ if (!isNonEmptyString(indexPath)) {
throw new Error('Pass the path to the generated Storybook index.json.');
}
-const index: { entries: Record<string, { id: string; type: string }> } =
- JSON.parse(readFileSync(resolve(indexPath), 'utf8'));
+const index: {
+ entries: Record<
+ string,
+ {
+ id: string;
+ type: string;
+ tags?: string[];
+ importPath: string;
+ exportName: string;
+ }
+ >;
+} = JSON.parse(readFileSync(resolve(indexPath), 'utf8'));
const storyIds = new Set(
Object.values(index.entries)
.filter((entry) => entry.type === 'story')
.map((entry) => entry.id),
);
+const storiesWithPlayFunctions = new Set(
+ Object.values(index.entries)
+ .filter((entry) => entry.tags?.includes('play-fn'))
+ .map((entry) => entry.id),
+);
const documentationRoot = fileURLToPath(new URL('..', import.meta.url));
-const pages = globSync(
- ['ui/**/*.mdx', 'l/*/ui/**/*.mdx', 'snippets/ui/**/*.mdx'],
- { cwd: documentationRoot },
-).sort();
+const storyErrors = new Map<string, string[]>();
+const getPresentationErrors = (storyId: string): string[] => {
+ const cachedErrors = storyErrors.get(storyId);
+
+ if (!isUndefined(cachedErrors)) {
+ return cachedErrors;
+ }
+
+ const entry = index.entries[storyId];
+ const sourcePath = resolve(
+ documentationRoot,
+ '../twenty-ui',
+ entry.importPath,
+ );
+ const errors = checkStoryPresentation({
+ content: readFileSync(sourcePath, 'utf8'),
+ exportName: entry.exportName,
+ fileName: sourcePath,
+ });
+
+ storyErrors.set(storyId, errors);
+
+ return errors;
+};
+const pages = globSync(['ui/**/*.mdx', '*/ui/**/*.mdx', 'l/*/ui/**/*.mdx'], {
+ cwd: documentationRoot,
+}).sort();
const errors = pages.flatMap((page) =>
checkStoryEmbeds({
content: readFileSync(resolve(documentationRoot, page), 'utf8'),
storyIds,
+ storiesWithPlayFunctions,
+ getPresentationErrors,
}).map((error) => `${page}: ${error}`),
);
diff --git a/packages/twenty-docs/scripts/generate-ui-reference.ts b/packages/twenty-docs/scripts/generate-ui-reference.ts
index 233cdc419fb..01f67606d0e 100644
--- a/packages/twenty-docs/scripts/generate-ui-reference.ts
+++ b/packages/twenty-docs/scripts/generate-ui-reference.ts
@@ -7,6 +7,8 @@ import {
} from '../../twenty-ui/docs/types';
import { checkUiReferenceImports } from './ui/check-ui-reference-imports';
import { renderComponentReference } from './ui/render-component-reference';
+import { type IconDocumentationGroup } from '../../twenty-ui/docs/IconDocumentationGroup';
+import { renderIconReference } from './ui/render-icon-reference';
import { renderTokenReference } from './ui/render-ui-reference';
import { syncUiReferenceFiles } from './ui/sync-ui-reference-files';
@@ -32,12 +34,16 @@ const components: ComponentDocumentation[] = JSON.parse(
const tokens: TokenDocumentation[] = JSON.parse(
readFileSync(resolve(dataRoot, 'tokens.docs.json'), 'utf8'),
);
+const iconGroups: IconDocumentationGroup[] = JSON.parse(
+ readFileSync(resolve(dataRoot, 'icons.docs.json'), 'utf8'),
+);
const outputs = [
...components.map((component) => ({
name: `${component.slug}.mdx`,
content: renderComponentReference(component),
})),
{ name: 'tokens.mdx', content: renderTokenReference(tokens) },
+ { name: 'icon/catalog.mdx', content: renderIconReference(iconGroups) },
];
const syncErrors = syncUiReferenceFiles({
diff --git a/packages/twenty-docs/scripts/ui/__tests__/check-story-embeds.spec.ts b/packages/twenty-docs/scripts/ui/__tests__/check-story-embeds.spec.ts
index 6dfb65557f4..3721447bb01 100644
--- a/packages/twenty-docs/scripts/ui/__tests__/check-story-embeds.spec.ts
+++ b/packages/twenty-docs/scripts/ui/__tests__/check-story-embeds.spec.ts
@@ -5,6 +5,18 @@ import { checkStoryEmbeds } from '../check-story-embeds.mjs';
const storyIds = new Set(['ui-input-input--default']);
describe('checkStoryEmbeds', () => {
+ it('rejects interaction stories embedded in documentation', () => {
+ expect(
+ checkStoryEmbeds({
+ content: '<StoryEmbed storyId="ui-input-input--default" />',
+ storyIds,
+ storiesWithPlayFunctions: new Set(['ui-input-input--default']),
+ }),
+ ).toEqual([
+ 'Line 1: Storybook story "ui-input-input--default" has a play function. Documentation stories must be presentational.',
+ ]);
+ });
+
it('accepts an existing story inside a nested preview', () => {
expect(
checkStoryEmbeds({
diff --git a/packages/twenty-docs/scripts/ui/__tests__/check-story-presentation.spec.ts b/packages/twenty-docs/scripts/ui/__tests__/check-story-presentation.spec.ts
new file mode 100644
index 00000000000..7c51a203b1c
--- /dev/null
+++ b/packages/twenty-docs/scripts/ui/__tests__/check-story-presentation.spec.ts
@@ -0,0 +1,63 @@
+import { describe, expect, it } from 'vitest';
+
+import { checkStoryPresentation } from '../check-story-presentation.mjs';
+
+describe('documentation story presentation', () => {
+ it('accepts shared render and args without inheriting interaction tests', () => {
+ expect(
+ checkStoryPresentation({
+ content: `
+ const meta = { title: 'Preview' } satisfies Meta;
+ export default meta;
+ export const Interaction = { args: {}, render: () => null, play: async () => {} };
+ export const Documentation = { args: Interaction.args, render: Interaction.render };
+ `,
+ exportName: 'Documentation',
+ fileName: 'Preview.stories.tsx',
+ }),
+ ).toEqual([]);
+ });
+
+ it('parses TypeScript story files that use generic arrow functions', () => {
+ expect(
+ checkStoryPresentation({
+ content: `
+ const withDefaults = <TArgs>(args: TArgs) => args;
+ export const Documentation = { args: withDefaults({ label: 'Save' }) };
+ `,
+ exportName: 'Documentation',
+ fileName: 'Preview.stories.ts',
+ }),
+ ).toEqual([]);
+ });
+
+ it.each([
+ 'export default { play: async () => {} }; export const Documentation = {};',
+ 'const base = { play: async () => {} }; export const Documentation = { ...base };',
+ 'export const Documentation = { play: undefined };',
+ 'export const Documentation = {}; Documentation.play = async () => {};',
+ ])('rejects direct, inherited, or assigned play in %s', (content) => {
+ expect(
+ checkStoryPresentation({
+ content,
+ exportName: 'Documentation',
+ fileName: 'Preview.stories.tsx',
+ }),
+ ).toContain(
+ 'Documentation stories must not define or inherit a play function.',
+ );
+ });
+
+ it('reports imported spreads that cannot be checked locally', () => {
+ expect(
+ checkStoryPresentation({
+ content:
+ "import { base } from './base'; export const Documentation = { ...base };",
+ exportName: 'Documentation',
+ fileName: 'Preview.stories.tsx',
+ }),
+ ).toEqual([
+ 'Cannot verify the imported or unresolved story definition "base".',
+ ]);
+ });
+});
diff --git a/packages/twenty-docs/scripts/ui/__tests__/public-component-exports.spec.ts b/packages/twenty-docs/scripts/ui/__tests__/public-component-exports.spec.ts
new file mode 100644
index 00000000000..7360e673a6a
--- /dev/null
+++ b/packages/twenty-docs/scripts/ui/__tests__/public-component-exports.spec.ts
@@ -0,0 +1,94 @@
+import { mkdtempSync, rmSync, writeFileSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { isUndefined } from '@sniptt/guards';
+import ts from 'typescript';
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+
+import { getPublicComponentExports } from '../../../../twenty-ui/docs/getPublicComponentExports';
+
+describe('public component documentation coverage', () => {
+ let directory: string;
+
+ beforeEach(() => {
+ directory = mkdtempSync(join(tmpdir(), 'ui-component-exports-'));
+ });
+
+ afterEach(() => {
+ rmSync(directory, { recursive: true, force: true });
+ });
+
+ const createFixtureProgram = (files: Record<string, string>) => {
+ const filePaths = Object.entries(files).map(([fileName, content]) => {
+ const filePath = join(directory, fileName);
+
+ writeFileSync(filePath, content);
+
+ return filePath;
+ });
+ const program = ts.createProgram(filePaths, {
+ noLib: true,
+ types: [],
+ jsx: ts.JsxEmit.Preserve,
+ });
+ const getEntryPoint = (name: string, fileName: string) => {
+ const source = program.getSourceFile(join(directory, fileName));
+
+ if (isUndefined(source)) {
+ throw new Error(`Missing fixture entry point ${fileName}`);
+ }
+
+ return { name, source };
+ };
+
+ return { checker: program.getTypeChecker(), getEntryPoint };
+ };
+
+ it('finds aliased and compound components through barrels without counting types or constants', () => {
+ const { checker, getEntryPoint } = createFixtureProgram({
+ 'components.tsx': `
+ export const Button = () => null;
+ export const Menu = { Root: () => null };
+ export type ButtonProps = { disabled?: boolean };
+ export const BUTTON_SIZE = 24;
+ export const Internal = () => null;
+ `,
+ 'index.ts': `
+ export { Button as Action, Menu, BUTTON_SIZE } from './components';
+ export type { ButtonProps } from './components';
+ `,
+ });
+
+ expect(
+ getPublicComponentExports({
+ checker,
+ entryPoints: [getEntryPoint('twenty-ui/components', 'index.ts')],
+ })
+ .map(({ name }) => name)
+ .sort(),
+ ).toEqual(['Action', 'Menu']);
+ });
+
+ it('keeps every entry point exporting a component whatever their order', () => {
+ const { checker, getEntryPoint } = createFixtureProgram({
+ 'IconCheck.tsx': 'export const IconCheck = () => null;',
+ 'icon.ts': "export { IconCheck } from './IconCheck';",
+ 'index.ts': "export * from './icon';",
+ });
+ const rootEntryPoint = getEntryPoint('twenty-ui', 'index.ts');
+ const iconEntryPoint = getEntryPoint('twenty-ui/icon', 'icon.ts');
+ const getSortedEntryPoints = (
+ entryPoints: { name: string; source: ts.SourceFile }[],
+ ) =>
+ getPublicComponentExports({ checker, entryPoints }).map((component) =>
+ [...component.entryPoints].sort(),
+ );
+
+ expect(getSortedEntryPoints([rootEntryPoint, iconEntryPoint])).toEqual([
+ ['twenty-ui', 'twenty-ui/icon'],
+ ]);
+ expect(getSortedEntryPoints([iconEntryPoint, rootEntryPoint])).toEqual([
+ ['twenty-ui', 'twenty-ui/icon'],
+ ]);
+ });
+});
diff --git a/packages/twenty-docs/scripts/ui/check-story-embeds.mts b/packages/twenty-docs/scripts/ui/check-story-embeds.mts
index ece385664ad..bfd40a38755 100644
--- a/packages/twenty-docs/scripts/ui/check-story-embeds.mts
+++ b/packages/twenty-docs/scripts/ui/check-story-embeds.mts
@@ -6,9 +6,13 @@ import { visit } from 'unist-util-visit';
export const checkStoryEmbeds = ({
content,
storyIds,
+ storiesWithPlayFunctions = new Set<string>(),
+ getPresentationErrors = () => [],
}: {
content: string;
storyIds: Set<string>;
+ storiesWithPlayFunctions?: Set<string>;
+ getPresentationErrors?: (storyId: string) => string[];
}): string[] => {
const errors: string[] = [];
const tree = createProcessor({
@@ -66,6 +70,18 @@ export const checkStoryEmbeds = ({
if (!storyIds.has(value)) {
errors.push(`Line ${line}: Storybook story "${value}" does not exist.`);
+ return;
+ }
+
+ if (storiesWithPlayFunctions.has(value)) {
+ errors.push(
+ `Line ${line}: Storybook story "${value}" has a play function. Documentation stories must be presentational.`,
+ );
+ return;
+ }
+
+ for (const error of getPresentationErrors(value)) {
+ errors.push(`Line ${line}: Storybook story "${value}": ${error}`);
}
});
diff --git a/packages/twenty-docs/scripts/ui/check-story-presentation.mts b/packages/twenty-docs/scripts/ui/check-story-presentation.mts
new file mode 100644
index 00000000000..e9c7c5d20c9
--- /dev/null
+++ b/packages/twenty-docs/scripts/ui/check-story-presentation.mts
@@ -0,0 +1,137 @@
+import { isUndefined } from '@sniptt/guards';
+import ts from 'typescript';
+
+export const checkStoryPresentation = ({
+ content,
+ exportName,
+ fileName,
+}: {
+ content: string;
+ exportName: string;
+ fileName: string;
+}): string[] => {
+ const source = ts.createSourceFile(
+ fileName,
+ content,
+ ts.ScriptTarget.Latest,
+ true,
+ );
+ const declarations = new Map<string, ts.Expression>();
+ const errors = new Set<string>();
+ const visited = new Set<ts.Node>();
+ let meta: ts.Expression | undefined;
+
+ for (const statement of source.statements) {
+ if (ts.isVariableStatement(statement)) {
+ for (const declaration of statement.declarationList.declarations) {
+ if (
+ ts.isIdentifier(declaration.name) &&
+ !isUndefined(declaration.initializer)
+ ) {
+ declarations.set(declaration.name.text, declaration.initializer);
+ }
+ }
+ }
+
+ if (ts.isExportAssignment(statement) && !statement.isExportEquals) {
+ meta = statement.expression;
+ }
+ }
+
+ const inspect = (expression: ts.Expression): void => {
+ if (visited.has(expression)) {
+ return;
+ }
+
+ visited.add(expression);
+
+ if (
+ ts.isAsExpression(expression) ||
+ ts.isSatisfiesExpression(expression) ||
+ ts.isParenthesizedExpression(expression)
+ ) {
+ inspect(expression.expression);
+ return;
+ }
+
+ if (ts.isIdentifier(expression)) {
+ const initializer = declarations.get(expression.text);
+
+ if (isUndefined(initializer)) {
+ errors.add(
+ `Cannot verify the imported or unresolved story definition "${expression.text}".`,
+ );
+ return;
+ }
+
+ for (const statement of source.statements) {
+ if (
+ !ts.isExpressionStatement(statement) ||
+ !ts.isBinaryExpression(statement.expression)
+ ) {
+ continue;
+ }
+
+ const { left } = statement.expression;
+ const assignsPlay =
+ ts.isPropertyAccessExpression(left) &&
+ left.expression.getText(source) === expression.text &&
+ left.name.text === 'play';
+
+ if (assignsPlay) {
+ errors.add(
+ 'Documentation stories must not define or inherit a play function.',
+ );
+ }
+ }
+
+ inspect(initializer);
+ return;
+ }
+
+ if (!ts.isObjectLiteralExpression(expression)) {
+ errors.add(
+ 'Documentation stories must use statically verifiable object definitions.',
+ );
+ return;
+ }
+
+ for (const property of expression.properties) {
+ if (ts.isSpreadAssignment(property)) {
+ inspect(property.expression);
+ continue;
+ }
+
+ if (ts.isComputedPropertyName(property.name)) {
+ errors.add('Cannot verify computed story properties.');
+ continue;
+ }
+
+ const propertyName =
+ ts.isIdentifier(property.name) || ts.isStringLiteral(property.name)
+ ? property.name.text
+ : property.name.getText(source);
+
+ if (propertyName === 'play') {
+ errors.add(
+ 'Documentation stories must not define or inherit a play function.',
+ );
+ }
+ }
+ };
+
+ if (!isUndefined(meta)) {
+ inspect(meta);
+ }
+
+ const story = declarations.get(exportName);
+
+ if (isUndefined(story)) {
+ errors.add(`Cannot resolve the documentation story "${exportName}".`);
+ return [...errors];
+ }
+
+ inspect(ts.factory.createIdentifier(exportName));
+
+ return [...errors];
+};
diff --git a/packages/twenty-docs/scripts/ui/render-icon-reference.ts b/packages/twenty-docs/scripts/ui/render-icon-reference.ts
new file mode 100644
index 00000000000..1bd574e8daa
--- /dev/null
+++ b/packages/twenty-docs/scripts/ui/render-icon-reference.ts
@@ -0,0 +1,16 @@
+import { type IconDocumentationGroup } from '../../../twenty-ui/docs/IconDocumentationGroup';
+
+export const renderIconReference = (groups: IconDocumentationGroup[]): string =>
+ groups
+ .map((group) => {
+ const propList = group.props.map((prop) => `\`${prop}\``).join(', ');
+
+ return [
+ `### ${group.supportsSvgAttributes ? 'SVG icons' : propList}`,
+ '',
+ `Supported props: ${propList}.${group.supportsSvgAttributes ? ' Native SVG attributes and refs are also accepted.' : ' Other native attributes are not forwarded.'}`,
+ '',
+ group.names.map((name) => `- \`${name}\``).join('\n'),
+ ].join('\n');
+ })
+ .join('\n\n') + '\n';
diff --git a/packages/twenty-docs/snippets/ui/generated/components/animated-icon-crossfade.mdx b/packages/twenty-docs/snippets/ui/generated/components/animated-icon-crossfade.mdx
new file mode 100644
index 00000000000..0b1ef89d5b4
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/animated-icon-crossfade.mdx
@@ -0,0 +1,28 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="ActiveIcon" type="IconComponent" required>
+ Icon component for the active state.
+</ParamField>
+
+<ParamField body="InactiveIcon" type="IconComponent" required>
+ Icon component for the inactive state.
+</ParamField>
+
+<ParamField body="isActive" type="boolean" required>
+ Shows ActiveIcon when true and InactiveIcon otherwise.
+</ParamField>
+
+<ParamField body="size" type="number">
+ Icon dimension in pixels. Defaults to the small theme icon size.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/avatar-group.mdx b/packages/twenty-docs/snippets/ui/generated/components/avatar-group.mdx
new file mode 100644
index 00000000000..b8eeab9f57f
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/avatar-group.mdx
@@ -0,0 +1,44 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="avatars" type="ReactNode[]" required>
+ Avatar elements in display order. Only the first maxVisible elements are shown.
+</ParamField>
+
+<ParamField body="className" type="string">
+ Class applied to the group container.
+</ParamField>
+
+<ParamField body="maxVisible" type="number" default="4">
+ Maximum number of supplied avatars to show.
+</ParamField>
+
+<ParamField body="overflowAvatar" type="ReactNode">
+ Custom trailing element, used instead of the numeric overflow indicator.
+</ParamField>
+
+<ParamField body="overflowCount" type="number" default="0">
+ Number shown in the trailing +N indicator. Compute this in the application; it is not derived from avatars.
+</ParamField>
+
+<ParamField body="overflowShape" type="&quot;circle&quot; | &quot;rounded-square&quot; | &quot;square&quot;" default="square">
+ Shape of the numeric overflow indicator.
+</ParamField>
+
+<ParamField body="overlap" type="&quot;left&quot; | &quot;right&quot;" default="right">
+ Physical margin, left or right, that carries the negative overlap offset. Later avatars always render above earlier ones.
+</ParamField>
+
+<ParamField body="overlapOffset" type="string" default="3px">
+ CSS length of the overlap between avatars.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/callout.mdx b/packages/twenty-docs/snippets/ui/generated/components/callout.mdx
new file mode 100644
index 00000000000..fb695016df5
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/callout.mdx
@@ -0,0 +1,44 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="action" type="{ label: string; onClick: () =&gt; void; }">
+ Optional footer action with a label and onClick callback.
+</ParamField>
+
+<ParamField body="description" type="string">
+ Optional supporting text. Empty strings are hidden.
+</ParamField>
+
+<ParamField body="fullWidth" type="boolean" default="false">
+ Fills the available container width.
+</ParamField>
+
+<ParamField body="Icon" type="IconComponent">
+ Leading icon component. Defaults to the help icon.
+</ParamField>
+
+<ParamField body="isClosable" type="boolean" default="false">
+ Shows a close button that hides the callout until it is remounted.
+</ParamField>
+
+<ParamField body="onClose" type="(() =&gt; void)">
+ Called after the close button hides the callout.
+</ParamField>
+
+<ParamField body="title" type="string" required>
+ Main message displayed beside the icon.
+</ParamField>
+
+<ParamField body="variant" type="&quot;error&quot; | &quot;info&quot; | &quot;neutral&quot; | &quot;success&quot; | &quot;warning&quot;" required>
+ Semantic appearance: info, warning, error, neutral, or success.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/card-picker.mdx b/packages/twenty-docs/snippets/ui/generated/components/card-picker.mdx
new file mode 100644
index 00000000000..8c59acf4439
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/card-picker.mdx
@@ -0,0 +1,63 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="children" type="ReactNode">
+ Card content inside the radio control.
+</ParamField>
+
+<ParamField body="className" type="string | ((state: RadioRootState) =&gt; string | undefined)">
+ CSS class applied to the element, or a function that
+ returns a class based on the component's state.
+</ParamField>
+
+<ParamField body="disabled" type="boolean">
+ Whether the component should ignore user interaction.
+</ParamField>
+
+<ParamField body="inputRef" type="Ref&lt;HTMLInputElement&gt;">
+ A ref to access the hidden input element.
+</ParamField>
+
+<ParamField body="nativeButton" type="boolean" default="false">
+ Whether the component renders a native `<button>` element when replacing it
+ via the `render` prop.
+ Set to `true` if the rendered element is a native button.
+</ParamField>
+
+<ParamField body="readOnly" type="boolean">
+ Whether the user should be unable to select the radio button.
+</ParamField>
+
+<ParamField body="render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, RadioRootState&gt;">
+ Allows you to replace the component's HTML element
+ with a different tag, or compose it with another component.
+
+ Accepts a `ReactElement` or a function that returns the element to render.
+</ParamField>
+
+<ParamField body="required" type="boolean">
+ Whether the user must choose a value before submitting a form.
+</ParamField>
+
+<ParamField body="size" type="&quot;md&quot; | &quot;sm&quot;">
+ Visual size of the radio.
+</ParamField>
+
+<ParamField body="style" type="CSSProperties | ((state: RadioRootState) =&gt; CSSProperties | undefined)">
+ Style applied to the element, or a function that
+ returns a style object based on the component's state.
+</ParamField>
+
+<ParamField body="value" type="TValue" required>
+ The unique identifying value of the radio in a group.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/color-scheme-picker.mdx b/packages/twenty-docs/snippets/ui/generated/components/color-scheme-picker.mdx
new file mode 100644
index 00000000000..b3e502b49e5
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/color-scheme-picker.mdx
@@ -0,0 +1,36 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="className" type="string">
+ Class applied to the outer container.
+</ParamField>
+
+<ParamField body="darkLabel" type="string" required>
+ Visible caption for the dark scheme. The control’s accessible name remains Dark.
+</ParamField>
+
+<ParamField body="lightLabel" type="string" required>
+ Visible caption for the light scheme. The control’s accessible name remains Light.
+</ParamField>
+
+<ParamField body="onChange" type="(value: ColorScheme) =&gt; void" required>
+ Called with the newly selected color scheme.
+</ParamField>
+
+<ParamField body="systemLabel" type="string" required>
+ Visible caption for the system scheme. The control’s accessible name remains System.
+</ParamField>
+
+<ParamField body="value" type="&quot;Dark&quot; | &quot;Light&quot; | &quot;System&quot;" required>
+ Selected scheme: Light, Dark, or System. The application resolves system to a concrete theme.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/command-block.mdx b/packages/twenty-docs/snippets/ui/generated/components/command-block.mdx
new file mode 100644
index 00000000000..38e8e141090
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/command-block.mdx
@@ -0,0 +1,20 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="button" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt;">
+ Optional action element beside the command lines, such as a copy button.
+</ParamField>
+
+<ParamField body="commands" type="string[]" required>
+ Command lines to display. The component prefixes each line with > and does not execute commands.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/dropdown.mdx b/packages/twenty-docs/snippets/ui/generated/components/dropdown.mdx
index b5380b54b7d..362e844065d 100644
--- a/packages/twenty-docs/snippets/ui/generated/components/dropdown.mdx
+++ b/packages/twenty-docs/snippets/ui/generated/components/dropdown.mdx
@@ -14,27 +14,27 @@
### Dropdown.Root
<ParamField body="Root.defaultOpen" type="boolean">
-
+ Whether the popup is initially open when uncontrolled.
</ParamField>
<ParamField body="Root.defaultPage" type="string">
-
+ ID of the `Page` shown when the popup opens. Closing the popup resets the page history to it. Defaults to `root`.
</ParamField>
<ParamField body="Root.multiple" type="boolean">
-
+ Allows selecting several options. Options then keep the popup open and show a checkbox by default.
</ParamField>
<ParamField body="Root.onOpenChange" type="((open: boolean) =&gt; void)">
-
+ Called with the next open state when the popup opens or closes.
</ParamField>
<ParamField body="Root.open" type="boolean">
-
+ Whether the popup is open. Use with `onOpenChange` to control it.
</ParamField>
<ParamField body="Root.type" type="&quot;menu&quot; | &quot;panel&quot; | &quot;picker&quot;" required>
-
+ Interaction model: `menu` for commands and links, `picker` for search and selectable options, or `panel` for forms. It sets the ARIA roles, initial focus, and keyboard navigation.
</ParamField>
### Dropdown.Trigger
@@ -163,17 +163,17 @@
</ParamField>
<ParamField body="Content.width" type="Width&lt;string | number&gt;" default="200">
-
+ CSS width of the popup. Numbers are in pixels.
</ParamField>
### Dropdown.ActionItem
<ParamField body="ActionItem.className" type="string">
-
+ CSS class applied to the row.
</ParamField>
<ParamField body="ActionItem.closeOnClick" type="boolean" default="true">
-
+ Closes the dropdown after activation, along with parent menus when inside a submenu. Ignored when `page` is set.
</ParamField>
<ParamField body="ActionItem.color" type="&quot;danger&quot; | &quot;neutral&quot;">
@@ -213,11 +213,11 @@
</ParamField>
<ParamField body="ActionItem.page" type="string">
-
+ ID of the `Page` to show on activation. The popup stays open, and the row shows a chevron by default.
</ParamField>
<ParamField body="ActionItem.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt;">
-
+ Element rendered as the row instead of a native button. Custom components must forward the supplied props and ref.
</ParamField>
<ParamField body="ActionItem.startIcon" type="ReactNode">
@@ -225,17 +225,17 @@
</ParamField>
<ParamField body="ActionItem.style" type="CSSProperties">
-
+ Inline styles applied to the row.
</ParamField>
### Dropdown.OptionItem
<ParamField body="OptionItem.className" type="string">
-
+ CSS class applied to the row.
</ParamField>
<ParamField body="OptionItem.closeOnSelect" type="boolean">
-
+ Closes the dropdown after selection. Defaults to `true`, or `false` when `multiple` is set.
</ParamField>
<ParamField body="OptionItem.color" type="&quot;danger&quot; | &quot;neutral&quot;">
@@ -269,7 +269,7 @@
</ParamField>
<ParamField body="OptionItem.indicator" type="&quot;check&quot; | &quot;checkbox&quot; | &quot;none&quot;">
-
+ Selection indicator: a check icon after the content, a checkbox before it, or none. Defaults to `checkbox` when `multiple` is set, otherwise `check`.
</ParamField>
<ParamField body="OptionItem.nativeButton" type="boolean" default="true when render is omitted; false otherwise">
@@ -279,15 +279,15 @@
</ParamField>
<ParamField body="OptionItem.onSelect" type="(() =&gt; void)">
-
+ Called when the option is activated. The application owns the selected value.
</ParamField>
<ParamField body="OptionItem.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt;">
-
+ Element rendered as the row instead of a native button. Custom components must forward the supplied props and ref.
</ParamField>
<ParamField body="OptionItem.selected" type="boolean" required>
-
+ Whether the option is selected. Exposed as `aria-checked` in menus and `aria-pressed` in other dropdown types.
</ParamField>
<ParamField body="OptionItem.startIcon" type="ReactNode">
@@ -295,7 +295,7 @@
</ParamField>
<ParamField body="OptionItem.style" type="CSSProperties">
-
+ Inline styles applied to the row.
</ParamField>
### Dropdown.Search
@@ -310,7 +310,7 @@
</ParamField>
<ParamField body="Search.onValueChange" type="((value: string) =&gt; void)">
-
+ Called with the search text on every change. The application filters the results.
</ParamField>
<ParamField body="Search.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, InputState&gt;">
@@ -360,7 +360,7 @@
### Dropdown.Close
<ParamField body="Close.aria-label" type="string" required>
-
+ Accessible name of the close control. Required because the default control only shows an icon.
</ParamField>
<ParamField body="Close.className" type="string | ((state: PopoverCloseState) =&gt; string | undefined)">
@@ -389,17 +389,17 @@
### Dropdown.Page
<ParamField body="Page.id" type="string" required>
-
+ Identifier matched by `defaultPage`, the `page` prop of actions, and `goToPage`. The page renders only while it is current.
</ParamField>
<ParamField body="Page.type" type="&quot;menu&quot; | &quot;panel&quot; | &quot;picker&quot;">
-
+ Interaction model while the page is shown. Defaults to the root `type`.
</ParamField>
### Dropdown.Back
<ParamField body="Back.className" type="string">
-
+ CSS class applied to the row.
</ParamField>
<ParamField body="Back.color" type="&quot;danger&quot; | &quot;neutral&quot;">
@@ -439,7 +439,7 @@
</ParamField>
<ParamField body="Back.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt;">
-
+ Element rendered as the row instead of a native button. Custom components must forward the supplied props and ref.
</ParamField>
<ParamField body="Back.startIcon" type="ReactNode">
@@ -447,43 +447,43 @@
</ParamField>
<ParamField body="Back.style" type="CSSProperties">
-
+ Inline styles applied to the row.
</ParamField>
### Dropdown.Submenu
<ParamField body="Submenu.defaultOpen" type="boolean">
-
+ Whether the popup is initially open when uncontrolled.
</ParamField>
<ParamField body="Submenu.defaultPage" type="string">
-
+ ID of the `Page` shown when the popup opens. Closing the popup resets the page history to it. Defaults to `root`.
</ParamField>
<ParamField body="Submenu.multiple" type="boolean">
-
+ Allows selecting several options. Options then keep the popup open and show a checkbox by default.
</ParamField>
<ParamField body="Submenu.onOpenChange" type="((open: boolean) =&gt; void)">
-
+ Called with the next open state when the popup opens or closes.
</ParamField>
<ParamField body="Submenu.open" type="boolean">
-
+ Whether the popup is open. Use with `onOpenChange` to control it.
</ParamField>
<ParamField body="Submenu.type" type="&quot;menu&quot; | &quot;panel&quot; | &quot;picker&quot;" default="menu">
-
+ Interaction model: `menu` for commands and links, `picker` for search and selectable options, or `panel` for forms. It sets the ARIA roles, initial focus, and keyboard navigation.
</ParamField>
### Dropdown.SubmenuTrigger
<ParamField body="SubmenuTrigger.className" type="string">
-
+ CSS class applied to the row.
</ParamField>
<ParamField body="SubmenuTrigger.closeDelay" type="number">
-
+ Delay in milliseconds before a submenu opened on hover closes. Requires `openOnHover`. Defaults to `0`.
</ParamField>
<ParamField body="SubmenuTrigger.color" type="&quot;danger&quot; | &quot;neutral&quot;">
@@ -491,7 +491,7 @@
</ParamField>
<ParamField body="SubmenuTrigger.delay" type="number">
-
+ Delay in milliseconds before the submenu opens on hover. Requires `openOnHover`. Defaults to `300`.
</ParamField>
<ParamField body="SubmenuTrigger.description" type="ReactNode">
@@ -527,11 +527,11 @@
</ParamField>
<ParamField body="SubmenuTrigger.openOnHover" type="boolean" default="true">
-
+ Also opens the submenu when the row is hovered.
</ParamField>
<ParamField body="SubmenuTrigger.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt;">
-
+ Element rendered as the row instead of a native button. Custom components must forward the supplied props and ref.
</ParamField>
<ParamField body="SubmenuTrigger.startIcon" type="ReactNode">
@@ -539,15 +539,41 @@
</ParamField>
<ParamField body="SubmenuTrigger.style" type="CSSProperties">
-
+ Inline styles applied to the row.
</ParamField>
### Dropdown.Section
<ParamField body="Section.label" type="ReactNode">
-
+ Heading displayed above the rows. It also names the group for assistive technologies.
</ParamField>
<ParamField body="Section.scrollable" type="boolean">
+ Caps the section height and scrolls its rows. Nest labelled sections inside it to scroll them as one list.
+</ParamField>
+
+### Dropdown.Separator
+
+<ParamField body="Separator.className" type="string">
+ Class applied to the separator. Native div attributes and refs are also accepted.
+</ParamField>
+
+### Dropdown.Loading
+
+<ParamField body="Loading.children" type="ReactNode">
+ Loading message announced as a polite, busy status.
+</ParamField>
+
+<ParamField body="Loading.className" type="string">
+ Class applied to the status. Native div attributes and refs are also accepted.
+</ParamField>
+
+### Dropdown.Empty
+
+<ParamField body="Empty.children" type="ReactNode">
+ Empty-state message announced as a polite status.
+</ParamField>
+<ParamField body="Empty.className" type="string">
+ Class applied to the status. Native div attributes and refs are also accepted.
</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/info.mdx b/packages/twenty-docs/snippets/ui/generated/components/info.mdx
new file mode 100644
index 00000000000..233daab31a3
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/info.mdx
@@ -0,0 +1,36 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="accent" type="&quot;blue&quot; | &quot;danger&quot;" default="blue">
+ Information or danger styling.
+</ParamField>
+
+<ParamField body="buttonTitle" type="string">
+ Visible label for the optional action. Requires href or onClick.
+</ParamField>
+
+<ParamField body="href" type="string">
+ Action destination. Takes precedence over onClick.
+</ParamField>
+
+<ParamField body="onClick" type="((event: MouseEvent&lt;HTMLButtonElement, MouseEvent&gt;) =&gt; void)">
+ Action callback when href is absent.
+</ParamField>
+
+<ParamField body="render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, ButtonState&gt;">
+ Custom render element for the link action, forwarded to Button when href is supplied.
+</ParamField>
+
+<ParamField body="text" type="string" required>
+ Message displayed beside the information icon.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/inline-banner.mdx b/packages/twenty-docs/snippets/ui/generated/components/inline-banner.mdx
new file mode 100644
index 00000000000..83bb37c2da2
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/inline-banner.mdx
@@ -0,0 +1,36 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="button" type="{ title?: string | undefined; onClick?: (() =&gt; void) | undefined; hidden?: boolean | undefined; disabled?: boolean | undefined; Icon?: IconComponent | undefined; }">
+ Optional action with title, onClick, hidden, disabled, and Icon fields.
+</ParamField>
+
+<ParamField body="className" type="string">
+ Class applied to the banner.
+</ParamField>
+
+<ParamField body="color" type="&quot;blue&quot; | &quot;danger&quot;">
+ Banner palette color. An omitted color uses Banner’s default.
+</ParamField>
+
+<ParamField body="embedded" type="boolean" default="false">
+ Uses the embedded banner appearance.
+</ParamField>
+
+<ParamField body="LeftIcon" type="IconComponent">
+ Leading icon component. Defaults to the information icon.
+</ParamField>
+
+<ParamField body="message" type="string" required>
+ Message, truncated with its full text available in a tooltip.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/json-tree.mdx b/packages/twenty-docs/snippets/ui/generated/components/json-tree.mdx
new file mode 100644
index 00000000000..68457161704
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/json-tree.mdx
@@ -0,0 +1,53 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="arrowButtonCollapsedLabel" type="string" required>
+ Accessible label for the expand control on a collapsed node.
+</ParamField>
+
+<ParamField body="arrowButtonExpandedLabel" type="string" required>
+ Accessible label for the collapse control on an expanded node.
+</ParamField>
+
+<ParamField body="emptyArrayLabel" type="string" required>
+ Display text for an empty array.
+</ParamField>
+
+<ParamField body="emptyObjectLabel" type="string" required>
+ Display text for an empty object.
+</ParamField>
+
+<ParamField body="emptyStringLabel" type="string" required>
+ Display text for an empty string.
+</ParamField>
+
+<ParamField body="entries" type="JsonTreeEntry[]">
+ Named entries with stable id, label, and JSON value fields. Supply entries or value, not both.
+</ParamField>
+
+<ParamField body="getNodeHighlighting" type="GetJsonNodeHighlighting">
+ Returns blue, red, or partial-blue highlighting for a node key path.
+</ParamField>
+
+<ParamField body="onNodeValueClick" type="((valueAsString: string) =&gt; void)">
+ Called with the clicked value as displayed: leaf values as strings, and the empty label for empty strings, arrays, and objects.
+</ParamField>
+
+<ParamField body="shouldExpandNodeInitially" type="((params: ShouldExpandNodeInitiallyProps) =&gt; boolean)" default="({ depth }: ShouldExpandNodeInitiallyProps) =&gt;
+ depth &lt;= 1">
+ Chooses initial expansion from the node keyPath and depth. The default expands the first two depths.
+</ParamField>
+
+<ParamField body="value" type="JsonValue">
+ JSON value to display. Supply value or entries, not both.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/menu-item-avatar.mdx b/packages/twenty-docs/snippets/ui/generated/components/menu-item-avatar.mdx
new file mode 100644
index 00000000000..b2a1b707d06
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/menu-item-avatar.mdx
@@ -0,0 +1,64 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="accent" type="&quot;danger&quot; | &quot;default&quot; | &quot;placeholder&quot;" default="default">
+ Default, danger, or placeholder row styling.
+</ParamField>
+
+<ParamField body="avatar" type="Pick&lt;AvatarProps, &quot;size&quot; | &quot;name&quot; | &quot;shape&quot; | &quot;src&quot; | &quot;colorSeed&quot;&gt; | null">
+ Avatar name, source, color seed, size, and shape. Omit to hide the avatar.
+</ParamField>
+
+<ParamField body="className" type="string">
+ Class applied to the row.
+</ParamField>
+
+<ParamField body="contextualText" type="ReactNode">
+ Supporting text beside the main label.
+</ParamField>
+
+<ParamField body="hasSubMenu" type="boolean" default="false">
+ Shows a submenu chevron; does not create a submenu.
+</ParamField>
+
+<ParamField body="iconButtons" type="ReactNode">
+ Trailing action elements.
+</ParamField>
+
+<ParamField body="isIconDisplayedOnHoverOnly" type="boolean" default="true">
+ Reveals trailing action elements only on hover.
+</ParamField>
+
+<ParamField body="isTooltipOpen" type="boolean">
+ Accepted for compatibility; currently has no effect.
+</ParamField>
+
+<ParamField body="onClick" type="((event: MouseEvent&lt;HTMLDivElement, MouseEvent&gt;) =&gt; void)">
+ Pointer activation callback. The row itself does not add keyboard or menu semantics.
+</ParamField>
+
+<ParamField body="onMouseEnter" type="((event: MouseEvent&lt;HTMLDivElement, MouseEvent&gt;) =&gt; void)">
+ Pointer-entry callback on the row.
+</ParamField>
+
+<ParamField body="onMouseLeave" type="((event: MouseEvent&lt;HTMLDivElement, MouseEvent&gt;) =&gt; void)">
+ Pointer-exit callback on the row.
+</ParamField>
+
+<ParamField body="testId" type="string">
+ Value of the row’s data-testid attribute.
+</ParamField>
+
+<ParamField body="text" type="string" required>
+ Main row label.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/menu-item-draggable.mdx b/packages/twenty-docs/snippets/ui/generated/components/menu-item-draggable.mdx
new file mode 100644
index 00000000000..0c289af76a2
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/menu-item-draggable.mdx
@@ -0,0 +1,64 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="accent" type="&quot;danger&quot; | &quot;default&quot; | &quot;placeholder&quot;" default="default">
+ Default, danger, or placeholder row styling.
+</ParamField>
+
+<ParamField body="className" type="string">
+ Class applied to the row.
+</ParamField>
+
+<ParamField body="contextualText" type="ReactNode">
+ Supporting text beside the main label.
+</ParamField>
+
+<ParamField body="gripMode" type="&quot;always&quot; | &quot;never&quot; | &quot;onHover&quot;" default="never">
+ Grip visibility: never, always, or onHover. onHover swaps LeftIcon for the grip on hover and shows no grip without LeftIcon. Does not implement dragging.
+</ParamField>
+
+<ParamField body="iconButtons" type="ReactNode">
+ Trailing action elements.
+</ParamField>
+
+<ParamField body="isDragDisabled" type="boolean" default="false">
+ Disables drag appearance without installing or removing drag handlers.
+</ParamField>
+
+<ParamField body="isHoverDisabled" type="boolean">
+ Accepted for compatibility; currently has no effect.
+</ParamField>
+
+<ParamField body="isIconDisplayedOnHoverOnly" type="boolean" default="true">
+ Reveals trailing action elements only on hover.
+</ParamField>
+
+<ParamField body="isTooltipOpen" type="boolean">
+ Accepted for compatibility; currently has no effect.
+</ParamField>
+
+<ParamField body="LeftIcon" type="IconComponent">
+ Leading icon component.
+</ParamField>
+
+<ParamField body="onClick" type="(() =&gt; void)">
+ Pointer activation callback. The row itself does not add keyboard or menu semantics.
+</ParamField>
+
+<ParamField body="text" type="ReactNode" required>
+ Main row label.
+</ParamField>
+
+<ParamField body="withIconContainer" type="boolean" default="false">
+ Places leading content in an icon container.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/menu-item-suggestion.mdx b/packages/twenty-docs/snippets/ui/generated/components/menu-item-suggestion.mdx
new file mode 100644
index 00000000000..cb44671a767
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/menu-item-suggestion.mdx
@@ -0,0 +1,44 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="className" type="string">
+ Class applied to the row.
+</ParamField>
+
+<ParamField body="contextualText" type="string">
+ Supporting text beside the main label.
+</ParamField>
+
+<ParamField body="contextualTextPosition" type="&quot;left&quot; | &quot;right&quot;" default="left">
+ Position of the supporting text.
+</ParamField>
+
+<ParamField body="LeftIcon" type="IconComponent | null">
+ Leading icon component.
+</ParamField>
+
+<ParamField body="onClick" type="((event: MouseEvent&lt;HTMLLIElement, MouseEvent&gt;) =&gt; void)">
+ Activation callback. When supplied, the row gains button semantics, a tab stop, and Enter/Space activation.
+</ParamField>
+
+<ParamField body="selected" type="boolean">
+ Applies selected styling. The application owns selection.
+</ParamField>
+
+<ParamField body="text" type="string" required>
+ Main row label.
+</ParamField>
+
+<ParamField body="withIconContainer" type="boolean" default="false">
+ Places leading content in an icon container.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/menu-item.mdx b/packages/twenty-docs/snippets/ui/generated/components/menu-item.mdx
new file mode 100644
index 00000000000..5af379b4c35
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/menu-item.mdx
@@ -0,0 +1,112 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="accent" type="&quot;danger&quot; | &quot;default&quot; | &quot;placeholder&quot;" default="default">
+ Default, danger, or placeholder row styling.
+</ParamField>
+
+<ParamField body="className" type="string">
+ Class applied to the row.
+</ParamField>
+
+<ParamField body="contextualText" type="ReactNode">
+ Supporting text beside the main label.
+</ParamField>
+
+<ParamField body="contextualTextPosition" type="&quot;left&quot; | &quot;right&quot;" default="left">
+ Position of the supporting text.
+</ParamField>
+
+<ParamField body="disabled" type="boolean" default="false">
+ Disables activation and applies disabled styling.
+</ParamField>
+
+<ParamField body="focused" type="boolean" default="false">
+ Applies focused appearance without moving DOM focus.
+</ParamField>
+
+<ParamField body="hasSubMenu" type="boolean" default="false">
+ Shows a submenu chevron; does not create a submenu.
+</ParamField>
+
+<ParamField body="hotKeys" type="Nullable&lt;string[]&gt;">
+ Visible shortcut hints. Register handlers in the application.
+</ParamField>
+
+<ParamField body="iconButtons" type="ReactNode">
+ Trailing action elements.
+</ParamField>
+
+<ParamField body="iconThemeColor" type="ThemeColor | null">
+ Theme color for the leading icon.
+</ParamField>
+
+<ParamField body="isIconDisplayedOnHoverOnly" type="boolean" default="true">
+ Reveals trailing action elements only on hover.
+</ParamField>
+
+<ParamField body="isSubMenuOpened" type="boolean" default="false">
+ Applies the open treatment to the submenu chevron.
+</ParamField>
+
+<ParamField body="isTooltipOpen" type="boolean">
+ Accepted for compatibility; currently has no effect.
+</ParamField>
+
+<ParamField body="LeftComponent" type="ReactNode">
+ Custom leading content.
+</ParamField>
+
+<ParamField body="LeftIcon" type="IconComponent | null">
+ Leading icon component.
+</ParamField>
+
+<ParamField body="onClick" type="((event: MouseEvent&lt;HTMLDivElement, MouseEvent&gt;) =&gt; void)">
+ Pointer activation callback. The row itself does not add keyboard or menu semantics.
+</ParamField>
+
+<ParamField body="onMouseEnter" type="((event: MouseEvent&lt;HTMLDivElement, MouseEvent&gt;) =&gt; void)">
+ Pointer-entry callback on the row.
+</ParamField>
+
+<ParamField body="onMouseLeave" type="((event: MouseEvent&lt;HTMLDivElement, MouseEvent&gt;) =&gt; void)">
+ Pointer-exit callback on the row.
+</ParamField>
+
+<ParamField body="RightComponent" type="ReactNode">
+ Custom trailing content.
+</ParamField>
+
+<ParamField body="RightIcon" type="IconComponent | null">
+ Trailing icon component.
+</ParamField>
+
+<ParamField body="selected" type="boolean" default="false">
+ Applies selected appearance without owning selection state.
+</ParamField>
+
+<ParamField body="testId" type="string">
+ Value of the row’s data-testid attribute.
+</ParamField>
+
+<ParamField body="text" type="ReactNode" required>
+ Main row label.
+</ParamField>
+
+<ParamField body="withIconContainer" type="boolean" default="false">
+ Places leading content in an icon container.
+</ParamField>
+
+<ParamField body="withIconContainerBackground" type="boolean" default="true">
+ Adds a background to the leading icon container.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/menu-picker.mdx b/packages/twenty-docs/snippets/ui/generated/components/menu-picker.mdx
new file mode 100644
index 00000000000..fb2ed087f6b
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/menu-picker.mdx
@@ -0,0 +1,60 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="className" type="string">
+ Class applied to the button.
+</ParamField>
+
+<ParamField body="disabled" type="boolean" default="false">
+ Disables the button.
+</ParamField>
+
+<ParamField body="icon" type="IconComponent" required>
+ Leading icon component.
+</ParamField>
+
+<ParamField body="id" type="string" required>
+ Button ID.
+</ParamField>
+
+<ParamField body="label" type="string">
+ Button label and accessible name, including when showLabel is false.
+</ParamField>
+
+<ParamField body="onClick" type="(() =&gt; void)">
+ Activation callback.
+</ParamField>
+
+<ParamField body="selected" type="boolean" default="false">
+ Controls selected styling and aria-pressed.
+</ParamField>
+
+<ParamField body="showLabel" type="boolean" default="true">
+ Shows the visible label beside the icon.
+</ParamField>
+
+<ParamField body="testId" type="string">
+ Value of the button’s data-testid attribute.
+</ParamField>
+
+<ParamField body="tooltipContent" type="string">
+ Optional tooltip text.
+</ParamField>
+
+<ParamField body="tooltipDelay" type="number" default="0">
+ Hover delay in milliseconds.
+</ParamField>
+
+<ParamField body="tooltipOffset" type="number" default="5">
+ Distance between the button and tooltip in pixels.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/navigation-bar.mdx b/packages/twenty-docs/snippets/ui/generated/components/navigation-bar.mdx
new file mode 100644
index 00000000000..1dc1c7369d4
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/navigation-bar.mdx
@@ -0,0 +1,24 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="activeItemName" type="string" required>
+ Name of the item to highlight. The application owns navigation.
+</ParamField>
+
+<ParamField body="isHidden" type="boolean" default="false">
+ Hides the bar visually and from the accessibility tree.
+</ParamField>
+
+<ParamField body="items" type="{ name: string; label: string; Icon: IconComponent; onClick: () =&gt; void; }[]" required>
+ Navigation items with a unique name, accessible label, Icon component, and onClick callback.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/notification-counter.mdx b/packages/twenty-docs/snippets/ui/generated/components/notification-counter.mdx
new file mode 100644
index 00000000000..44ba8543b4c
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/notification-counter.mdx
@@ -0,0 +1,24 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="className" type="string">
+ Class applied to the badge.
+</ParamField>
+
+<ParamField body="count" type="number" required>
+ Number to display as supplied, without clamping or hiding zero.
+</ParamField>
+
+<ParamField body="variant" type="&quot;primary&quot; | &quot;secondary&quot;" default="primary">
+ Primary or secondary badge styling.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/rounded-link.mdx b/packages/twenty-docs/snippets/ui/generated/components/rounded-link.mdx
new file mode 100644
index 00000000000..a517f651386
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/rounded-link.mdx
@@ -0,0 +1,32 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="className" type="string">
+ Class applied to the link.
+</ParamField>
+
+<ParamField body="color" type="&quot;primary&quot; | &quot;secondary&quot;" default="primary">
+ Label text color: primary or secondary.
+</ParamField>
+
+<ParamField body="href" type="string" required>
+ Destination URL, normalized by the safe-URL helper. Opens in a new tab.
+</ParamField>
+
+<ParamField body="label" type="string">
+ Visible link text. An absent or empty label renders nothing.
+</ParamField>
+
+<ParamField body="onClick" type="((event: MouseEvent&lt;HTMLElement, MouseEvent&gt;) =&gt; void)">
+ Click callback after propagation is stopped.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/search-input.mdx b/packages/twenty-docs/snippets/ui/generated/components/search-input.mdx
new file mode 100644
index 00000000000..6b07e8f15a2
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/search-input.mdx
@@ -0,0 +1,56 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="aria-label" type="string">
+ Accessible name when aria-labelledby is absent.
+</ParamField>
+
+<ParamField body="aria-labelledby" type="string">
+ ID of the element that labels the input. Takes precedence over aria-label.
+</ParamField>
+
+<ParamField body="autoFocus" type="boolean">
+ Focuses the input when mounted.
+</ParamField>
+
+<ParamField body="className" type="string">
+ Class applied to the wrapper.
+</ParamField>
+
+<ParamField body="disabled" type="boolean">
+ Disables the text input. Configure filter popup controls separately.
+</ParamField>
+
+<ParamField body="filterButtonAriaLabel" type="string" default="Filter">
+ Accessible label for the optional filter button.
+</ParamField>
+
+<ParamField body="filterDropdown" type="((filterButton: ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt;) =&gt; ReactNode)">
+ Renders a filter popup around the supplied filter button.
+</ParamField>
+
+<ParamField body="id" type="string">
+ Input ID, generated when omitted.
+</ParamField>
+
+<ParamField body="onChange" type="(value: string) =&gt; void" required>
+ Called with the new text, not a DOM change event. The application owns filtering.
+</ParamField>
+
+<ParamField body="placeholder" type="string">
+ Hint shown when the input is empty. Also used as the accessible name if no explicit label is supplied.
+</ParamField>
+
+<ParamField body="value" type="string" required>
+ Current search text.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/tinted-icon-tile.mdx b/packages/twenty-docs/snippets/ui/generated/components/tinted-icon-tile.mdx
new file mode 100644
index 00000000000..8e4cf3b6d91
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/tinted-icon-tile.mdx
@@ -0,0 +1,28 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="color" type="string | null" default="gray">
+ Theme palette name used to derive the background and icon shades. Invalid names use the default theme color.
+</ParamField>
+
+<ParamField body="Icon" type="IconComponent" required>
+ Icon component rendered inside the tinted tile.
+</ParamField>
+
+<ParamField body="size" type="number">
+ Icon and tile dimension in pixels. When omitted, the icon uses the medium theme size.
+</ParamField>
+
+<ParamField body="stroke" type="number">
+ Icon stroke width. Defaults to the medium theme stroke.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/toast-provider.mdx b/packages/twenty-docs/snippets/ui/generated/components/toast-provider.mdx
new file mode 100644
index 00000000000..1d7477f738e
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/toast-provider.mdx
@@ -0,0 +1,20 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="children" type="ReactNode">
+ Application content and a Toaster sharing this notification store.
+</ParamField>
+
+<ParamField body="limit" type="number" default="3">
+ Maximum number of visible toasts, read once when the provider mounts. Must be a positive integer. Adding a toast above the limit dismisses the oldest visible notifications.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/components/toaster.mdx b/packages/twenty-docs/snippets/ui/generated/components/toaster.mdx
new file mode 100644
index 00000000000..2f535aca970
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/components/toaster.mdx
@@ -0,0 +1,24 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="container" type="HTMLElement | null">
+ Portal destination. Omit to use the theme container or document.body; null defers rendering.
+</ParamField>
+
+<ParamField body="getToastProps" type="((toast: ToastNotification) =&gt; Partial&lt;Omit&lt;ToastProps, &quot;ref&quot; | &quot;id&quot; | &quot;onClose&quot;&gt;&gt;)">
+ Customizes each notification’s Toast props. The toaster owns id, ref, and dismissal.
+</ParamField>
+
+<ParamField body="render" type="RenderProp&lt;Record&lt;string, unknown&gt;&gt;">
+ Custom root element composed through Base UI.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/icon/catalog.mdx b/packages/twenty-docs/snippets/ui/generated/icon/catalog.mdx
new file mode 100644
index 00000000000..e3f6746f420
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/icon/catalog.mdx
@@ -0,0 +1,533 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+### SVG icons
+
+Supported props: `color`, `size`, `stroke`, `title`. Native SVG attributes and refs are also accepted.
+
+- `Icon123`
+- `IconAdjustments`
+- `IconAlertCircle`
+- `IconAlertTriangle`
+- `IconAlignBoxLeftTop`
+- `IconAlignCenter`
+- `IconAlignLeft`
+- `IconAlignRight`
+- `IconApi`
+- `IconAppWindow`
+- `IconApps`
+- `IconArchive`
+- `IconArchiveOff`
+- `IconArrowBackUp`
+- `IconArrowBarToDown`
+- `IconArrowBarToDownDashed`
+- `IconArrowDown`
+- `IconArrowLeft`
+- `IconArrowMerge`
+- `IconArrowRight`
+- `IconArrowUp`
+- `IconArrowUpRight`
+- `IconArrowsDiagonal`
+- `IconArrowsSort`
+- `IconArrowsSplit2`
+- `IconArrowsVertical`
+- `IconAt`
+- `IconAxisX`
+- `IconAxisY`
+- `IconBadge2k`
+- `IconBaselineDensitySmall`
+- `IconBell`
+- `IconBlockquote`
+- `IconBold`
+- `IconBolt`
+- `IconBook`
+- `IconBook2`
+- `IconBookmark`
+- `IconBookmarkPlus`
+- `IconBox`
+- `IconBoxMultiple`
+- `IconBrackets`
+- `IconBracketsAngle`
+- `IconBracketsContain`
+- `IconBrain`
+- `IconBrandDaysCounter`
+- `IconBrandDocker`
+- `IconBrandGithub`
+- `IconBrandGoogle`
+- `IconBrandGraphql`
+- `IconBrandLinkedin`
+- `IconBrandNpm`
+- `IconBrandOpenai`
+- `IconBrandTypescript`
+- `IconBrandWhatsapp`
+- `IconBrandX`
+- `IconBriefcase`
+- `IconBroadcast`
+- `IconBrowserMaximize`
+- `IconBuildingSkyscraper`
+- `IconCalendar`
+- `IconCalendarDue`
+- `IconCalendarEvent`
+- `IconCalendarMonth`
+- `IconCalendarRepeat`
+- `IconCalendarTime`
+- `IconCalendarWeek`
+- `IconCalendarX`
+- `IconCancel`
+- `IconCaretLeft`
+- `IconCaretRight`
+- `IconChartBar`
+- `IconChartBarPopular`
+- `IconChartCandle`
+- `IconChartDots3`
+- `IconChartLine`
+- `IconChartPie`
+- `IconCheck`
+- `IconCheckbox`
+- `IconChevronDown`
+- `IconChevronLeft`
+- `IconChevronRight`
+- `IconChevronRightPipe`
+- `IconChevronUp`
+- `IconChevronsRight`
+- `IconCircle`
+- `IconCircleDashed`
+- `IconCircleDot`
+- `IconCircleOff`
+- `IconCirclePlus`
+- `IconCircleX`
+- `IconClick`
+- `IconClock`
+- `IconClockHour8`
+- `IconClockPlay`
+- `IconClockShare`
+- `IconCode`
+- `IconCodeCircle`
+- `IconCoins`
+- `IconColorSwatch`
+- `IconColumnInsertRight`
+- `IconColumns`
+- `IconCommand`
+- `IconComment`
+- `IconCompass`
+- `IconCopy`
+- `IconCopyPlus`
+- `IconCpu`
+- `IconCreativeCommonsSa`
+- `IconCreditCard`
+- `IconCsv`
+- `IconCube`
+- `IconCurrencyAfghani`
+- `IconCurrencyBahraini`
+- `IconCurrencyBaht`
+- `IconCurrencyDinar`
+- `IconCurrencyDirham`
+- `IconCurrencyDollar`
+- `IconCurrencyDollarAustralian`
+- `IconCurrencyDollarBrunei`
+- `IconCurrencyDollarCanadian`
+- `IconCurrencyDollarGuyanese`
+- `IconCurrencyDollarSingapore`
+- `IconCurrencyDong`
+- `IconCurrencyDram`
+- `IconCurrencyEuro`
+- `IconCurrencyFlorin`
+- `IconCurrencyForint`
+- `IconCurrencyFrank`
+- `IconCurrencyGuarani`
+- `IconCurrencyHryvnia`
+- `IconCurrencyIranianRial`
+- `IconCurrencyKip`
+- `IconCurrencyKroneCzech`
+- `IconCurrencyKroneDanish`
+- `IconCurrencyKroneSwedish`
+- `IconCurrencyLari`
+- `IconCurrencyLeu`
+- `IconCurrencyLira`
+- `IconCurrencyLyd`
+- `IconCurrencyManat`
+- `IconCurrencyNaira`
+- `IconCurrencyPaanga`
+- `IconCurrencyPeso`
+- `IconCurrencyPound`
+- `IconCurrencyQuetzal`
+- `IconCurrencyReal`
+- `IconCurrencyRenminbi`
+- `IconCurrencyRiyal`
+- `IconCurrencyRubel`
+- `IconCurrencyRufiyaa`
+- `IconCurrencyRupee`
+- `IconCurrencyRupeeNepalese`
+- `IconCurrencyShekel`
+- `IconCurrencySom`
+- `IconCurrencyTaka`
+- `IconCurrencyTenge`
+- `IconCurrencyTugrik`
+- `IconCurrencyWon`
+- `IconCurrencyYen`
+- `IconCurrencyYuan`
+- `IconCurrencyZloty`
+- `IconDatabase`
+- `IconDatabaseExport`
+- `IconDecimal`
+- `IconDeviceDesktop`
+- `IconDeviceFloppy`
+- `IconDoorEnter`
+- `IconDotsVertical`
+- `IconDownload`
+- `IconEdit`
+- `IconEditCircle`
+- `IconEraser`
+- `IconExclamationCircle`
+- `IconExternalLink`
+- `IconEye`
+- `IconEyeOff`
+- `IconEyeShare`
+- `IconEyeX`
+- `IconFile`
+- `IconFileCheck`
+- `IconFileExport`
+- `IconFileImport`
+- `IconFileInfo`
+- `IconFilePencil`
+- `IconFileText`
+- `IconFileUpload`
+- `IconFileZip`
+- `IconFiles`
+- `IconFilter`
+- `IconFilterCog`
+- `IconFilterOff`
+- `IconFilterPlus`
+- `IconFilterX`
+- `IconFilters`
+- `IconFlag`
+- `IconFlask`
+- `IconFocusCentered`
+- `IconFolder`
+- `IconFolderOpen`
+- `IconFolderPlus`
+- `IconFolderRoot`
+- `IconFolderSymlink`
+- `IconForbid`
+- `IconFrame`
+- `IconFunction`
+- `IconGauge`
+- `IconGitBranch`
+- `IconGitBranchDeleted`
+- `IconGitCommit`
+- `IconGizmo`
+- `IconGraph`
+- `IconGripVertical`
+- `IconH1`
+- `IconH2`
+- `IconH3`
+- `IconH4`
+- `IconH5`
+- `IconH6`
+- `IconHandClick`
+- `IconHandMove`
+- `IconHeadphones`
+- `IconHeart`
+- `IconHeartOff`
+- `IconHeartRateMonitor`
+- `IconHelp`
+- `IconHelpCircle`
+- `IconHierarchy`
+- `IconHierarchy2`
+- `IconHistory`
+- `IconHistoryToggle`
+- `IconHome`
+- `IconHourglassHigh`
+- `IconHours24`
+- `IconHttpDelete`
+- `IconHttpGet`
+- `IconHttpPatch`
+- `IconHttpPost`
+- `IconHttpPut`
+- `IconId`
+- `IconInbox`
+- `IconInfoCircle`
+- `IconInfoSquareRounded`
+- `IconItalic`
+- `IconJetpack`
+- `IconJson`
+- `IconKey`
+- `IconLanguage`
+- `IconLayersLinked`
+- `IconLayout`
+- `IconLayoutDashboard`
+- `IconLayoutGrid`
+- `IconLayoutGridAdd`
+- `IconLayoutKanban`
+- `IconLayoutList`
+- `IconLayoutNavbar`
+- `IconLayoutSidebar`
+- `IconLayoutSidebarLeftCollapse`
+- `IconLayoutSidebarLeftExpand`
+- `IconLayoutSidebarRight`
+- `IconLayoutSidebarRightCollapse`
+- `IconLayoutSidebarRightExpand`
+- `IconLego`
+- `IconLetterK`
+- `IconLibraryPlus`
+- `IconLifebuoy`
+- `IconLink`
+- `IconLinkOff`
+- `IconLinkPlus`
+- `IconList`
+- `IconListCheck`
+- `IconListDetails`
+- `IconListNumbers`
+- `IconListSearch`
+- `IconLoader`
+- `IconLock`
+- `IconLockOpen`
+- `IconLogin2`
+- `IconLogout`
+- `IconMail`
+- `IconMailCog`
+- `IconMailX`
+- `IconMap`
+- `IconMathMax`
+- `IconMathMin`
+- `IconMathXy`
+- `IconMaximize`
+- `IconMessage`
+- `IconMessageCircle`
+- `IconMessageCirclePlus`
+- `IconMicrophone`
+- `IconMinimize`
+- `IconMinus`
+- `IconMoneybag`
+- `IconMoodSmile`
+- `IconMoon`
+- `IconMouse2`
+- `IconNewSection`
+- `IconNorthStar`
+- `IconNoteOff`
+- `IconNotes`
+- `IconNumber`
+- `IconNumber123`
+- `IconNumber9`
+- `IconNumbers`
+- `IconPaint`
+- `IconPaperclip`
+- `IconPassword`
+- `IconPencil`
+- `IconPencilOff`
+- `IconPercentage`
+- `IconPerspective`
+- `IconPhone`
+- `IconPhoto`
+- `IconPhotoUp`
+- `IconPilcrow`
+- `IconPin`
+- `IconPinned`
+- `IconPinnedOff`
+- `IconPlayerPause`
+- `IconPlayerPlay`
+- `IconPlayerStop`
+- `IconPlaylistAdd`
+- `IconPlaystationSquare`
+- `IconPlug`
+- `IconPlus`
+- `IconPoint`
+- `IconPower`
+- `IconPresentation`
+- `IconPrinter`
+- `IconProgressCheck`
+- `IconPrompt`
+- `IconPuzzle`
+- `IconPuzzle2`
+- `IconQuestionMark`
+- `IconRadiusBottomLeft`
+- `IconRadiusBottomRight`
+- `IconRadiusTopLeft`
+- `IconRadiusTopRight`
+- `IconRefresh`
+- `IconRefreshAlert`
+- `IconRefreshDot`
+- `IconRelationManyToMany`
+- `IconRelationOneToMany`
+- `IconRelationOneToOne`
+- `IconReload`
+- `IconReorder`
+- `IconRepeat`
+- `IconRestore`
+- `IconRobot`
+- `IconRocket`
+- `IconRotate`
+- `IconRotate2`
+- `IconRowInsertBottom`
+- `IconRowInsertTop`
+- `IconSearch`
+- `IconSend`
+- `IconServer`
+- `IconServer2`
+- `IconSettings`
+- `IconSettings2`
+- `IconSettingsAutomation`
+- `IconSettingsBolt`
+- `IconShare`
+- `IconShare2`
+- `IconShield`
+- `IconShoppingBag`
+- `IconSitemap`
+- `IconSlash`
+- `IconSortAZ`
+- `IconSortAscending`
+- `IconSortAscendingLetters`
+- `IconSortAscendingNumbers`
+- `IconSortDescending`
+- `IconSortDescendingLetters`
+- `IconSortDescendingNumbers`
+- `IconSortZA`
+- `IconSparkles`
+- `IconSpy`
+- `IconSql`
+- `IconSquare`
+- `IconSquareCheck`
+- `IconSquareKey`
+- `IconSquareNumber1`
+- `IconSquareNumber2`
+- `IconSquareNumber3`
+- `IconSquareNumber4`
+- `IconSquareNumber5`
+- `IconSquareNumber6`
+- `IconSquareNumber7`
+- `IconSquareNumber8`
+- `IconSquareNumber9`
+- `IconSquarePlus`
+- `IconSquareRoundedCheck`
+- `IconSquareRoundedX`
+- `IconSquareX`
+- `IconStack2`
+- `IconStairs`
+- `IconStar`
+- `IconStatusChange`
+- `IconStepInto`
+- `IconStrikethrough`
+- `IconSum`
+- `IconSun`
+- `IconSunMoon`
+- `IconSwitchHorizontal`
+- `IconTable`
+- `IconTag`
+- `IconTags`
+- `IconTarget`
+- `IconTargetArrow`
+- `IconTerminal`
+- `IconTestPipe`
+- `IconTextCaption`
+- `IconTextSize`
+- `IconTextWrap`
+- `IconTimeDuration30`
+- `IconTimeDuration60`
+- `IconTimelineEvent`
+- `IconTool`
+- `IconTransform`
+- `IconTrash`
+- `IconTrashOff`
+- `IconTrashX`
+- `IconTrendingDown`
+- `IconTrendingUp`
+- `IconTypography`
+- `IconUnderline`
+- `IconUnlink`
+- `IconUpload`
+- `IconUser`
+- `IconUserCircle`
+- `IconUserCog`
+- `IconUserPin`
+- `IconUserPlus`
+- `IconUsers`
+- `IconVariable`
+- `IconVariablePlus`
+- `IconVersions`
+- `IconVersionsOff`
+- `IconVideo`
+- `IconWand`
+- `IconWebhook`
+- `IconWindow`
+- `IconWorld`
+- `IconWorldWww`
+- `IconX`
+
+### `color`, `size`, `stroke`
+
+Supported props: `color`, `size`, `stroke`. Other native attributes are not forwarded.
+
+- `IconAddressBook`
+- `IconChartBarHorizontal`
+
+### `size`
+
+Supported props: `size`. Other native attributes are not forwarded.
+
+- `IconBrandAnthropic`
+- `IconBrandGemini`
+- `IconBrandGroq`
+- `IconBrandMistral`
+- `IconGmail`
+- `IconGoogle`
+- `IconGoogleCalendar`
+- `IconLockCustom`
+- `IconMicrosoft`
+- `IconMicrosoftCalendar`
+- `IconMicrosoftOutlook`
+- `IconModelClaude`
+- `IllustrationIconArray`
+- `IllustrationIconCalendarEvent`
+- `IllustrationIconCalendarTime`
+- `IllustrationIconCurrency`
+- `IllustrationIconFile`
+- `IllustrationIconJson`
+- `IllustrationIconLink`
+- `IllustrationIconMail`
+- `IllustrationIconManyToMany`
+- `IllustrationIconMap`
+- `IllustrationIconNumbers`
+- `IllustrationIconOneToMany`
+- `IllustrationIconOneToOne`
+- `IllustrationIconPhone`
+- `IllustrationIconSetting`
+- `IllustrationIconStar`
+- `IllustrationIconTag`
+- `IllustrationIconTags`
+- `IllustrationIconText`
+- `IllustrationIconToggle`
+- `IllustrationIconUid`
+- `IllustrationIconUser`
+
+### `color`, `size`
+
+Supported props: `color`, `size`. Other native attributes are not forwarded.
+
+- `IconBrandTypesafeAi`
+- `IconBrandXai`
+- `IconProviderOpenai`
+
+### `size`, `stroke`
+
+Supported props: `size`, `stroke`. Other native attributes are not forwarded.
+
+- `IconRelationManyToOne`
+- `IconTrashXOff`
+- `IconTwentyStar`
+- `IconTwentyStarFilled`
+
+### `aria-hidden`, `className`, `color`, `size`, `stroke`
+
+Supported props: `aria-hidden`, `className`, `color`, `size`, `stroke`. Other native attributes are not forwarded.
+
+- `IconSparkle2`
diff --git a/packages/twenty-docs/snippets/ui/generated/icon/icon.mdx b/packages/twenty-docs/snippets/ui/generated/icon/icon.mdx
new file mode 100644
index 00000000000..86ce2aa348f
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/icon/icon.mdx
@@ -0,0 +1,40 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="aria-hidden" type="boolean">
+ Hides a decorative icon from assistive technology.
+</ParamField>
+
+<ParamField body="className" type="string">
+ Class forwarded to the resolved icon.
+</ParamField>
+
+<ParamField body="color" type="string">
+ Color forwarded to the resolved icon.
+</ParamField>
+
+<ParamField body="name" type="string" required>
+ Icon name resolved through IconsProvider. Unknown names fall back to Icon123.
+</ParamField>
+
+<ParamField body="size" type="string | number">
+ Width and height forwarded to the resolved icon.
+</ParamField>
+
+<ParamField body="stroke" type="string | number">
+ Stroke width forwarded to the resolved icon.
+</ParamField>
+
+<ParamField body="style" type="CSSProperties">
+ Styles forwarded to the resolved icon.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/icon/icons-provider.mdx b/packages/twenty-docs/snippets/ui/generated/icon/icons-provider.mdx
new file mode 100644
index 00000000000..3dcee9e812d
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/icon/icons-provider.mdx
@@ -0,0 +1,16 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="children" type="Element" required>
+ One React element containing consumers of Icon or useIcons. Loads the complete icon map asynchronously.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/icon/illustration-icon-wrapper.mdx b/packages/twenty-docs/snippets/ui/generated/icon/illustration-icon-wrapper.mdx
new file mode 100644
index 00000000000..b549eec2ba1
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/icon/illustration-icon-wrapper.mdx
@@ -0,0 +1,20 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="children" type="ReactNode">
+ Illustration content to center inside the wrapper.
+</ParamField>
+
+<ParamField body="className" type="string">
+ Class merged with the illustration wrapper styling.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/icon/thinking-orbit-loader-icon.mdx b/packages/twenty-docs/snippets/ui/generated/icon/thinking-orbit-loader-icon.mdx
new file mode 100644
index 00000000000..f69b043ecf5
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/icon/thinking-orbit-loader-icon.mdx
@@ -0,0 +1,20 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="className" type="string">
+ Class applied to the SVG. The icon is always hidden from assistive technology.
+</ParamField>
+
+<ParamField body="size" type="string | number" default="14">
+ Width and height in pixels.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/input/field.mdx b/packages/twenty-docs/snippets/ui/generated/input/field.mdx
index f7d0e7fd9c8..c033b7b1358 100644
--- a/packages/twenty-docs/snippets/ui/generated/input/field.mdx
+++ b/packages/twenty-docs/snippets/ui/generated/input/field.mdx
@@ -116,7 +116,7 @@
</ParamField>
<ParamField body="Control.defaultValue" type="string | number | readonly string[]">
-
+ The default value of the input. Use when uncontrolled.
</ParamField>
<ParamField body="Control.onValueChange" type="((value: string, eventDetails: { reason: &quot;none&quot;; event: Event; cancel: () =&gt; void; allowPropagation: () =&gt; void; isCanceled: boolean; isPropagationAllowed: boolean; trigger: Element | undefined; }) =&gt; void)">
diff --git a/packages/twenty-docs/snippets/ui/generated/surfaces/dialog.mdx b/packages/twenty-docs/snippets/ui/generated/surfaces/dialog.mdx
index 79eeb77cdb1..3b3eb0d2dfd 100644
--- a/packages/twenty-docs/snippets/ui/generated/surfaces/dialog.mdx
+++ b/packages/twenty-docs/snippets/ui/generated/surfaces/dialog.mdx
@@ -117,7 +117,7 @@
### Dialog.Popup
<ParamField body="Popup.backdrop" type="boolean | DialogBackdropProps" default="true">
-
+ Show the backdrop, customize its native props, or pass `false` to hide it.
</ParamField>
<ParamField body="Popup.className" type="string | ((state: DialogPopupState) =&gt; string | undefined)">
@@ -126,7 +126,7 @@
</ParamField>
<ParamField body="Popup.container" type="HTMLElement | ShadowRoot | RefObject&lt;HTMLElement | ShadowRoot | null&gt; | null">
-
+ Portal destination. Defaults to the theme container; `null` defers mounting.
</ParamField>
<ParamField body="Popup.finalFocus" type="boolean | RefObject&lt;HTMLElement | null&gt; | ((closeType: InteractionType) =&gt; boolean | void | HTMLElement | null)">
@@ -152,7 +152,7 @@
</ParamField>
<ParamField body="Popup.keepMounted" type="boolean">
-
+ Keeps content mounted while the dialog is closed.
</ParamField>
<ParamField body="Popup.render" type="ReactElement&lt;unknown, string | JSXElementConstructor&lt;any&gt;&gt; | ComponentRenderFn&lt;HTMLProps, DialogPopupState&gt;">
@@ -163,7 +163,7 @@
</ParamField>
<ParamField body="Popup.size" type="&quot;fullscreen&quot; | &quot;lg&quot; | &quot;md&quot; | &quot;sm&quot; | &quot;xl&quot;" default="md">
-
+ Width of the dialog, or `fullscreen` to fill the viewport.
</ParamField>
<ParamField body="Popup.style" type="CSSProperties | ((state: DialogPopupState) =&gt; CSSProperties | undefined)">
@@ -172,7 +172,7 @@
</ParamField>
<ParamField body="Popup.viewportProps" type="DialogViewportProps">
-
+ Native props and render composition for the viewport surrounding the popup.
</ParamField>
### Dialog.Title
diff --git a/packages/twenty-docs/snippets/ui/generated/surfaces/menu.mdx b/packages/twenty-docs/snippets/ui/generated/surfaces/menu.mdx
index 647aebbd7ef..6f121cc9c95 100644
--- a/packages/twenty-docs/snippets/ui/generated/surfaces/menu.mdx
+++ b/packages/twenty-docs/snippets/ui/generated/surfaces/menu.mdx
@@ -650,7 +650,7 @@
</ParamField>
<ParamField body="SubmenuTrigger.onClick" type="((event: BaseUIEvent&lt;MouseEvent&lt;HTMLDivElement, MouseEvent&gt;&gt;) =&gt; void)">
-
+ The click handler for the submenu trigger.
</ParamField>
<ParamField body="SubmenuTrigger.openOnHover" type="boolean" default="true">
diff --git a/packages/twenty-docs/snippets/ui/generated/testing/component-storybook-layout.mdx b/packages/twenty-docs/snippets/ui/generated/testing/component-storybook-layout.mdx
new file mode 100644
index 00000000000..468bd65f669
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/testing/component-storybook-layout.mdx
@@ -0,0 +1,28 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="backgroundColor" type="string">
+ Background color override.
+</ParamField>
+
+<ParamField body="children" type="Element" required>
+ The component preview element.
+</ParamField>
+
+<ParamField body="height" type="number">
+ Container height in pixels. Defaults to fit-content.
+</ParamField>
+
+<ParamField body="width" type="number">
+ Container width in pixels. When omitted, the container has a 300px minimum width.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/theme/theme-provider.mdx b/packages/twenty-docs/snippets/ui/generated/theme/theme-provider.mdx
new file mode 100644
index 00000000000..26cc646d607
--- /dev/null
+++ b/packages/twenty-docs/snippets/ui/generated/theme/theme-provider.mdx
@@ -0,0 +1,40 @@
+{/*
+ * _____ _
+ *|_ _|_ _____ _ __ | |_ _ _
+ * | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
+ * | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
+ * |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
+ * |___/
+ *
+ * This file is generated from the documentation data in packages/twenty-ui/generated.
+ * To update it, edit the component prop types or design tokens in twenty-ui and run:
+ * npx nx generate:ui twenty-docs
+ */}
+
+<ParamField body="applyToRoot" type="boolean" default="true">
+ Applies the color-scheme class to the document root. Set false for a scoped wrapper.
+</ParamField>
+
+<ParamField body="children" type="ReactNode" required>
+ Components that share this theme.
+</ParamField>
+
+<ParamField body="className" type="string">
+ Class applied to a scoped wrapper; no wrapper is created for className alone.
+</ParamField>
+
+<ParamField body="colorScheme" type="&quot;dark&quot; | &quot;light&quot;" required>
+ Explicit light or dark palette; load its stylesheet before rendering.
+</ParamField>
+
+<ParamField body="overrides" type="ThemeOverrides">
+ CSS custom-property overrides. Supplying them creates a scoped wrapper.
+</ParamField>
+
+<ParamField body="scale" type="number">
+ Root interface scale stored in --t-scale-user. Ignored for scoped providers; application CSS must consume the variable.
+</ParamField>
+
+<ParamField body="theme" type="ThemeType | typeof THEME_LIGHT">
+ Explicit resolved theme values, bypassing computed-style token resolution.
+</ParamField>
diff --git a/packages/twenty-docs/ui/components/animated-icon-crossfade.mdx b/packages/twenty-docs/ui/components/animated-icon-crossfade.mdx
new file mode 100644
index 00000000000..3d1619a8353
--- /dev/null
+++ b/packages/twenty-docs/ui/components/animated-icon-crossfade.mdx
@@ -0,0 +1,47 @@
+---
+title: AnimatedIconCrossfade
+description: Crossfade between two icons as application state changes.
+---
+
+import { StoryEmbed } from '/snippets/ui/StoryEmbed.mdx';
+import AnimatedIconCrossfadeReference from '/snippets/ui/generated/components/animated-icon-crossfade.mdx';
+
+`AnimatedIconCrossfade` displays one of two icon components according to `isActive`. It does not own the action or state. Compose it inside a labeled [Button](/ui/primitives/input/button).
+
+```tsx
+import { useState } from 'react';
+import { AnimatedIconCrossfade } from 'twenty-ui/components';
+import { IconPencil, IconX } from 'twenty-ui/icon';
+import { Button } from 'twenty-ui/primitives/input';
+
+export const EditToggle = () => {
+ const [isEditing, setIsEditing] = useState(false);
+
+ return (
+ <Button
+ onClick={() => setIsEditing(!isEditing)}
+ startIcon={
+ <AnimatedIconCrossfade
+ isActive={isEditing}
+ ActiveIcon={IconX}
+ InactiveIcon={IconPencil}
+ />
+ }
+ >
+ {isEditing ? 'Finish editing' : 'Edit record'}
+ </Button>
+ );
+};
+```
+
+`size` defaults to the small theme icon size. Keep the accessible action name on the surrounding control. The icons communicate its state visually.
+
+<StoryEmbed
+ storyId="ui-input-button-button--animated-icon-documentation"
+ title="AnimatedIconCrossfade example"
+ height={280}
+/>
+
+## Props
+
+<AnimatedIconCrossfadeReference />
diff --git a/packages/twenty-docs/ui/components/avatar-group.mdx b/packages/twenty-docs/ui/components/avatar-group.mdx
new file mode 100644
index 00000000000..11f62238cf8
--- /dev/null
+++ b/packages/twenty-docs/ui/components/avatar-group.mdx
@@ -0,0 +1,38 @@
+---
+title: AvatarGroup
+description: Overlapping avatars with an optional overflow indicator.
+---
+
+import { StoryEmbed } from '/snippets/ui/StoryEmbed.mdx';
+import AvatarGroupReference from '/snippets/ui/generated/components/avatar-group.mdx';
+
+`AvatarGroup` receives rendered avatars. Supply `overflowCount` yourself; slicing the avatars does not calculate the hidden count. `overflowAvatar` replaces the numeric indicator.
+
+```tsx
+import { AvatarGroup } from 'twenty-ui/components';
+import { Avatar } from 'twenty-ui/primitives/data-display';
+
+export const TeamAvatars = () => (
+ <AvatarGroup
+ maxVisible={2}
+ overflowCount={1}
+ avatars={[
+ <Avatar key="ada" name="Ada Lovelace" />,
+ <Avatar key="grace" name="Grace Hopper" />,
+ <Avatar key="margaret" name="Margaret Hamilton" />,
+ ]}
+ />
+);
+```
+
+Keep the member names available in surrounding content. Later avatars always render above earlier ones. `overlap` only picks the physical margin, `left` or `right`, that carries the negative offset, and `overlapOffset` sets that offset as a CSS length. An empty group without an overflow element renders nothing.
+
+<StoryEmbed
+ storyId="ui-data-display-avatargroup--default"
+ title="AvatarGroup example"
+ height={280}
+/>
+
+## Props
+
+<AvatarGroupReference />
diff --git a/packages/twenty-docs/ui/components/callout.mdx b/packages/twenty-docs/ui/components/callout.mdx
new file mode 100644
index 00000000000..d19b2529305
--- /dev/null
+++ b/packages/twenty-docs/ui/components/callout.mdx
@@ -0,0 +1,37 @@
+---
+title: Callout
+description: A message with semantic styling, an optional action, and dismissal.
+---
+
+import { StoryEmbed } from '/snippets/ui/StoryEmbed.mdx';
+import CalloutReference from '/snippets/ui/generated/components/callout.mdx';
+
+`Callout` combines a title, optional description, icon, and action. Choose `info`, `warning`, `error`, `neutral`, or `success` to match the message.
+
+```tsx
+import { Callout } from 'twenty-ui/components';
+
+export const ImportNotice = ({ onReview }: { onReview: () => void }) => (
+ <Callout
+ variant="warning"
+ title="Some records need attention"
+ description="Review the missing email addresses before importing."
+ action={{ label: 'Review records', onClick: onReview }}
+ isClosable
+ />
+);
+```
+
+Closing a closable callout updates its internal visibility and calls `onClose`. Remount it to show it again. `fullWidth` fills its container. Use `Icon` to replace the default help icon.
+
+The component does not add live-region semantics or forward native attributes. Put it in a separately labeled or announced region when that is needed.
+
+<StoryEmbed
+ storyId="ui-feedback-callout--default"
+ title="Callout example"
+ height={280}
+/>
+
+## Props
+
+<CalloutReference />
diff --git a/packages/twenty-docs/ui/components/card-picker.mdx b/packages/twenty-docs/ui/components/card-picker.mdx
new file mode 100644
index 00000000000..53e0ce307f8
--- /dev/null
+++ b/packages/twenty-docs/ui/components/card-picker.mdx
@@ -0,0 +1,26 @@
+---
+title: CardPicker
+description: A radio option presented as a card.
+---
+
+import CardPickerReference from '/snippets/ui/generated/components/card-picker.mdx';
+
+Place `CardPicker` inside [RadioGroup](/ui/primitives/input/radio-group). The group owns selection; each card supplies a value and its visible content. It uses Radio's keyboard, form, and disabled behavior.
+
+```tsx
+import { CardPicker } from 'twenty-ui/components';
+import { RadioGroup } from 'twenty-ui/primitives/input';
+
+export const ViewChoice = () => (
+ <RadioGroup aria-label="Default view" defaultValue="table">
+ <CardPicker value="table">Table view</CardPicker>
+ <CardPicker value="board">Board view</CardPicker>
+ </RadioGroup>
+);
+```
+
+Use `value` and `onValueChange` on the group for controlled selection, or `defaultValue` for an initial choice. The default card renders a div with radio semantics. Avoid nesting interactive controls in its content.
+
+## Props
+
+<CardPickerReference />
diff --git a/packages/twenty-docs/ui/components/color-scheme-picker.mdx b/packages/twenty-docs/ui/components/color-scheme-picker.mdx
new file mode 100644
index 00000000000..744afd249bb
--- /dev/null
+++ b/packages/twenty-docs/ui/components/color-scheme-picker.mdx
@@ -0,0 +1,34 @@
+---
+title: ColorSchemePicker
+description: Choose light, dark, or the system color scheme.
+---
+
+import ColorSchemePickerReference from '/snippets/ui/generated/components/color-scheme-picker.mdx';
+
+`ColorSchemePicker` is controlled through `value` and `onChange`. Supply the three labels from your application. Selecting a scheme does not persist it or change a theme provider automatically.
+
+```tsx
+import { useState } from 'react';
+import { ColorSchemePicker } from 'twenty-ui/components';
+import { type ColorScheme } from 'twenty-ui/primitives/input';
+
+export const AppearanceChoice = () => {
+ const [scheme, setScheme] = useState<ColorScheme>('System');
+
+ return (
+ <ColorSchemePicker
+ value={scheme}
+ onChange={setScheme}
+ lightLabel="Light"
+ darkLabel="Dark"
+ systemLabel="Use system setting"
+ />
+ );
+};
+```
+
+`ColorScheme` values are capitalized, while [ThemeProvider](/ui/theming) expects `light` or `dark`. Map `Light` and `Dark` to their lowercase names and resolve `System` from the system preference before passing the result to the provider. The three previews are separate button controls with Enter and Space activation. Their accessible names are `Light`, `Dark`, and `System`; the label props change only the visible captions. The selected checkmark is visual.
+
+## Props
+
+<ColorSchemePickerReference />
diff --git a/packages/twenty-docs/ui/components/command-block.mdx b/packages/twenty-docs/ui/components/command-block.mdx
new file mode 100644
index 00000000000..2c5a7a200af
--- /dev/null
+++ b/packages/twenty-docs/ui/components/command-block.mdx
@@ -0,0 +1,26 @@
+---
+title: CommandBlock
+description: Display command lines with an optional action.
+---
+
+import CommandBlockReference from '/snippets/ui/generated/components/command-block.mdx';
+
+`CommandBlock` displays each supplied command with a prompt marker. It does not execute commands or provide copying automatically. Pass a [Button](/ui/primitives/input/button) as `button` to supply an action.
+
+```tsx
+import { CommandBlock } from 'twenty-ui/components';
+import { Button } from 'twenty-ui/primitives/input';
+
+export const InstallCommand = ({ onCopy }: { onCopy: () => void }) => (
+ <CommandBlock
+ commands={['yarn add twenty-ui']}
+ button={<Button onClick={onCopy}>Copy command</Button>}
+ />
+);
+```
+
+The component accepts only `commands` and `button`. Additional native attributes are not forwarded.
+
+## Props
+
+<CommandBlockReference />
diff --git a/packages/twenty-docs/ui/components/dropdown.mdx b/packages/twenty-docs/ui/components/dropdown.mdx
index fc812ef006b..6f5a00e714b 100644
--- a/packages/twenty-docs/ui/components/dropdown.mdx
+++ b/packages/twenty-docs/ui/components/dropdown.mdx
@@ -77,7 +77,7 @@ Pass custom trigger elements through `render` so the trigger remains one interac
`Search` provides the input and navigation into the result rows. Pass `value` and `onValueChange`; compute or fetch matching results in your application. Render `Loading` while a request is pending and `Empty` when no results match. Both accept caller-provided status text.
<StoryEmbed
- storyId="ui-components-dropdown--picker"
+ storyId="ui-components-dropdown--picker-documentation"
title="Searchable picker with inline creation"
height={420}
/>
@@ -125,7 +125,7 @@ While `Search` holds text, the first enabled `OptionItem` is highlighted and Ent
Actions and single selection close by default. Set `multiple` on the root to keep option selection open. The application still owns the selected values. `closeOnClick` on actions and `closeOnSelect` on options override those defaults, including repeated actions or asynchronous progress. Use `disabled` to prevent activation while retaining the row's appearance.
<StoryEmbed
- storyId="ui-components-dropdown--multiple-selection"
+ storyId="ui-components-dropdown--multiple-selection-documentation"
title="Multiple selection"
height={420}
/>
@@ -137,7 +137,7 @@ Use `Page` for navigation that replaces the contents of the same popup. Wrap the
A page can override the root's `type`. For example, an action menu can open a searchable picker page or a form panel. Search receives focus when entering a searchable page.
<StoryEmbed
- storyId="ui-components-dropdown--pages"
+ storyId="ui-components-dropdown--pages-documentation"
title="Menu to picker page navigation"
height={420}
/>
@@ -212,7 +212,7 @@ Dropdown.Content
Place another `Dropdown.Root` inside `Content` when a control opens its own picker, such as a sort direction selector. Selecting an inner option closes only that picker and restores focus to its trigger. Escape and outside presses dismiss one layer at a time. Use `Submenu` for commands that should close the entire menu tree when selected.
<StoryEmbed
- storyId="ui-components-dropdown--nested"
+ storyId="ui-components-dropdown--nested-documentation"
title="Sort picker with a nested direction picker"
height={420}
/>
@@ -222,7 +222,7 @@ Place another `Dropdown.Root` inside `Content` when a control opens its own pick
Use `type="panel"` for form inputs. Input interaction keeps the panel open; a save action can close it. Own `open` and `onOpenChange` when another component or a shortcut needs to open the dropdown. Keep that state with the feature that coordinates the interaction.
<StoryEmbed
- storyId="ui-components-dropdown--panel"
+ storyId="ui-components-dropdown--panel-documentation"
title="Controlled form panel"
height={380}
/>
diff --git a/packages/twenty-docs/ui/components/info.mdx b/packages/twenty-docs/ui/components/info.mdx
new file mode 100644
index 00000000000..b2624e8f357
--- /dev/null
+++ b/packages/twenty-docs/ui/components/info.mdx
@@ -0,0 +1,33 @@
+---
+title: Info
+description: An inline information message with an optional button or link.
+---
+
+import { StoryEmbed } from '/snippets/ui/StoryEmbed.mdx';
+import InfoReference from '/snippets/ui/generated/components/info.mdx';
+
+`Info` displays a message with a blue or danger accent. Supply `buttonTitle` with `onClick` for an action, or with `href` for a link. When both are supplied, `href` takes precedence.
+
+```tsx
+import { Info } from 'twenty-ui/components';
+
+export const ConnectionInfo = ({ onConnect }: { onConnect: () => void }) => (
+ <Info
+ text="Connect your account to sync contacts."
+ buttonTitle="Connect account"
+ onClick={onConnect}
+ />
+);
+```
+
+Use `accent="danger"` for an error. `render` customizes the link action when `href` is supplied. The message has no automatic dismissal or announcement behavior.
+
+<StoryEmbed
+ storyId="ui-feedback-info--default"
+ title="Info example"
+ height={280}
+/>
+
+## Props
+
+<InfoReference />
diff --git a/packages/twenty-docs/ui/components/inline-banner.mdx b/packages/twenty-docs/ui/components/inline-banner.mdx
new file mode 100644
index 00000000000..db8ee20cc4e
--- /dev/null
+++ b/packages/twenty-docs/ui/components/inline-banner.mdx
@@ -0,0 +1,26 @@
+---
+title: InlineBanner
+description: A compact banner with a message, icon, and optional action.
+---
+
+import InlineBannerReference from '/snippets/ui/generated/components/inline-banner.mdx';
+
+`InlineBanner` uses the secondary [Banner](/ui/primitives/feedback/banner) treatment. Its message truncates with a tooltip for the full text. Your application owns whether the banner is rendered.
+
+```tsx
+import { InlineBanner } from 'twenty-ui/components';
+
+export const SyncBanner = ({ onRetry }: { onRetry: () => void }) => (
+ <InlineBanner
+ color="danger"
+ message="Contact sync could not finish."
+ button={{ title: 'Retry sync', onClick: onRetry }}
+ />
+);
+```
+
+`button` accepts `title`, `onClick`, `disabled`, `hidden`, and an `Icon` component. `LeftIcon` changes the leading icon. `embedded` adjusts the banner for an embedded surface. Use a separate live-region wrapper when changes should be announced.
+
+## Props
+
+<InlineBannerReference />
diff --git a/packages/twenty-docs/ui/components/json-tree.mdx b/packages/twenty-docs/ui/components/json-tree.mdx
new file mode 100644
index 00000000000..2a152ef262b
--- /dev/null
+++ b/packages/twenty-docs/ui/components/json-tree.mdx
@@ -0,0 +1,31 @@
+---
+title: JsonTree
+description: Explore JSON values with expandable nodes and custom labels.
+---
+
+import JsonTreeReference from '/snippets/ui/generated/components/json-tree.mdx';
+
+`JsonTree` displays either a JSON `value` or an array of named `entries`. Pass all empty-value and expand/collapse labels so your application controls the text.
+
+```tsx
+import { JsonTree } from 'twenty-ui/components';
+
+export const RecordDetails = () => (
+ <JsonTree
+ value={{ name: 'Acme', active: true, contacts: [] }}
+ emptyStringLabel="Empty text"
+ emptyArrayLabel="No items"
+ emptyObjectLabel="No properties"
+ arrowButtonCollapsedLabel="Expand node"
+ arrowButtonExpandedLabel="Collapse node"
+ />
+);
+```
+
+Each entry has an `id`, `label`, and JSON `value`. Use entries when display labels differ from stored keys. The default expands depths 0 and 1. Override `shouldExpandNodeInitially={({ depth }) => depth === 0}` to expand only the root; later expansion is owned by each node.
+
+`getNodeHighlighting(keyPath)` returns `blue`, `red`, `partial-blue`, or `undefined`. `onNodeValueClick` receives the displayed text: leaf values as strings, and the matching empty label for empty strings, arrays, and objects. The tree displays data and does not edit it.
+
+## Props
+
+<JsonTreeReference />
diff --git a/packages/twenty-docs/ui/components/menu-items.mdx b/packages/twenty-docs/ui/components/menu-items.mdx
new file mode 100644
index 00000000000..de72a5731de
--- /dev/null
+++ b/packages/twenty-docs/ui/components/menu-items.mdx
@@ -0,0 +1,83 @@
+---
+title: Menu rows
+description: MenuItem, MenuItemAvatar, MenuItemDraggable, and MenuItemSuggestion presentation presets.
+---
+
+import MenuItemReference from '/snippets/ui/generated/components/menu-item.mdx';
+import MenuItemAvatarReference from '/snippets/ui/generated/components/menu-item-avatar.mdx';
+import MenuItemDraggableReference from '/snippets/ui/generated/components/menu-item-draggable.mdx';
+import MenuItemSuggestionReference from '/snippets/ui/generated/components/menu-item-suggestion.mdx';
+
+These components provide row presentation. For complete menu semantics, keyboard navigation, and dismissal, use [Dropdown](/ui/components/dropdown) or [Menu](/ui/primitives/surfaces/menu).
+
+## MenuItem
+
+`MenuItem` accepts a main `text` label, leading and trailing content, supporting text, shortcut hints, and submenu indicators. `focused` and `selected` change its appearance; the application owns actual focus and selection.
+
+```tsx
+import { MenuItem } from 'twenty-ui/components';
+import { IconCopy } from 'twenty-ui/icon';
+
+export const CopyRowPreview = () => (
+ <MenuItem text="Copy record" LeftIcon={IconCopy} hotKeys={['⌘', 'C']} />
+);
+```
+
+The root is a div. `onClick` alone does not provide keyboard activation or menu semantics. Native attributes and refs are not exposed by this preset. Use `Dropdown.ActionItem` for accessible commands. Shortcut hints and `hasSubMenu` are visual; they do not register handlers or create a submenu. `isTooltipOpen` is currently accepted but unused.
+
+<MenuItemReference />
+
+## MenuItemAvatar
+
+`MenuItemAvatar` places an [Avatar](/ui/primitives/data-display/avatar) before a text label. Its `avatar` accepts `name`, `src`, `colorSeed`, `size`, and `shape`. Omit it to render no avatar.
+
+```tsx
+import { MenuItemAvatar } from 'twenty-ui/components';
+
+export const PersonRowPreview = () => (
+ <MenuItemAvatar
+ text="Ada Lovelace"
+ avatar={{ name: 'Ada Lovelace', shape: 'circle' }}
+ />
+);
+```
+
+It shares MenuItem's pointer and keyboard limitations. For a selectable person, compose an Avatar inside `Dropdown.OptionItem` instead.
+
+<MenuItemAvatarReference />
+
+## MenuItemDraggable
+
+`MenuItemDraggable` renders a menu row that can show a drag grip. The application supplies drag behavior. `gripMode` defaults to `never`, which shows no grip; `always` shows the grip, and `onHover` swaps `LeftIcon` for the grip while the row is hovered, so it shows nothing without a `LeftIcon`. `isDragDisabled` affects the appearance, not external drag handlers.
+
+```tsx
+import { MenuItemDraggable } from 'twenty-ui/components';
+
+export const ReorderRowPreview = () => (
+ <MenuItemDraggable text="Company name" gripMode="always" />
+);
+```
+
+The root remains a div without keyboard drag behavior. `isTooltipOpen` and `isHoverDisabled` are currently accepted but unused. Provide an accessible reordering interface in the surrounding application.
+
+<MenuItemDraggableReference />
+
+## MenuItemSuggestion
+
+`MenuItemSuggestion` renders a list item with optional icon and supporting text. Supplying `onClick` gives it button semantics, a tab stop, and Enter/Space activation. The `li` root then has the button role instead of `listitem`, so keep clickable suggestions in a `ul` with `role="none"`: the markup stays valid and assistive technology does not expect list items. `selected` applies visual styling and does not implement a listbox selection model.
+
+```tsx
+import { MenuItemSuggestion } from 'twenty-ui/components';
+
+export const SuggestedName = ({ onChoose }: { onChoose: () => void }) => (
+ <ul role="none">
+ <MenuItemSuggestion
+ text="Acme"
+ contextualText="Company"
+ onClick={onChoose}
+ />
+ </ul>
+);
+```
+
+<MenuItemSuggestionReference />
diff --git a/packages/twenty-docs/ui/components/menu-picker.mdx b/packages/twenty-docs/ui/components/menu-picker.mdx
new file mode 100644
index 00000000000..091ab144332
--- /dev/null
+++ b/packages/twenty-docs/ui/components/menu-picker.mdx
@@ -0,0 +1,34 @@
+---
+title: MenuPicker
+description: A compact icon button with selected styling and an optional tooltip.
+---
+
+import MenuPickerReference from '/snippets/ui/generated/components/menu-picker.mdx';
+
+`MenuPicker` renders a native button. Your application owns `selected` and the action. `selected` also controls `aria-pressed`.
+
+```tsx
+import { useState } from 'react';
+import { MenuPicker } from 'twenty-ui/components';
+import { IconLayoutKanban } from 'twenty-ui/icon';
+
+export const BoardToggle = () => {
+ const [selected, setSelected] = useState(false);
+
+ return (
+ <MenuPicker
+ id="board-toggle"
+ icon={IconLayoutKanban}
+ label="Board view"
+ selected={selected}
+ onClick={() => setSelected(!selected)}
+ />
+ );
+};
+```
+
+Keep `label` even with `showLabel={false}` because it supplies the accessible name. `tooltipContent` adds a supplementary explanation. `disabled` prevents activation. Place the button outside a form unless its default native submission behavior is appropriate.
+
+## Props
+
+<MenuPickerReference />
diff --git a/packages/twenty-docs/ui/components/navigation-bar.mdx b/packages/twenty-docs/ui/components/navigation-bar.mdx
new file mode 100644
index 00000000000..56a47e8f96c
--- /dev/null
+++ b/packages/twenty-docs/ui/components/navigation-bar.mdx
@@ -0,0 +1,44 @@
+---
+title: NavigationBar
+description: An icon navigation bar with application-owned active state.
+---
+
+import NavigationBarReference from '/snippets/ui/generated/components/navigation-bar.mdx';
+
+`NavigationBar` receives items with unique names, accessible labels, icon components, and callbacks. `activeItemName` controls which item is highlighted. The bar does not perform routing.
+
+```tsx
+import { useState } from 'react';
+import { NavigationBar } from 'twenty-ui/components';
+import { IconHome, IconSettings } from 'twenty-ui/icon';
+
+export const WorkspaceNavigation = () => {
+ const [active, setActive] = useState('home');
+
+ return (
+ <NavigationBar
+ activeItemName={active}
+ items={[
+ {
+ name: 'home',
+ label: 'Home',
+ Icon: IconHome,
+ onClick: () => setActive('home'),
+ },
+ {
+ name: 'settings',
+ label: 'Settings',
+ Icon: IconSettings,
+ onClick: () => setActive('settings'),
+ },
+ ]}
+ />
+ );
+};
+```
+
+Connect each callback to your router when the items change routes. `isHidden` hides the bar. For ordinary navigation links with tab styling, use [TabButton](/ui/components/tab-button).
+
+## Props
+
+<NavigationBarReference />
diff --git a/packages/twenty-docs/ui/components/notification-counter.mdx b/packages/twenty-docs/ui/components/notification-counter.mdx
new file mode 100644
index 00000000000..9f4113b3cc0
--- /dev/null
+++ b/packages/twenty-docs/ui/components/notification-counter.mdx
@@ -0,0 +1,25 @@
+---
+title: NotificationCounter
+description: A compact numeric badge for notification counts.
+---
+
+import NotificationCounterReference from '/snippets/ui/generated/components/notification-counter.mdx';
+
+`NotificationCounter` displays the supplied number without clamping it or hiding zero. Use the surrounding label to explain what the count means.
+
+```tsx
+import { NotificationCounter } from 'twenty-ui/components';
+import { Button } from 'twenty-ui/primitives/input';
+
+export const InboxButton = ({ count }: { count: number }) => (
+ <Button endIcon={<NotificationCounter count={count} />}>
+ Inbox ({count} unread)
+ </Button>
+);
+```
+
+`variant="secondary"` changes the badge appearance. The counter has no click handler or live-region behavior of its own.
+
+## Props
+
+<NotificationCounterReference />
diff --git a/packages/twenty-docs/ui/components/overview.mdx b/packages/twenty-docs/ui/components/overview.mdx
index 56ece78b7da..d1c10f8944a 100644
--- a/packages/twenty-docs/ui/components/overview.mdx
+++ b/packages/twenty-docs/ui/components/overview.mdx
@@ -10,19 +10,34 @@ Import shared components from `twenty-ui/components`. The code editor has its ow
## Browse components
-| Component | Purpose |
-| --------------------------------------------------------- | --------------------------------------------------------------------- |
-| [MainButton](/ui/components/input/main-button) | Prominent actions with a solid surface, elevation, and semibold text. |
-| [LightButton](/ui/components/input/light-button) | Lightweight actions with standard or subtle emphasis. |
-| [IconButton](/ui/components/input/icon-button) | Square or round icon actions built on Button. |
-| [LightIconButton](/ui/components/input/light-icon-button) | Lightweight icon actions with standard or subtle emphasis. |
-| [Section](/ui/components/section) | Related content with a heading, description, and optional action. |
-| [SettingsRow](/ui/components/settings-row) | Labeled switches for settings and filters. |
-| [Dropdown](/ui/components/dropdown) | Action menus, searchable pickers, and form panels. |
-| [TabButton](/ui/components/tab-button) | Route links and adjacent actions with the same appearance as tabs. |
-| [CodeEditor](/ui/components/code-editor) | Code editing with Monaco, an optional header, and the Twenty theme. |
-| [Toast](/ui/components/toast) | Notifications, queue management, and dismissal. |
-
-Shared components also include `AvatarGroup`, `JsonTree`, `NavigationBar`, menu-row presets, pickers, banners, and icon-button presets. Import these from `twenty-ui/components`.
+| Component | Purpose |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| [MainButton](/ui/components/input/main-button) | Prominent actions with a solid surface, elevation, and semibold text. |
+| [LightButton](/ui/components/input/light-button) | Lightweight actions with standard or subtle emphasis. |
+| [IconButton](/ui/components/input/icon-button) | Square or round icon actions built on Button. |
+| [LightIconButton](/ui/components/input/light-icon-button) | Lightweight icon actions with standard or subtle emphasis. |
+| [Section](/ui/components/section) | Related content with a heading, description, and optional action. |
+| [SettingsRow](/ui/components/settings-row) | Labeled switches for settings and filters. |
+| [Dropdown](/ui/components/dropdown) | Action menus, searchable pickers, and form panels. |
+| [TabButton](/ui/components/tab-button) | Route links and adjacent actions with the same appearance as tabs. |
+| [CodeEditor](/ui/components/code-editor) | Code editing with Monaco, an optional header, and the Twenty theme. |
+| [Toast](/ui/components/toast) | Notifications, queue management, and dismissal. |
+| [AvatarGroup](/ui/components/avatar-group) | Overlapping avatars and overflow counts. |
+| [CommandBlock](/ui/components/command-block) | Command text with an optional copy action. |
+| [JsonTree](/ui/components/json-tree) | Expandable JSON values and named entries. |
+| [NotificationCounter](/ui/components/notification-counter) | Compact numeric badges. |
+| [TintedIconTile](/ui/components/tinted-icon-tile) | Icons on theme-colored tiles. |
+| [Callout](/ui/components/callout) | Semantic messages with actions and dismissal. |
+| [Info](/ui/components/info) | Information messages with a button or link. |
+| [InlineBanner](/ui/components/inline-banner) | Compact banners with optional actions. |
+| [ToastProvider and Toaster](/ui/components/toast#application-notifications) | Notification stores, queue limits, and rendering. |
+| [CardPicker](/ui/components/card-picker) | Radio options presented as cards. |
+| [ColorSchemePicker](/ui/components/color-scheme-picker) | Light, dark, and system preference selection. |
+| [SearchInput](/ui/components/search-input) | Search text and optional filter controls. |
+| [AnimatedIconCrossfade](/ui/components/animated-icon-crossfade) | State-driven icon transitions. |
+| [Menu rows](/ui/components/menu-items) | MenuItem, MenuItemAvatar, MenuItemDraggable, and MenuItemSuggestion. |
+| [MenuPicker](/ui/components/menu-picker) | Compact icon toggles with tooltips. |
+| [NavigationBar](/ui/components/navigation-bar) | Icon navigation with application-owned routing. |
+| [RoundedLink](/ui/components/rounded-link) | Rounded external links. |
Routing, record formatting, product placeholders, and application state belong to the host application. Shared components expose data, callback, and render props for those integrations.
diff --git a/packages/twenty-docs/ui/components/rounded-link.mdx b/packages/twenty-docs/ui/components/rounded-link.mdx
new file mode 100644
index 00000000000..4f50b3a8511
--- /dev/null
+++ b/packages/twenty-docs/ui/components/rounded-link.mdx
@@ -0,0 +1,22 @@
+---
+title: RoundedLink
+description: A rounded external link with a required visible label.
+---
+
+import RoundedLinkReference from '/snippets/ui/generated/components/rounded-link.mdx';
+
+`RoundedLink` normalizes its destination and opens it in a new tab. Supply a non-empty `label`; otherwise the component renders nothing.
+
+```tsx
+import { RoundedLink } from 'twenty-ui/components';
+
+export const DocumentationLink = () => (
+ <RoundedLink href="https://docs.twenty.com" label="Documentation" />
+);
+```
+
+Clicks stop propagation before calling `onClick`. Use that callback for application behavior without interfering with navigation. Only the listed props are forwarded; for router integration or configurable link attributes, use [Button](/ui/primitives/input/button#links-and-forms).
+
+## Props
+
+<RoundedLinkReference />
diff --git a/packages/twenty-docs/ui/components/search-input.mdx b/packages/twenty-docs/ui/components/search-input.mdx
new file mode 100644
index 00000000000..b0563727e1c
--- /dev/null
+++ b/packages/twenty-docs/ui/components/search-input.mdx
@@ -0,0 +1,39 @@
+---
+title: SearchInput
+description: Controlled search text with an optional filter popup.
+---
+
+import { StoryEmbed } from '/snippets/ui/StoryEmbed.mdx';
+import SearchInputReference from '/snippets/ui/generated/components/search-input.mdx';
+
+`SearchInput` supplies a search icon and text input. `onChange` receives the new string. Filtering, fetching, and debouncing belong to your application.
+
+```tsx
+import { useState } from 'react';
+import { SearchInput } from 'twenty-ui/components';
+
+export const PeopleSearch = () => {
+ const [search, setSearch] = useState('');
+
+ return (
+ <SearchInput
+ aria-label="Search people"
+ placeholder="Name or email"
+ value={search}
+ onChange={setSearch}
+ />
+ );
+};
+```
+
+Use `aria-label` or `aria-labelledby` for an accessible name. `filterDropdown` receives a filter button that you can compose with a [Dropdown](/ui/components/dropdown) trigger using `render`. Supply `filterButtonAriaLabel` to name that action. `disabled` disables the text input; configure the optional filter controls separately.
+
+<StoryEmbed
+ storyId="ui-input-searchinput--default"
+ title="SearchInput example"
+ height={280}
+/>
+
+## Props
+
+<SearchInputReference />
diff --git a/packages/twenty-docs/ui/components/tinted-icon-tile.mdx b/packages/twenty-docs/ui/components/tinted-icon-tile.mdx
new file mode 100644
index 00000000000..5ee8f437881
--- /dev/null
+++ b/packages/twenty-docs/ui/components/tinted-icon-tile.mdx
@@ -0,0 +1,27 @@
+---
+title: TintedIconTile
+description: An icon on a tinted background derived from a theme color.
+---
+
+import TintedIconTileReference from '/snippets/ui/generated/components/tinted-icon-tile.mdx';
+
+Pass an icon component through `Icon`. The tile derives its background and foreground shades from the theme palette. Keep a text label beside it; the tile is not an interactive control.
+
+```tsx
+import { TintedIconTile } from 'twenty-ui/components';
+import { IconBuildingSkyscraper } from 'twenty-ui/icon';
+import { Text } from 'twenty-ui/primitives/typography';
+
+export const CompanyLabel = () => (
+ <>
+ <TintedIconTile Icon={IconBuildingSkyscraper} color="blue" />
+ <Text>Companies</Text>
+ </>
+);
+```
+
+`size` sets both the icon and tile dimension in pixels. Without it, the tile uses its standard dimensions and the icon uses the medium theme size. `stroke` overrides the icon stroke width.
+
+## Props
+
+<TintedIconTileReference />
diff --git a/packages/twenty-docs/ui/components/toast.mdx b/packages/twenty-docs/ui/components/toast.mdx
index f06794a74cb..2c7e10539a0 100644
--- a/packages/twenty-docs/ui/components/toast.mdx
+++ b/packages/twenty-docs/ui/components/toast.mdx
@@ -6,29 +6,68 @@ description: Display status messages with optional details, actions, and progres
import { StoryEmbed } from '/snippets/ui/StoryEmbed.mdx';
import ToastReference from '/snippets/ui/generated/feedback/toast.mdx';
+import ToastProviderReference from '/snippets/ui/generated/components/toast-provider.mdx';
+import ToasterReference from '/snippets/ui/generated/components/toaster.mdx';
`Toast` renders one notification. Your application controls when it appears, its position, and when it is removed.
+For application notifications, wrap the application in `ToastProvider`, mount one `Toaster` inside it, and use `useToast()` from descendants. Each provider owns a separate notification store.
+
<StoryEmbed
storyId="ui-feedback-toast--documentation"
title="Toast example"
height={240}
/>
+## Application notifications
+
+```tsx
+import { ToastProvider, Toaster, useToast } from 'twenty-ui/components';
+import { Button } from 'twenty-ui/primitives/input';
+
+const SaveNotificationButton = () => {
+ const { enqueueToast } = useToast();
+
+ return (
+ <Button
+ onClick={() =>
+ enqueueToast({
+ children: 'Record saved',
+ variant: 'success',
+ dedupeKey: 'record-saved',
+ })
+ }
+ >
+ Show saved notification
+ </Button>
+ );
+};
+
+export const Notifications = () => (
+ <ToastProvider limit={3}>
+ <SaveNotificationButton />
+ <Toaster />
+ </ToastProvider>
+);
+```
+
+`enqueueToast` accepts Toast props and an optional `dedupeKey`, and returns the notification ID. A matching visible key returns the existing ID without adding another notification. `closeToast(id)` dismisses one notification; `closeToast()` dismisses all visible notifications in the provider.
+
+The provider defaults to three visible notifications. Adding another dismisses the oldest visible ones. The toaster handles dismissal and exit animations. `container` overrides its portal destination; `null` defers rendering. `getToastProps` customizes each notification, while the toaster retains its ID and dismissal handler. Set `aria-label` on `Toaster` to localize its default region name, "Notifications".
+
## Dismissible notification
```tsx
import { useState } from 'react';
import { Toast } from 'twenty-ui/components';
+import { Button } from 'twenty-ui/primitives/input';
export const SaveNotification = () => {
const [visible, setVisible] = useState(false);
return (
<>
- <button type="button" onClick={() => setVisible(true)}>
- Show saved notification
- </button>
+ <Button onClick={() => setVisible(true)}>Show saved notification</Button>
{visible && (
<Toast
variant="success"
@@ -79,3 +118,13 @@ The default role is `status` with polite announcements. Use `role="alert"` for u
The reference is generated from the public component types. Native attributes, including accessible names and event handlers, are also accepted on parts that render elements.
<ToastReference />
+
+### ToastProvider
+
+<ToastProviderReference />
+
+### Toaster
+
+Native div attributes, styles, class names, and refs target the notification region.
+
+<ToasterReference />
diff --git a/packages/twenty-docs/ui/getting-started.mdx b/packages/twenty-docs/ui/getting-started.mdx
index 62ad710b923..55b432b3ff9 100644
--- a/packages/twenty-docs/ui/getting-started.mdx
+++ b/packages/twenty-docs/ui/getting-started.mdx
@@ -81,8 +81,9 @@ Each primitive family has a matching public entry point, such as
| `twenty-ui/primitives/navigation` | Action links, list items, and tabs |
| `twenty-ui/primitives/surfaces` | Cards, dialogs, menus, popovers, and tooltips |
| `twenty-ui/primitives/typography` | Text and headings |
-| `twenty-ui/icon` | Icons |
-| `twenty-ui/theme` | Theme provider, hooks, and CSS variable references |
+| `twenty-ui/icon` | [Icons and dynamic lookup](/ui/icons) |
+| `twenty-ui/testing` | [Storybook decorators and layouts](/ui/testing) |
+| `twenty-ui/theme` | Theme provider, hooks, and CSS variable references |
Import individual icons, such as `IconCheck`, from `twenty-ui/icon`. The dynamic icon provider includes the full icon catalog, so reserve it for interfaces that need to look up icons at runtime.
diff --git a/packages/twenty-docs/ui/icons.mdx b/packages/twenty-docs/ui/icons.mdx
new file mode 100644
index 00000000000..51f604d87f7
--- /dev/null
+++ b/packages/twenty-docs/ui/icons.mdx
@@ -0,0 +1,82 @@
+---
+title: Icons
+description: Named icons, dynamic lookup, illustration wrappers, and their supported props.
+---
+
+import IconReference from '/snippets/ui/generated/icon/icon.mdx';
+import IconsProviderReference from '/snippets/ui/generated/icon/icons-provider.mdx';
+import IllustrationIconWrapperReference from '/snippets/ui/generated/icon/illustration-icon-wrapper.mdx';
+import ThinkingOrbitLoaderIconReference from '/snippets/ui/generated/icon/thinking-orbit-loader-icon.mdx';
+import IconCatalog from '/snippets/ui/generated/icon/catalog.mdx';
+
+Import named icons from `twenty-ui/icon`. Use the surrounding control or visible text to communicate meaning. Decorative icons should be hidden from assistive technology.
+
+```tsx
+import { IconCheck } from 'twenty-ui/icon';
+import { Button } from 'twenty-ui/primitives/input';
+
+export const CompleteButton = () => (
+ <Button startIcon={<IconCheck />}>Complete task</Button>
+);
+```
+
+Button icon slots already size their icon and hide it from assistive technology, so the icon needs no extra props there.
+
+## Supported props
+
+Tabler icons accept `size` (number or CSS length), `stroke` (stroke width), `color`, and native SVG attributes and refs. Custom brand and illustration icons accept only the props listed in the generated catalog below. Their sizing defaults vary; pass `size` for a consistent result. Brand colors can be fixed by the artwork, so a color override is available only where listed.
+
+Custom icons that do not accept accessible attributes need a wrapper with the appropriate label or `aria-hidden`. `className` and `style` are also available only where listed. Import a specific icon when possible to avoid loading the dynamic catalog.
+
+## Dynamic icon names
+
+Use `IconsProvider` and `Icon` when names are chosen at runtime. The provider loads the complete icon map asynchronously; bundles built without code splitting, such as front components, include the whole map. Before loading completes, and for unknown names, `Icon` renders `Icon123`. The dynamic map differs from the named export catalog; do not assume every brand or illustration export can be resolved by name.
+
+```tsx
+import { Icon, IconsProvider } from 'twenty-ui/icon';
+import { Button } from 'twenty-ui/primitives/input';
+
+export const DynamicAction = ({ iconName }: { iconName: string }) => (
+ <IconsProvider>
+ <Button startIcon={<Icon name={iconName} />}>Open record</Button>
+ </IconsProvider>
+);
+```
+
+`useIcons()` exposes `getIcon(name, customDefaultIcon)` and `getIcons()` inside the same provider. `getIcons()` initially returns an empty map. `getIcon` uses the named fallback when it exists, then `Icon123`. The provider accepts one child element; use a fragment for multiple children.
+
+### Icon props
+
+<IconReference />
+
+### IconsProvider props
+
+<IconsProviderReference />
+
+## Illustration wrapper
+
+`IllustrationIconWrapper` supplies the illustration container styling and forwards native div attributes, children, styles, and refs. Every `IllustrationIcon*` export already renders inside it, so use the wrapper only to frame your own illustration content.
+
+```tsx
+import { IconCalendarEvent, IllustrationIconWrapper } from 'twenty-ui/icon';
+
+export const CalendarIllustration = () => (
+ <IllustrationIconWrapper role="img" aria-label="Calendar event">
+ <IconCalendarEvent size={32} />
+ </IllustrationIconWrapper>
+);
+```
+
+<IllustrationIconWrapperReference />
+
+## Animated loader icon
+
+`ThinkingOrbitLoaderIcon` animates continuously while mounted. It is decorative and always hidden from assistive technology. Show loading text separately and mount or remove the icon according to application state.
+
+<ThinkingOrbitLoaderIconReference />
+
+## Named icon catalog
+
+This catalog is generated from the public `twenty-ui/icon` exports and groups icons by the props they accept.
+
+<IconCatalog />
diff --git a/packages/twenty-docs/ui/primitives/feedback/loader.mdx b/packages/twenty-docs/ui/primitives/feedback/loader.mdx
index be300e74d23..36f25f8d4af 100644
--- a/packages/twenty-docs/ui/primitives/feedback/loader.mdx
+++ b/packages/twenty-docs/ui/primitives/feedback/loader.mdx
@@ -9,7 +9,10 @@ import LoaderReference from '/snippets/ui/generated/feedback/loader.mdx';
`Loader` shows an animated dot inside a small bordered capsule. Use it while an operation is in progress and the percentage is unknown. For numeric progress, use [ProgressBar](/ui/primitives/feedback/progress-bar).
-<StoryEmbed storyId="ui-feedback-loader--with-color" title="Loader example" />
+<StoryEmbed
+ storyId="ui-feedback-loader--with-color-documentation"
+ title="Loader example"
+/>
## Usage
diff --git a/packages/twenty-docs/ui/primitives/input/button-group.mdx b/packages/twenty-docs/ui/primitives/input/button-group.mdx
index 632a64a3970..00253cb9b91 100644
--- a/packages/twenty-docs/ui/primitives/input/button-group.mdx
+++ b/packages/twenty-docs/ui/primitives/input/button-group.mdx
@@ -6,7 +6,7 @@ description: Group related buttons with shared appearance and an optional frame.
import { StoryEmbed } from '/snippets/ui/StoryEmbed.mdx';
<StoryEmbed
- storyId="ui-input-button-buttongroup--default"
+ storyId="ui-input-button-buttongroup--documentation"
title="Button group"
height={220}
/>
diff --git a/packages/twenty-docs/ui/primitives/input/segmented-control.mdx b/packages/twenty-docs/ui/primitives/input/segmented-control.mdx
index 70dbfbc5b79..9a5bebcc2ef 100644
--- a/packages/twenty-docs/ui/primitives/input/segmented-control.mdx
+++ b/packages/twenty-docs/ui/primitives/input/segmented-control.mdx
@@ -10,7 +10,7 @@ import SegmentedControlReference from '/snippets/ui/generated/input/segmented-co
`SegmentedControl` is a radio group with joined options. Use it for a short, mutually exclusive choice. For navigation between content panels, use [Tabs](/ui/primitives/navigation/tabs).
<StoryEmbed
- storyId="ui-input-segmentedcontrol--default"
+ storyId="ui-input-segmentedcontrol--documentation"
title="SegmentedControl example"
/>
diff --git a/packages/twenty-docs/ui/primitives/layout/resize-handle.mdx b/packages/twenty-docs/ui/primitives/layout/resize-handle.mdx
index 3296b58839c..ac2399fbbbc 100644
--- a/packages/twenty-docs/ui/primitives/layout/resize-handle.mdx
+++ b/packages/twenty-docs/ui/primitives/layout/resize-handle.mdx
@@ -10,7 +10,7 @@ import ResizeHandleReference from '/snippets/ui/generated/layout/resize-handle.m
`ResizeHandle` manages a numeric size and exposes a focusable separator. The application applies that size to the panel; the handle does not resize another element automatically.
<StoryEmbed
- storyId="ui-layout-resizehandle--resizable"
+ storyId="ui-layout-resizehandle--resizable-documentation"
title="ResizeHandle example"
/>
diff --git a/packages/twenty-docs/ui/primitives/layout/text-direction-provider.mdx b/packages/twenty-docs/ui/primitives/layout/text-direction-provider.mdx
index 2a543d11045..307bf60bae2 100644
--- a/packages/twenty-docs/ui/primitives/layout/text-direction-provider.mdx
+++ b/packages/twenty-docs/ui/primitives/layout/text-direction-provider.mdx
@@ -10,7 +10,7 @@ import TextDirectionProviderReference from '/snippets/ui/generated/layout/text-d
`TextDirectionProvider` supplies `ltr` or `rtl` direction to Twenty UI controls. It does not render a DOM element or set an HTML `dir` attribute. Set both the provider direction and the matching document direction.
<StoryEmbed
- storyId="ui-input-segmentedcontrol--right-to-left"
+ storyId="ui-input-segmentedcontrol--right-to-left-documentation"
title="TextDirectionProvider example"
/>
diff --git a/packages/twenty-docs/ui/primitives/typography/overflowing-text-with-tooltip.mdx b/packages/twenty-docs/ui/primitives/typography/overflowing-text-with-tooltip.mdx
index 8014be46ad2..a71839ef1bc 100644
--- a/packages/twenty-docs/ui/primitives/typography/overflowing-text-with-tooltip.mdx
+++ b/packages/twenty-docs/ui/primitives/typography/overflowing-text-with-tooltip.mdx
@@ -10,7 +10,7 @@ import OverflowingTextWithTooltipReference from '/snippets/ui/generated/typograp
`OverflowingTextWithTooltip` truncates content within the available width. It checks for overflow on pointer entry and focus, then shows a tooltip only when needed. It manages tooltip visibility internally and exposes no controlled or uncontrolled open-state props.
<StoryEmbed
- storyId="ui-surfaces-overflowingtextwithtooltip--single-line-overflowing"
+ storyId="ui-surfaces-overflowingtextwithtooltip--single-line-overflowing-documentation"
title="OverflowingTextWithTooltip example"
/>
diff --git a/packages/twenty-docs/ui/testing.mdx b/packages/twenty-docs/ui/testing.mdx
new file mode 100644
index 00000000000..8aba14ac56b
--- /dev/null
+++ b/packages/twenty-docs/ui/testing.mdx
@@ -0,0 +1,76 @@
+---
+title: Storybook helpers
+description: Present component previews and variant catalogs with twenty-ui/testing.
+---
+
+import ComponentStorybookLayoutReference from '/snippets/ui/generated/testing/component-storybook-layout.mdx';
+
+`twenty-ui/testing` exposes Storybook decorators and preview layout helpers. Configure styles and a [ThemeProvider](/ui/theming) in your Storybook preview before rendering themed components.
+
+## ComponentDecorator
+
+`ComponentDecorator` wraps a story in `ComponentStorybookLayout`. Set `parameters.container.width` and `parameters.container.height` in pixels. It also reads the story's `inverted` and `accent` args to choose an optional background.
+
+```tsx
+import { Button } from 'twenty-ui/primitives/input';
+import { ComponentDecorator } from 'twenty-ui/testing';
+
+const meta = {
+ component: Button,
+ decorators: [ComponentDecorator],
+ parameters: { container: { width: 240, height: 100 } },
+};
+
+export default meta;
+
+export const Default = { args: { children: 'Save changes' } };
+```
+
+## CatalogDecorator
+
+`CatalogDecorator` renders combinations of up to four dimensions from `parameters.catalog.dimensions`. Each dimension has a `name`, `values`, a `props(value)` mapper, and an optional `labels(value)` formatter. The mapper returns the props for that cell. `parameters.catalog.options.elementContainer` accepts `width`, `style`, and `className`.
+
+```tsx
+import { Button, type ButtonVariant } from 'twenty-ui/primitives/input';
+import { CatalogDecorator } from 'twenty-ui/testing';
+
+const meta = { component: Button };
+export default meta;
+
+export const Variants = {
+ args: { children: 'Save changes' },
+ decorators: [CatalogDecorator],
+ parameters: {
+ catalog: {
+ dimensions: [
+ {
+ name: 'variant',
+ values: ['outline', 'solid', 'ghost'],
+ props: (variant: ButtonVariant) => ({ variant }),
+ },
+ ],
+ },
+ },
+};
+```
+
+## ComponentStorybookLayout
+
+Use the layout directly when composing a preview outside a decorator. It accepts one child element.
+
+```tsx
+import { Button } from 'twenty-ui/primitives/input';
+import { ComponentStorybookLayout } from 'twenty-ui/testing';
+
+export const ButtonPreview = () => (
+ <ComponentStorybookLayout width={240} height={100}>
+ <Button>Save changes</Button>
+ </ComponentStorybookLayout>
+);
+```
+
+<ComponentStorybookLayoutReference />
+
+## Documentation previews
+
+Stories embedded in the documentation must be presentational and have no `play` function. Keep interaction tests in separate stories. Share explicit `args`, `render`, `decorators`, and `parameters` when needed, rather than spreading an interaction story into a preview. The documentation embed check rejects stories marked with Storybook's `play-fn` tag, including inherited play functions.
diff --git a/packages/twenty-docs/ui/theming.mdx b/packages/twenty-docs/ui/theming.mdx
index 0b7209e15e3..c3e5ed2d20c 100644
--- a/packages/twenty-docs/ui/theming.mdx
+++ b/packages/twenty-docs/ui/theming.mdx
@@ -3,6 +3,8 @@ title: Theming
description: Use Twenty UI theme tokens and scope theme overrides to part of your application.
---
+import ThemeProviderReference from '/snippets/ui/generated/theme/theme-provider.mdx';
+
Twenty UI components read public CSS custom properties prefixed with `--t-`. Prefer semantic tokens such as `background.secondary` and `font.color.primary` when styling your own components; these values adapt to the active palette.
## Use tokens in styles
@@ -78,3 +80,13 @@ A scoped provider adds a wrapper with `display: contents`; it does not create a
Variables prefixed with `--tw-` are private component details. Use public props and `--t-` tokens instead of depending on those variables.
See the [token reference](/ui/tokens) for the available names and palette values.
+
+## Explicit values and scale
+
+The `theme` prop supplies resolved JavaScript theme values instead of reading computed styles. It also flows to nested providers unless they supply another explicit theme. This changes values read by hooks; load the appropriate stylesheet and use CSS overrides to style components.
+
+`scale` writes `--t-scale-user` on the document root. It only affects interfaces whose CSS consumes that variable and is ignored by scoped providers. `className` applies to a scoped wrapper; passing it alone does not create a wrapper. `overrides` creates a scope even when `applyToRoot` remains true.
+
+## ThemeProvider props
+
+<ThemeProviderReference />
diff --git a/packages/twenty-shared/src/constants/DocumentationPaths.ts b/packages/twenty-shared/src/constants/DocumentationPaths.ts
index b695148f188..20d942a702b 100644
--- a/packages/twenty-shared/src/constants/DocumentationPaths.ts
+++ b/packages/twenty-shared/src/constants/DocumentationPaths.ts
@@ -128,20 +128,38 @@ export const DOCUMENTATION_PATHS = {
GETTING_STARTED_KEY_FEATURES: '/getting-started/key-features',
GETTING_STARTED_QUICKSTART: '/getting-started/quickstart',
UI_ACCESSIBILITY: '/ui/accessibility',
+ UI_COMPONENTS_ANIMATED_ICON_CROSSFADE:
+ '/ui/components/animated-icon-crossfade',
+ UI_COMPONENTS_AVATAR_GROUP: '/ui/components/avatar-group',
+ UI_COMPONENTS_CALLOUT: '/ui/components/callout',
+ UI_COMPONENTS_CARD_PICKER: '/ui/components/card-picker',
UI_COMPONENTS_CODE_EDITOR: '/ui/components/code-editor',
+ UI_COMPONENTS_COLOR_SCHEME_PICKER: '/ui/components/color-scheme-picker',
+ UI_COMPONENTS_COMMAND_BLOCK: '/ui/components/command-block',
UI_COMPONENTS_DROPDOWN: '/ui/components/dropdown',
+ UI_COMPONENTS_INFO: '/ui/components/info',
+ UI_COMPONENTS_INLINE_BANNER: '/ui/components/inline-banner',
UI_COMPONENTS_INPUT_ICON_BUTTON: '/ui/components/input/icon-button',
UI_COMPONENTS_INPUT_LIGHT_BUTTON: '/ui/components/input/light-button',
UI_COMPONENTS_INPUT_LIGHT_ICON_BUTTON:
'/ui/components/input/light-icon-button',
UI_COMPONENTS_INPUT_MAIN_BUTTON: '/ui/components/input/main-button',
+ UI_COMPONENTS_JSON_TREE: '/ui/components/json-tree',
+ UI_COMPONENTS_MENU_ITEMS: '/ui/components/menu-items',
+ UI_COMPONENTS_MENU_PICKER: '/ui/components/menu-picker',
+ UI_COMPONENTS_NAVIGATION_BAR: '/ui/components/navigation-bar',
+ UI_COMPONENTS_NOTIFICATION_COUNTER: '/ui/components/notification-counter',
UI_COMPONENTS_OVERVIEW: '/ui/components/overview',
+ UI_COMPONENTS_ROUNDED_LINK: '/ui/components/rounded-link',
+ UI_COMPONENTS_SEARCH_INPUT: '/ui/components/search-input',
UI_COMPONENTS_SECTION: '/ui/components/section',
UI_COMPONENTS_SETTINGS_ROW: '/ui/components/settings-row',
UI_COMPONENTS_TAB_BUTTON: '/ui/components/tab-button',
+ UI_COMPONENTS_TINTED_ICON_TILE: '/ui/components/tinted-icon-tile',
UI_COMPONENTS_TOAST: '/ui/components/toast',
UI_DARK_MODE: '/ui/dark-mode',
UI_GETTING_STARTED: '/ui/getting-started',
+ UI_ICONS: '/ui/icons',
UI_PRIMITIVES_ACCESSIBILITY_VISIBILITY_HIDDEN:
'/ui/primitives/accessibility/visibility-hidden',
UI_PRIMITIVES_DATA_DISPLAY_AVATAR: '/ui/primitives/data-display/avatar',
@@ -193,6 +211,7 @@ export const DOCUMENTATION_PATHS = {
'/ui/primitives/typography/overflowing-text-with-tooltip',
UI_PRIMITIVES_TYPOGRAPHY_TEXT: '/ui/primitives/typography/text',
UI_SSR: '/ui/ssr',
+ UI_TESTING: '/ui/testing',
UI_THEMING: '/ui/theming',
UI_TOKENS: '/ui/tokens',
USER_GUIDE_AI_CAPABILITIES_AI_AGENTS: '/user-guide/ai/capabilities/ai-agents',
diff --git a/packages/twenty-ui/docs/DocumentationParser.ts b/packages/twenty-ui/docs/DocumentationParser.ts
index 497b8e1164d..73de0be7028 100644
--- a/packages/twenty-ui/docs/DocumentationParser.ts
+++ b/packages/twenty-ui/docs/DocumentationParser.ts
@@ -1,11 +1,54 @@
-import { Parser, type ParserOptions } from 'react-docgen-typescript';
-import type ts from 'typescript';
+import { isNonEmptyArray } from '@sniptt/guards';
+import {
+ Parser,
+ type ParserOptions,
+ type Props,
+} from 'react-docgen-typescript';
+import ts from 'typescript';
+
+import { isDefined } from '../src/utilities/utils/isDefined';
type DocComment = ReturnType<Parser['findDocComment']>;
const hasDocComment = (comment: DocComment): boolean =>
comment.fullComment.length > 0 || comment.tags.default !== undefined;
+const getDeclaredTypeOfTruncatedProp = ({
+ checker,
+ prop,
+ location,
+}: {
+ checker: ts.TypeChecker;
+ prop: ts.Symbol | undefined;
+ location: ts.Node;
+}): string | undefined => {
+ if (!isDefined(prop)) {
+ return undefined;
+ }
+
+ const propType = checker.getTypeOfSymbolAtLocation(prop, location);
+ const isTruncated =
+ checker.typeToString(propType) !==
+ checker.typeToString(propType, undefined, ts.TypeFormatFlags.NoTruncation);
+ const [declaredType, ...otherDeclaredTypes] = (
+ prop.declarations ?? []
+ ).flatMap((declaration) =>
+ ts.isPropertySignature(declaration) && isDefined(declaration.type)
+ ? [declaration.type]
+ : [],
+ );
+
+ if (
+ !isTruncated ||
+ !isDefined(declaredType) ||
+ isNonEmptyArray(otherDeclaredTypes)
+ ) {
+ return undefined;
+ }
+
+ return declaredType.getText();
+};
+
export class DocumentationParser extends Parser {
private readonly typeChecker: ts.TypeChecker;
@@ -30,4 +73,35 @@ export class DocumentationParser extends Parser {
return mostSpecificComment ?? super.findDocComment(symbol);
}
+
+ override getPropsInfo(
+ propsSymbol: ts.Symbol,
+ defaultProps?: Parameters<Parser['getPropsInfo']>[1],
+ ): Props {
+ const props = super.getPropsInfo(propsSymbol, defaultProps);
+ const propsDeclaration = propsSymbol.valueDeclaration;
+
+ if (!isDefined(propsDeclaration)) {
+ return props;
+ }
+
+ const propsType = this.typeChecker.getTypeOfSymbolAtLocation(
+ propsSymbol,
+ propsDeclaration,
+ );
+
+ for (const prop of Object.values(props)) {
+ const declaredType = getDeclaredTypeOfTruncatedProp({
+ checker: this.typeChecker,
+ prop: propsType.getProperty(prop.name),
+ location: propsDeclaration,
+ });
+
+ if (isDefined(declaredType)) {
+ prop.type = { name: declaredType };
+ }
+ }
+
+ return props;
+ }
}
diff --git a/packages/twenty-ui/docs/IconDocumentationGroup.ts b/packages/twenty-ui/docs/IconDocumentationGroup.ts
new file mode 100644
index 00000000000..d30a52697ed
--- /dev/null
+++ b/packages/twenty-ui/docs/IconDocumentationGroup.ts
@@ -0,0 +1,5 @@
+export type IconDocumentationGroup = {
+ names: string[];
+ props: string[];
+ supportsSvgAttributes: boolean;
+};
diff --git a/packages/twenty-ui/docs/animatedIconCrossfadePropDescriptions.ts b/packages/twenty-ui/docs/animatedIconCrossfadePropDescriptions.ts
new file mode 100644
index 00000000000..cdc120329a0
--- /dev/null
+++ b/packages/twenty-ui/docs/animatedIconCrossfadePropDescriptions.ts
@@ -0,0 +1,12 @@
+import { type ComponentProps } from 'react';
+
+import { type AnimatedIconCrossfade } from '../src/components/layout/AnimatedIconCrossfade/AnimatedIconCrossfade';
+
+export const ANIMATED_ICON_CROSSFADE_PROP_DESCRIPTIONS = {
+ isActive: 'Shows ActiveIcon when true and InactiveIcon otherwise.',
+ ActiveIcon: 'Icon component for the active state.',
+ InactiveIcon: 'Icon component for the inactive state.',
+ size: 'Icon dimension in pixels. Defaults to the small theme icon size.',
+} satisfies Partial<
+ Record<keyof ComponentProps<typeof AnimatedIconCrossfade>, string>
+>;
diff --git a/packages/twenty-ui/docs/avatarGroupPropDescriptions.ts b/packages/twenty-ui/docs/avatarGroupPropDescriptions.ts
new file mode 100644
index 00000000000..670303508b1
--- /dev/null
+++ b/packages/twenty-ui/docs/avatarGroupPropDescriptions.ts
@@ -0,0 +1,18 @@
+import { type ComponentProps } from 'react';
+
+import { type AvatarGroup } from '../src/components/data-display/AvatarGroup/AvatarGroup';
+
+export const AVATAR_GROUP_PROP_DESCRIPTIONS = {
+ avatars:
+ 'Avatar elements in display order. Only the first maxVisible elements are shown.',
+ className: 'Class applied to the group container.',
+ maxVisible: 'Maximum number of supplied avatars to show.',
+ overflowAvatar:
+ 'Custom trailing element, used instead of the numeric overflow indicator.',
+ overflowCount:
+ 'Number shown in the trailing +N indicator. Compute this in the application; it is not derived from avatars.',
+ overflowShape: 'Shape of the numeric overflow indicator.',
+ overlap:
+ 'Physical margin, left or right, that carries the negative overlap offset. Later avatars always render above earlier ones.',
+ overlapOffset: 'CSS length of the overlap between avatars.',
+} satisfies Partial<Record<keyof ComponentProps<typeof AvatarGroup>, string>>;
diff --git a/packages/twenty-ui/docs/calloutPropDescriptions.ts b/packages/twenty-ui/docs/calloutPropDescriptions.ts
new file mode 100644
index 00000000000..e73f9fe5e16
--- /dev/null
+++ b/packages/twenty-ui/docs/calloutPropDescriptions.ts
@@ -0,0 +1,15 @@
+import { type ComponentProps } from 'react';
+
+import { type Callout } from '../src/components/feedback/Callout/Callout';
+
+export const CALLOUT_PROP_DESCRIPTIONS = {
+ variant: 'Semantic appearance: info, warning, error, neutral, or success.',
+ title: 'Main message displayed beside the icon.',
+ description: 'Optional supporting text. Empty strings are hidden.',
+ fullWidth: 'Fills the available container width.',
+ Icon: 'Leading icon component. Defaults to the help icon.',
+ action: 'Optional footer action with a label and onClick callback.',
+ isClosable:
+ 'Shows a close button that hides the callout until it is remounted.',
+ onClose: 'Called after the close button hides the callout.',
+} satisfies Partial<Record<keyof ComponentProps<typeof Callout>, string>>;
diff --git a/packages/twenty-ui/docs/cardPickerPropDescriptions.ts b/packages/twenty-ui/docs/cardPickerPropDescriptions.ts
new file mode 100644
index 00000000000..445b94105fb
--- /dev/null
+++ b/packages/twenty-ui/docs/cardPickerPropDescriptions.ts
@@ -0,0 +1,7 @@
+import { type ComponentProps } from 'react';
+
+import { type CardPicker } from '../src/components/input/CardPicker/CardPicker';
+
+export const CARD_PICKER_PROP_DESCRIPTIONS = {
+ children: 'Card content inside the radio control.',
+} satisfies Partial<Record<keyof ComponentProps<typeof CardPicker>, string>>;
diff --git a/packages/twenty-ui/docs/colorSchemePickerPropDescriptions.ts b/packages/twenty-ui/docs/colorSchemePickerPropDescriptions.ts
new file mode 100644
index 00000000000..079b516f439
--- /dev/null
+++ b/packages/twenty-ui/docs/colorSchemePickerPropDescriptions.ts
@@ -0,0 +1,18 @@
+import { type ComponentProps } from 'react';
+
+import { type ColorSchemePicker } from '../src/components/input/ColorSchemePicker/ColorSchemePicker';
+
+export const COLOR_SCHEME_PICKER_PROP_DESCRIPTIONS = {
+ value:
+ 'Selected scheme: Light, Dark, or System. The application resolves system to a concrete theme.',
+ className: 'Class applied to the outer container.',
+ onChange: 'Called with the newly selected color scheme.',
+ lightLabel:
+ 'Visible caption for the light scheme. The control’s accessible name remains Light.',
+ darkLabel:
+ 'Visible caption for the dark scheme. The control’s accessible name remains Dark.',
+ systemLabel:
+ 'Visible caption for the system scheme. The control’s accessible name remains System.',
+} satisfies Partial<
+ Record<keyof ComponentProps<typeof ColorSchemePicker>, string>
+>;
diff --git a/packages/twenty-ui/docs/commandBlockPropDescriptions.ts b/packages/twenty-ui/docs/commandBlockPropDescriptions.ts
new file mode 100644
index 00000000000..c6285d4a3f0
--- /dev/null
+++ b/packages/twenty-ui/docs/commandBlockPropDescriptions.ts
@@ -0,0 +1,10 @@
+import { type ComponentProps } from 'react';
+
+import { type CommandBlock } from '../src/components/data-display/CommandBlock/CommandBlock';
+
+export const COMMAND_BLOCK_PROP_DESCRIPTIONS = {
+ commands:
+ 'Command lines to display. The component prefixes each line with > and does not execute commands.',
+ button:
+ 'Optional action element beside the command lines, such as a copy button.',
+} satisfies Partial<Record<keyof ComponentProps<typeof CommandBlock>, string>>;
diff --git a/packages/twenty-ui/docs/componentStorybookLayoutPropDescriptions.ts b/packages/twenty-ui/docs/componentStorybookLayoutPropDescriptions.ts
new file mode 100644
index 00000000000..4d8ed15d92d
--- /dev/null
+++ b/packages/twenty-ui/docs/componentStorybookLayoutPropDescriptions.ts
@@ -0,0 +1,13 @@
+import { type ComponentProps } from 'react';
+
+import { type ComponentStorybookLayout } from '../src/testing/ComponentStorybookLayout';
+
+export const COMPONENT_STORYBOOK_LAYOUT_PROP_DESCRIPTIONS = {
+ children: 'The component preview element.',
+ width:
+ 'Container width in pixels. When omitted, the container has a 300px minimum width.',
+ height: 'Container height in pixels. Defaults to fit-content.',
+ backgroundColor: 'Background color override.',
+} satisfies Partial<
+ Record<keyof ComponentProps<typeof ComponentStorybookLayout>, string>
+>;
diff --git a/packages/twenty-ui/docs/components.ts b/packages/twenty-ui/docs/components.ts
index 47faf499569..936b2275c05 100644
--- a/packages/twenty-ui/docs/components.ts
+++ b/packages/twenty-ui/docs/components.ts
@@ -1,3 +1,30 @@
+import { AVATAR_GROUP_PROP_DESCRIPTIONS } from './avatarGroupPropDescriptions';
+import { COMMAND_BLOCK_PROP_DESCRIPTIONS } from './commandBlockPropDescriptions';
+import { JSON_TREE_PROP_DESCRIPTIONS } from './jsonTreePropDescriptions';
+import { NOTIFICATION_COUNTER_PROP_DESCRIPTIONS } from './notificationCounterPropDescriptions';
+import { TINTED_ICON_TILE_PROP_DESCRIPTIONS } from './tintedIconTilePropDescriptions';
+import { CALLOUT_PROP_DESCRIPTIONS } from './calloutPropDescriptions';
+import { INFO_PROP_DESCRIPTIONS } from './infoPropDescriptions';
+import { INLINE_BANNER_PROP_DESCRIPTIONS } from './inlineBannerPropDescriptions';
+import { TOAST_PROVIDER_PROP_DESCRIPTIONS } from './toastProviderPropDescriptions';
+import { TOASTER_PROP_DESCRIPTIONS } from './toasterPropDescriptions';
+import { CARD_PICKER_PROP_DESCRIPTIONS } from './cardPickerPropDescriptions';
+import { COLOR_SCHEME_PICKER_PROP_DESCRIPTIONS } from './colorSchemePickerPropDescriptions';
+import { SEARCH_INPUT_PROP_DESCRIPTIONS } from './searchInputPropDescriptions';
+import { ANIMATED_ICON_CROSSFADE_PROP_DESCRIPTIONS } from './animatedIconCrossfadePropDescriptions';
+import { MENU_ITEM_PROP_DESCRIPTIONS } from './menuItemPropDescriptions';
+import { MENU_ITEM_AVATAR_PROP_DESCRIPTIONS } from './menuItemAvatarPropDescriptions';
+import { MENU_ITEM_DRAGGABLE_PROP_DESCRIPTIONS } from './menuItemDraggablePropDescriptions';
+import { MENU_ITEM_SUGGESTION_PROP_DESCRIPTIONS } from './menuItemSuggestionPropDescriptions';
+import { MENU_PICKER_PROP_DESCRIPTIONS } from './menuPickerPropDescriptions';
+import { NAVIGATION_BAR_PROP_DESCRIPTIONS } from './navigationBarPropDescriptions';
+import { ROUNDED_LINK_PROP_DESCRIPTIONS } from './roundedLinkPropDescriptions';
+import { THEME_PROVIDER_PROP_DESCRIPTIONS } from './themeProviderPropDescriptions';
+import { ICON_PROP_DESCRIPTIONS } from './iconPropDescriptions';
+import { ICONS_PROVIDER_PROP_DESCRIPTIONS } from './iconsProviderPropDescriptions';
+import { ILLUSTRATION_ICON_WRAPPER_PROP_DESCRIPTIONS } from './illustrationIconWrapperPropDescriptions';
+import { THINKING_ORBIT_LOADER_ICON_PROP_DESCRIPTIONS } from './thinkingOrbitLoaderIconPropDescriptions';
+import { COMPONENT_STORYBOOK_LAYOUT_PROP_DESCRIPTIONS } from './componentStorybookLayoutPropDescriptions';
import { ANIMATED_EXPANDABLE_CONTAINER_PROP_DESCRIPTIONS } from './animatedExpandableContainerPropDescriptions';
import { AVATAR_PROP_DESCRIPTIONS } from './avatarPropDescriptions';
import { BANNER_PROP_DESCRIPTIONS } from './bannerPropDescriptions';
@@ -13,8 +40,9 @@ import { CLICK_TO_ACTION_LINK_PROP_DESCRIPTIONS } from './clickToActionLinkPropD
import { CODE_EDITOR_HEADER_PROP_DESCRIPTIONS } from './codeEditorHeaderPropDescriptions';
import { CODE_EDITOR_PROP_DESCRIPTIONS } from './codeEditorPropDescriptions';
import { COLOR_SAMPLE_PROP_DESCRIPTIONS } from './colorSamplePropDescriptions';
-import { DIALOG_PROP_DESCRIPTIONS } from './dialogPropDescriptions';
+import { DIALOG_POPUP_PROP_DESCRIPTIONS } from './dialogPopupPropDescriptions';
import { DIALOG_TITLE_PROP_DESCRIPTIONS } from './dialogTitlePropDescriptions';
+import { DROPDOWN_PART_PROP_DESCRIPTIONS } from './dropdownPartPropDescriptions';
import { HEADING_PROP_DESCRIPTIONS } from './headingPropDescriptions';
import { HORIZONTAL_SEPARATOR_PROP_DESCRIPTIONS } from './horizontalSeparatorPropDescriptions';
import { ICON_BUTTON_PROP_DESCRIPTIONS } from './iconButtonPropDescriptions';
@@ -185,6 +213,11 @@ export const DOCUMENTED_COMPONENTS = [
source: 'primitives/input/Field/Field.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/field',
+ partPropDescriptions: {
+ Control: {
+ defaultValue: 'The default value of the input. Use when uncontrolled.',
+ },
+ },
},
{
name: 'Input',
@@ -280,8 +313,10 @@ export const DOCUMENTED_COMPONENTS = [
source: 'primitives/surfaces/Dialog/Dialog.tsx',
entryPoint: 'twenty-ui/primitives/surfaces',
slug: 'surfaces/dialog',
- propDescriptions: DIALOG_PROP_DESCRIPTIONS,
- partPropDescriptions: { Title: DIALOG_TITLE_PROP_DESCRIPTIONS },
+ partPropDescriptions: {
+ Popup: DIALOG_POPUP_PROP_DESCRIPTIONS,
+ Title: DIALOG_TITLE_PROP_DESCRIPTIONS,
+ },
},
{
name: 'AlertDialog',
@@ -294,6 +329,11 @@ export const DOCUMENTED_COMPONENTS = [
source: 'primitives/surfaces/Menu/Menu.tsx',
entryPoint: 'twenty-ui/primitives/surfaces',
slug: 'surfaces/menu',
+ partPropDescriptions: {
+ SubmenuTrigger: {
+ onClick: 'The click handler for the submenu trigger.',
+ },
+ },
},
{
name: 'Popover',
@@ -385,7 +425,11 @@ export const DOCUMENTED_COMPONENTS = [
'Submenu',
'SubmenuTrigger',
'Section',
+ 'Separator',
+ 'Loading',
+ 'Empty',
],
+ partPropDescriptions: DROPDOWN_PART_PROP_DESCRIPTIONS,
partPropDefaults: {
ActionItem: {
nativeButton: 'true when render is omitted; false otherwise',
@@ -438,4 +482,194 @@ export const DOCUMENTED_COMPONENTS = [
size: 'Padding of the tab content: sm or md.',
},
},
+ {
+ name: 'AvatarGroup',
+ source: 'components/data-display/AvatarGroup/AvatarGroup.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/avatar-group',
+ propDescriptions: AVATAR_GROUP_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'CommandBlock',
+ source: 'components/data-display/CommandBlock/CommandBlock.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/command-block',
+ propDescriptions: COMMAND_BLOCK_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'JsonTree',
+ source: 'components/data-display/JsonTree/JsonTree.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/json-tree',
+ propDescriptions: JSON_TREE_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'NotificationCounter',
+ source:
+ 'components/data-display/NotificationCounter/NotificationCounter.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/notification-counter',
+ propDescriptions: NOTIFICATION_COUNTER_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'TintedIconTile',
+ source: 'components/data-display/TintedIconTile/TintedIconTile.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/tinted-icon-tile',
+ propDescriptions: TINTED_ICON_TILE_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'Callout',
+ source: 'components/feedback/Callout/Callout.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/callout',
+ propDescriptions: CALLOUT_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'Info',
+ source: 'components/feedback/Info/Info.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/info',
+ propDescriptions: INFO_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'InlineBanner',
+ source: 'components/feedback/InlineBanner/InlineBanner.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/inline-banner',
+ propDescriptions: INLINE_BANNER_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'ToastProvider',
+ source: 'components/feedback/Toast/ToastProvider.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/toast-provider',
+ propDescriptions: TOAST_PROVIDER_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'Toaster',
+ source: 'components/feedback/Toaster/Toaster.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/toaster',
+ propDescriptions: TOASTER_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'CardPicker',
+ source: 'components/input/CardPicker/CardPicker.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/card-picker',
+ propDescriptions: CARD_PICKER_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'ColorSchemePicker',
+ source: 'components/input/ColorSchemePicker/ColorSchemePicker.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/color-scheme-picker',
+ propDescriptions: COLOR_SCHEME_PICKER_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'SearchInput',
+ source: 'components/input/SearchInput/SearchInput.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/search-input',
+ propDescriptions: SEARCH_INPUT_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'AnimatedIconCrossfade',
+ source: 'components/layout/AnimatedIconCrossfade/AnimatedIconCrossfade.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/animated-icon-crossfade',
+ propDescriptions: ANIMATED_ICON_CROSSFADE_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'MenuItem',
+ source: 'components/navigation/MenuItem/MenuItem.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/menu-item',
+ propDescriptions: MENU_ITEM_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'MenuItemAvatar',
+ source: 'components/navigation/MenuItemAvatar/MenuItemAvatar.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/menu-item-avatar',
+ propDescriptions: MENU_ITEM_AVATAR_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'MenuItemDraggable',
+ source: 'components/navigation/MenuItemDraggable/MenuItemDraggable.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/menu-item-draggable',
+ propDescriptions: MENU_ITEM_DRAGGABLE_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'MenuItemSuggestion',
+ source: 'components/navigation/MenuItemSuggestion/MenuItemSuggestion.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/menu-item-suggestion',
+ propDescriptions: MENU_ITEM_SUGGESTION_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'MenuPicker',
+ source: 'components/navigation/MenuPicker/MenuPicker.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/menu-picker',
+ propDescriptions: MENU_PICKER_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'NavigationBar',
+ source: 'components/navigation/NavigationBar/NavigationBar.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/navigation-bar',
+ propDescriptions: NAVIGATION_BAR_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'RoundedLink',
+ source: 'components/navigation/RoundedLink/RoundedLink.tsx',
+ entryPoint: 'twenty-ui/components',
+ slug: 'components/rounded-link',
+ propDescriptions: ROUNDED_LINK_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'ThemeProvider',
+ source: 'theme/ThemeProvider.tsx',
+ entryPoint: 'twenty-ui/theme',
+ slug: 'theme/theme-provider',
+ propDescriptions: THEME_PROVIDER_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'Icon',
+ source: 'icon/components/Icon.tsx',
+ entryPoint: 'twenty-ui/icon',
+ slug: 'icon/icon',
+ propDescriptions: ICON_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'IconsProvider',
+ source: 'icon/providers/IconsProvider.tsx',
+ entryPoint: 'twenty-ui/icon',
+ slug: 'icon/icons-provider',
+ propDescriptions: ICONS_PROVIDER_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'IllustrationIconWrapper',
+ source: 'icon/components/IllustrationIconWrapper.tsx',
+ entryPoint: 'twenty-ui/icon',
+ slug: 'icon/illustration-icon-wrapper',
+ propDescriptions: ILLUSTRATION_ICON_WRAPPER_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'ThinkingOrbitLoaderIcon',
+ source: 'icon/components/ThinkingOrbitLoaderIcon.tsx',
+ entryPoint: 'twenty-ui/icon',
+ slug: 'icon/thinking-orbit-loader-icon',
+ propDescriptions: THINKING_ORBIT_LOADER_ICON_PROP_DESCRIPTIONS,
+ },
+ {
+ name: 'ComponentStorybookLayout',
+ source: 'testing/ComponentStorybookLayout.tsx',
+ entryPoint: 'twenty-ui/testing',
+ slug: 'testing/component-storybook-layout',
+ propDescriptions: COMPONENT_STORYBOOK_LAYOUT_PROP_DESCRIPTIONS,
+ },
] as const;
diff --git a/packages/twenty-ui/docs/dialogPropDescriptions.ts b/packages/twenty-ui/docs/dialogPopupPropDescriptions.ts
similarity index 92%
rename from packages/twenty-ui/docs/dialogPropDescriptions.ts
rename to packages/twenty-ui/docs/dialogPopupPropDescriptions.ts
index 589de3d0e93..0040f33b1b0 100644
--- a/packages/twenty-ui/docs/dialogPropDescriptions.ts
+++ b/packages/twenty-ui/docs/dialogPopupPropDescriptions.ts
@@ -1,6 +1,6 @@
import { type DialogPopupProps } from '../src/primitives/surfaces/Dialog/types/DialogPopupProps';
-export const DIALOG_PROP_DESCRIPTIONS = {
+export const DIALOG_POPUP_PROP_DESCRIPTIONS = {
size: 'Width of the dialog, or `fullscreen` to fill the viewport.',
container:
'Portal destination. Defaults to the theme container; `null` defers mounting.',
diff --git a/packages/twenty-ui/docs/dropdownPartPropDescriptions.ts b/packages/twenty-ui/docs/dropdownPartPropDescriptions.ts
new file mode 100644
index 00000000000..05e79fe653b
--- /dev/null
+++ b/packages/twenty-ui/docs/dropdownPartPropDescriptions.ts
@@ -0,0 +1,96 @@
+import { type ComponentPropsWithRef } from 'react';
+
+import { type DropdownActionItemProps } from '../src/components/navigation/Dropdown/types/DropdownActionItemProps';
+import { type DropdownCloseProps } from '../src/components/navigation/Dropdown/types/DropdownCloseProps';
+import { type DropdownContentProps } from '../src/components/navigation/Dropdown/types/DropdownContentProps';
+import { type DropdownOptionItemProps } from '../src/components/navigation/Dropdown/types/DropdownOptionItemProps';
+import { type DropdownPageProps } from '../src/components/navigation/Dropdown/types/DropdownPageProps';
+import { type DropdownRootProps } from '../src/components/navigation/Dropdown/types/DropdownRootProps';
+import { type DropdownSearchProps } from '../src/components/navigation/Dropdown/types/DropdownSearchProps';
+import { type DropdownSectionProps } from '../src/components/navigation/Dropdown/types/DropdownSectionProps';
+import { type DropdownSubmenuTriggerProps } from '../src/components/navigation/Dropdown/types/DropdownSubmenuTriggerProps';
+
+const DROPDOWN_ROOT_PROP_DESCRIPTIONS = {
+ type: 'Interaction model: `menu` for commands and links, `picker` for search and selectable options, or `panel` for forms. It sets the ARIA roles, initial focus, and keyboard navigation.',
+ open: 'Whether the popup is open. Use with `onOpenChange` to control it.',
+ defaultOpen: 'Whether the popup is initially open when uncontrolled.',
+ onOpenChange:
+ 'Called with the next open state when the popup opens or closes.',
+ multiple:
+ 'Allows selecting several options. Options then keep the popup open and show a checkbox by default.',
+ defaultPage:
+ 'ID of the `Page` shown when the popup opens. Closing the popup resets the page history to it. Defaults to `root`.',
+} satisfies Partial<Record<keyof DropdownRootProps, string>>;
+
+const DROPDOWN_ITEM_PROP_DESCRIPTIONS = {
+ className: 'CSS class applied to the row.',
+ style: 'Inline styles applied to the row.',
+ render:
+ 'Element rendered as the row instead of a native button. Custom components must forward the supplied props and ref.',
+} satisfies Partial<Record<keyof DropdownActionItemProps, string>>;
+
+export const DROPDOWN_PART_PROP_DESCRIPTIONS = {
+ Root: DROPDOWN_ROOT_PROP_DESCRIPTIONS,
+ Content: {
+ width: 'CSS width of the popup. Numbers are in pixels.',
+ } satisfies Partial<Record<keyof DropdownContentProps, string>>,
+ ActionItem: {
+ ...DROPDOWN_ITEM_PROP_DESCRIPTIONS,
+ closeOnClick:
+ 'Closes the dropdown after activation, along with parent menus when inside a submenu. Ignored when `page` is set.',
+ page: 'ID of the `Page` to show on activation. The popup stays open, and the row shows a chevron by default.',
+ } satisfies Partial<Record<keyof DropdownActionItemProps, string>>,
+ OptionItem: {
+ ...DROPDOWN_ITEM_PROP_DESCRIPTIONS,
+ selected:
+ 'Whether the option is selected. Exposed as `aria-checked` in menus and `aria-pressed` in other dropdown types.',
+ onSelect:
+ 'Called when the option is activated. The application owns the selected value.',
+ closeOnSelect:
+ 'Closes the dropdown after selection. Defaults to `true`, or `false` when `multiple` is set.',
+ indicator:
+ 'Selection indicator: a check icon after the content, a checkbox before it, or none. Defaults to `checkbox` when `multiple` is set, otherwise `check`.',
+ } satisfies Partial<Record<keyof DropdownOptionItemProps, string>>,
+ Search: {
+ onValueChange:
+ 'Called with the search text on every change. The application filters the results.',
+ } satisfies Partial<Record<keyof DropdownSearchProps, string>>,
+ Close: {
+ 'aria-label':
+ 'Accessible name of the close control. Required because the default control only shows an icon.',
+ } satisfies Partial<Record<keyof DropdownCloseProps, string>>,
+ Page: {
+ id: 'Identifier matched by `defaultPage`, the `page` prop of actions, and `goToPage`. The page renders only while it is current.',
+ type: 'Interaction model while the page is shown. Defaults to the root `type`.',
+ } satisfies Partial<Record<keyof DropdownPageProps, string>>,
+ Back: DROPDOWN_ITEM_PROP_DESCRIPTIONS,
+ Submenu: DROPDOWN_ROOT_PROP_DESCRIPTIONS,
+ SubmenuTrigger: {
+ ...DROPDOWN_ITEM_PROP_DESCRIPTIONS,
+ openOnHover: 'Also opens the submenu when the row is hovered.',
+ delay:
+ 'Delay in milliseconds before the submenu opens on hover. Requires `openOnHover`. Defaults to `300`.',
+ closeDelay:
+ 'Delay in milliseconds before a submenu opened on hover closes. Requires `openOnHover`. Defaults to `0`.',
+ } satisfies Partial<Record<keyof DropdownSubmenuTriggerProps, string>>,
+ Section: {
+ label:
+ 'Heading displayed above the rows. It also names the group for assistive technologies.',
+ scrollable:
+ 'Caps the section height and scrolls its rows. Nest labelled sections inside it to scroll them as one list.',
+ } satisfies Partial<Record<keyof DropdownSectionProps, string>>,
+ Separator: {
+ className:
+ 'Class applied to the separator. Native div attributes and refs are also accepted.',
+ } satisfies Partial<Record<keyof ComponentPropsWithRef<'div'>, string>>,
+ Loading: {
+ children: 'Loading message announced as a polite, busy status.',
+ className:
+ 'Class applied to the status. Native div attributes and refs are also accepted.',
+ } satisfies Partial<Record<keyof ComponentPropsWithRef<'div'>, string>>,
+ Empty: {
+ children: 'Empty-state message announced as a polite status.',
+ className:
+ 'Class applied to the status. Native div attributes and refs are also accepted.',
+ } satisfies Partial<Record<keyof ComponentPropsWithRef<'div'>, string>>,
+};
diff --git a/packages/twenty-ui/docs/getIconDocumentationGroups.ts b/packages/twenty-ui/docs/getIconDocumentationGroups.ts
new file mode 100644
index 00000000000..2a582dc982c
--- /dev/null
+++ b/packages/twenty-ui/docs/getIconDocumentationGroups.ts
@@ -0,0 +1,37 @@
+import type ts from 'typescript';
+
+import { getIconProps } from './getIconProps';
+import { type IconDocumentationGroup } from './IconDocumentationGroup';
+
+export const getIconDocumentationGroups = ({
+ checker,
+ icons,
+}: {
+ checker: ts.TypeChecker;
+ icons: { name: string; symbol: ts.Symbol }[];
+}): IconDocumentationGroup[] => {
+ const groups = new Map<string, IconDocumentationGroup>();
+
+ for (const { name, symbol } of icons) {
+ const { props, supportsSvgAttributes } = getIconProps({
+ checker,
+ name,
+ symbol,
+ });
+ const key = JSON.stringify({ props, supportsSvgAttributes });
+ const group = groups.get(key) ?? {
+ names: [],
+ props,
+ supportsSvgAttributes,
+ };
+
+ group.names.push(name);
+ groups.set(key, group);
+ }
+
+ return [...groups.values()]
+ .map((group) => ({ ...group, names: group.names.sort() }))
+ .sort(({ names: [leftFirstName = ''] }, { names: [rightFirstName = ''] }) =>
+ leftFirstName.localeCompare(rightFirstName, 'en'),
+ );
+};
diff --git a/packages/twenty-ui/docs/getIconProps.ts b/packages/twenty-ui/docs/getIconProps.ts
new file mode 100644
index 00000000000..0c0d9dbe737
--- /dev/null
+++ b/packages/twenty-ui/docs/getIconProps.ts
@@ -0,0 +1,40 @@
+import type ts from 'typescript';
+
+import { isDefined } from '../src/utilities/utils/isDefined';
+
+const SHARED_SVG_PROPS = new Set(['size', 'stroke', 'color', 'title']);
+
+export const getIconProps = ({
+ checker,
+ name,
+ symbol,
+}: {
+ checker: ts.TypeChecker;
+ name: string;
+ symbol: ts.Symbol;
+}): { props: string[]; supportsSvgAttributes: boolean } => {
+ const declaration = symbol.valueDeclaration;
+
+ if (!isDefined(declaration)) {
+ throw new Error(`Could not find the declaration for ${name}`);
+ }
+
+ const type = checker.getTypeOfSymbolAtLocation(symbol, declaration);
+ const propsParameter = type.getCallSignatures()[0]?.getParameters()[0];
+
+ if (!isDefined(propsParameter)) {
+ throw new Error(`Could not read icon props for ${name}`);
+ }
+
+ const supportsSvgAttributes = declaration
+ .getSourceFile()
+ .fileName.includes('/node_modules/@tabler/');
+ const props = checker
+ .getTypeOfSymbolAtLocation(propsParameter, declaration)
+ .getProperties()
+ .filter((prop) => !supportsSvgAttributes || SHARED_SVG_PROPS.has(prop.name))
+ .map((prop) => prop.name)
+ .sort();
+
+ return { props, supportsSvgAttributes };
+};
diff --git a/packages/twenty-ui/docs/getPublicComponentExports.ts b/packages/twenty-ui/docs/getPublicComponentExports.ts
new file mode 100644
index 00000000000..7d7b369459c
--- /dev/null
+++ b/packages/twenty-ui/docs/getPublicComponentExports.ts
@@ -0,0 +1,68 @@
+import ts from 'typescript';
+
+import { isDefined } from '../src/utilities/utils/isDefined';
+
+const COMPONENT_NAME_PATTERN = /^[A-Z][a-z]/;
+const COMPONENT_SOURCE_PATTERN = /\.(tsx|d\.ts)$/;
+
+export const getPublicComponentExports = ({
+ checker,
+ entryPoints,
+}: {
+ checker: ts.TypeChecker;
+ entryPoints: { name: string; source: ts.SourceFile }[];
+}) => {
+ const components = new Map<
+ string,
+ { name: string; entryPoints: string[]; symbol: ts.Symbol }
+ >();
+
+ for (const { name: entryPoint, source } of entryPoints) {
+ const moduleSymbol = checker.getSymbolAtLocation(source);
+
+ if (!isDefined(moduleSymbol)) {
+ throw new Error(`Could not read exports from ${entryPoint}`);
+ }
+
+ for (const exported of checker.getExportsOfModule(moduleSymbol)) {
+ const symbol =
+ exported.flags & ts.SymbolFlags.Alias
+ ? checker.getAliasedSymbol(exported)
+ : exported;
+ const declaration = symbol.valueDeclaration;
+
+ if (
+ !isDefined(declaration) ||
+ !COMPONENT_NAME_PATTERN.test(exported.name) ||
+ !COMPONENT_SOURCE_PATTERN.test(declaration.getSourceFile().fileName)
+ ) {
+ continue;
+ }
+
+ const type = checker.getTypeOfSymbolAtLocation(symbol, declaration);
+ const isCallable = type.getCallSignatures().length > 0;
+ const hasComponentParts = type
+ .getProperties()
+ .some(
+ (part) =>
+ COMPONENT_NAME_PATTERN.test(part.name) &&
+ checker
+ .getTypeOfSymbolAtLocation(part, declaration)
+ .getCallSignatures().length > 0,
+ );
+
+ if (isCallable || hasComponentParts) {
+ const component = components.get(exported.name) ?? {
+ name: exported.name,
+ entryPoints: [],
+ symbol,
+ };
+
+ component.entryPoints.push(entryPoint);
+ components.set(exported.name, component);
+ }
+ }
+ }
+
+ return [...components.values()];
+};
diff --git a/packages/twenty-ui/docs/iconPropDescriptions.ts b/packages/twenty-ui/docs/iconPropDescriptions.ts
new file mode 100644
index 00000000000..22d915b9b85
--- /dev/null
+++ b/packages/twenty-ui/docs/iconPropDescriptions.ts
@@ -0,0 +1,13 @@
+import { type ComponentProps } from 'react';
+
+import { type Icon } from '../src/icon/components/Icon';
+
+export const ICON_PROP_DESCRIPTIONS = {
+ name: 'Icon name resolved through IconsProvider. Unknown names fall back to Icon123.',
+ className: 'Class forwarded to the resolved icon.',
+ style: 'Styles forwarded to the resolved icon.',
+ size: 'Width and height forwarded to the resolved icon.',
+ stroke: 'Stroke width forwarded to the resolved icon.',
+ color: 'Color forwarded to the resolved icon.',
+ 'aria-hidden': 'Hides a decorative icon from assistive technology.',
+} satisfies Partial<Record<keyof ComponentProps<typeof Icon>, string>>;
diff --git a/packages/twenty-ui/docs/iconsProviderPropDescriptions.ts b/packages/twenty-ui/docs/iconsProviderPropDescriptions.ts
new file mode 100644
index 00000000000..3889f3c48f9
--- /dev/null
+++ b/packages/twenty-ui/docs/iconsProviderPropDescriptions.ts
@@ -0,0 +1,8 @@
+import { type ComponentProps } from 'react';
+
+import { type IconsProvider } from '../src/icon/providers/IconsProvider';
+
+export const ICONS_PROVIDER_PROP_DESCRIPTIONS = {
+ children:
+ 'One React element containing consumers of Icon or useIcons. Loads the complete icon map asynchronously.',
+} satisfies Partial<Record<keyof ComponentProps<typeof IconsProvider>, string>>;
diff --git a/packages/twenty-ui/docs/illustrationIconWrapperPropDescriptions.ts b/packages/twenty-ui/docs/illustrationIconWrapperPropDescriptions.ts
new file mode 100644
index 00000000000..9c9edd3027d
--- /dev/null
+++ b/packages/twenty-ui/docs/illustrationIconWrapperPropDescriptions.ts
@@ -0,0 +1,10 @@
+import { type ComponentProps } from 'react';
+
+import { type IllustrationIconWrapper } from '../src/icon/components/IllustrationIconWrapper';
+
+export const ILLUSTRATION_ICON_WRAPPER_PROP_DESCRIPTIONS = {
+ children: 'Illustration content to center inside the wrapper.',
+ className: 'Class merged with the illustration wrapper styling.',
+} satisfies Partial<
+ Record<keyof ComponentProps<typeof IllustrationIconWrapper>, string>
+>;
diff --git a/packages/twenty-ui/docs/infoPropDescriptions.ts b/packages/twenty-ui/docs/infoPropDescriptions.ts
new file mode 100644
index 00000000000..33138844d6a
--- /dev/null
+++ b/packages/twenty-ui/docs/infoPropDescriptions.ts
@@ -0,0 +1,14 @@
+import { type ComponentProps } from 'react';
+
+import { type Info } from '../src/components/feedback/Info/Info';
+
+export const INFO_PROP_DESCRIPTIONS = {
+ accent: 'Information or danger styling.',
+ text: 'Message displayed beside the information icon.',
+ buttonTitle:
+ 'Visible label for the optional action. Requires href or onClick.',
+ onClick: 'Action callback when href is absent.',
+ href: 'Action destination. Takes precedence over onClick.',
+ render:
+ 'Custom render element for the link action, forwarded to Button when href is supplied.',
+} satisfies Partial<Record<keyof ComponentProps<typeof Info>, string>>;
diff --git a/packages/twenty-ui/docs/inlineBannerPropDescriptions.ts b/packages/twenty-ui/docs/inlineBannerPropDescriptions.ts
new file mode 100644
index 00000000000..d1a62392cf8
--- /dev/null
+++ b/packages/twenty-ui/docs/inlineBannerPropDescriptions.ts
@@ -0,0 +1,13 @@
+import { type ComponentProps } from 'react';
+
+import { type InlineBanner } from '../src/components/feedback/InlineBanner/InlineBanner';
+
+export const INLINE_BANNER_PROP_DESCRIPTIONS = {
+ color: 'Banner palette color. An omitted color uses Banner’s default.',
+ message: 'Message, truncated with its full text available in a tooltip.',
+ embedded: 'Uses the embedded banner appearance.',
+ button:
+ 'Optional action with title, onClick, hidden, disabled, and Icon fields.',
+ LeftIcon: 'Leading icon component. Defaults to the information icon.',
+ className: 'Class applied to the banner.',
+} satisfies Partial<Record<keyof ComponentProps<typeof InlineBanner>, string>>;
diff --git a/packages/twenty-ui/docs/isIconComponent.ts b/packages/twenty-ui/docs/isIconComponent.ts
new file mode 100644
index 00000000000..1a646c892cb
--- /dev/null
+++ b/packages/twenty-ui/docs/isIconComponent.ts
@@ -0,0 +1,22 @@
+import { type IconComponentProps } from '../src/icon/types/IconComponent';
+
+const ICON_COMPONENT_PROP_NAMES = new Set(
+ Object.keys({
+ 'aria-hidden': true,
+ className: true,
+ color: true,
+ size: true,
+ stroke: true,
+ style: true,
+ } satisfies Record<keyof IconComponentProps, true>),
+);
+
+export const isIconComponent = ({
+ props,
+ supportsSvgAttributes,
+}: {
+ props: string[];
+ supportsSvgAttributes: boolean;
+}): boolean =>
+ supportsSvgAttributes ||
+ props.every((prop) => ICON_COMPONENT_PROP_NAMES.has(prop));
diff --git a/packages/twenty-ui/docs/jsonTreePropDescriptions.ts b/packages/twenty-ui/docs/jsonTreePropDescriptions.ts
new file mode 100644
index 00000000000..7ac52eba515
--- /dev/null
+++ b/packages/twenty-ui/docs/jsonTreePropDescriptions.ts
@@ -0,0 +1,22 @@
+import { type ComponentProps } from 'react';
+
+import { type JsonTree } from '../src/components/data-display/JsonTree/JsonTree';
+
+export const JSON_TREE_PROP_DESCRIPTIONS = {
+ value: 'JSON value to display. Supply value or entries, not both.',
+ entries:
+ 'Named entries with stable id, label, and JSON value fields. Supply entries or value, not both.',
+ getNodeHighlighting:
+ 'Returns blue, red, or partial-blue highlighting for a node key path.',
+ shouldExpandNodeInitially:
+ 'Chooses initial expansion from the node keyPath and depth. The default expands the first two depths.',
+ emptyStringLabel: 'Display text for an empty string.',
+ emptyArrayLabel: 'Display text for an empty array.',
+ emptyObjectLabel: 'Display text for an empty object.',
+ arrowButtonCollapsedLabel:
+ 'Accessible label for the expand control on a collapsed node.',
+ arrowButtonExpandedLabel:
+ 'Accessible label for the collapse control on an expanded node.',
+ onNodeValueClick:
+ 'Called with the clicked value as displayed: leaf values as strings, and the empty label for empty strings, arrays, and objects.',
+} satisfies Partial<Record<keyof ComponentProps<typeof JsonTree>, string>>;
diff --git a/packages/twenty-ui/docs/menuItemAvatarPropDescriptions.ts b/packages/twenty-ui/docs/menuItemAvatarPropDescriptions.ts
new file mode 100644
index 00000000000..00a0bdae551
--- /dev/null
+++ b/packages/twenty-ui/docs/menuItemAvatarPropDescriptions.ts
@@ -0,0 +1,23 @@
+import { type ComponentProps } from 'react';
+
+import { type MenuItemAvatar } from '../src/components/navigation/MenuItemAvatar/MenuItemAvatar';
+
+export const MENU_ITEM_AVATAR_PROP_DESCRIPTIONS = {
+ accent: 'Default, danger, or placeholder row styling.',
+ className: 'Class applied to the row.',
+ iconButtons: 'Trailing action elements.',
+ isIconDisplayedOnHoverOnly: 'Reveals trailing action elements only on hover.',
+ isTooltipOpen: 'Accepted for compatibility; currently has no effect.',
+ avatar:
+ 'Avatar name, source, color seed, size, and shape. Omit to hide the avatar.',
+ onClick:
+ 'Pointer activation callback. The row itself does not add keyboard or menu semantics.',
+ onMouseEnter: 'Pointer-entry callback on the row.',
+ onMouseLeave: 'Pointer-exit callback on the row.',
+ testId: 'Value of the row’s data-testid attribute.',
+ text: 'Main row label.',
+ hasSubMenu: 'Shows a submenu chevron; does not create a submenu.',
+ contextualText: 'Supporting text beside the main label.',
+} satisfies Partial<
+ Record<keyof ComponentProps<typeof MenuItemAvatar>, string>
+>;
diff --git a/packages/twenty-ui/docs/menuItemDraggablePropDescriptions.ts b/packages/twenty-ui/docs/menuItemDraggablePropDescriptions.ts
new file mode 100644
index 00000000000..e1d2f1e6b5e
--- /dev/null
+++ b/packages/twenty-ui/docs/menuItemDraggablePropDescriptions.ts
@@ -0,0 +1,24 @@
+import { type ComponentProps } from 'react';
+
+import { type MenuItemDraggable } from '../src/components/navigation/MenuItemDraggable/MenuItemDraggable';
+
+export const MENU_ITEM_DRAGGABLE_PROP_DESCRIPTIONS = {
+ LeftIcon: 'Leading icon component.',
+ withIconContainer: 'Places leading content in an icon container.',
+ accent: 'Default, danger, or placeholder row styling.',
+ iconButtons: 'Trailing action elements.',
+ isTooltipOpen: 'Accepted for compatibility; currently has no effect.',
+ onClick:
+ 'Pointer activation callback. The row itself does not add keyboard or menu semantics.',
+ text: 'Main row label.',
+ contextualText: 'Supporting text beside the main label.',
+ className: 'Class applied to the row.',
+ isIconDisplayedOnHoverOnly: 'Reveals trailing action elements only on hover.',
+ gripMode:
+ 'Grip visibility: never, always, or onHover. onHover swaps LeftIcon for the grip on hover and shows no grip without LeftIcon. Does not implement dragging.',
+ isDragDisabled:
+ 'Disables drag appearance without installing or removing drag handlers.',
+ isHoverDisabled: 'Accepted for compatibility; currently has no effect.',
+} satisfies Partial<
+ Record<keyof ComponentProps<typeof MenuItemDraggable>, string>
+>;
diff --git a/packages/twenty-ui/docs/menuItemPropDescriptions.ts b/packages/twenty-ui/docs/menuItemPropDescriptions.ts
new file mode 100644
index 00000000000..6193e7ba813
--- /dev/null
+++ b/packages/twenty-ui/docs/menuItemPropDescriptions.ts
@@ -0,0 +1,33 @@
+import { type ComponentProps } from 'react';
+
+import { type MenuItem } from '../src/components/navigation/MenuItem/MenuItem';
+
+export const MENU_ITEM_PROP_DESCRIPTIONS = {
+ accent: 'Default, danger, or placeholder row styling.',
+ className: 'Class applied to the row.',
+ withIconContainer: 'Places leading content in an icon container.',
+ withIconContainerBackground:
+ 'Adds a background to the leading icon container.',
+ iconButtons: 'Trailing action elements.',
+ isIconDisplayedOnHoverOnly: 'Reveals trailing action elements only on hover.',
+ isTooltipOpen: 'Accepted for compatibility; currently has no effect.',
+ LeftIcon: 'Leading icon component.',
+ iconThemeColor: 'Theme color for the leading icon.',
+ LeftComponent: 'Custom leading content.',
+ RightIcon: 'Trailing icon component.',
+ RightComponent: 'Custom trailing content.',
+ onClick:
+ 'Pointer activation callback. The row itself does not add keyboard or menu semantics.',
+ onMouseEnter: 'Pointer-entry callback on the row.',
+ onMouseLeave: 'Pointer-exit callback on the row.',
+ testId: 'Value of the row’s data-testid attribute.',
+ disabled: 'Disables activation and applies disabled styling.',
+ text: 'Main row label.',
+ contextualTextPosition: 'Position of the supporting text.',
+ contextualText: 'Supporting text beside the main label.',
+ hasSubMenu: 'Shows a submenu chevron; does not create a submenu.',
+ focused: 'Applies focused appearance without moving DOM focus.',
+ selected: 'Applies selected appearance without owning selection state.',
+ hotKeys: 'Visible shortcut hints. Register handlers in the application.',
+ isSubMenuOpened: 'Applies the open treatment to the submenu chevron.',
+} satisfies Partial<Record<keyof ComponentProps<typeof MenuItem>, string>>;
diff --git a/packages/twenty-ui/docs/menuItemSuggestionPropDescriptions.ts b/packages/twenty-ui/docs/menuItemSuggestionPropDescriptions.ts
new file mode 100644
index 00000000000..81a99fc7d6a
--- /dev/null
+++ b/packages/twenty-ui/docs/menuItemSuggestionPropDescriptions.ts
@@ -0,0 +1,17 @@
+import { type ComponentProps } from 'react';
+
+import { type MenuItemSuggestion } from '../src/components/navigation/MenuItemSuggestion/MenuItemSuggestion';
+
+export const MENU_ITEM_SUGGESTION_PROP_DESCRIPTIONS = {
+ LeftIcon: 'Leading icon component.',
+ withIconContainer: 'Places leading content in an icon container.',
+ text: 'Main row label.',
+ contextualText: 'Supporting text beside the main label.',
+ contextualTextPosition: 'Position of the supporting text.',
+ selected: 'Applies selected styling. The application owns selection.',
+ className: 'Class applied to the row.',
+ onClick:
+ 'Activation callback. When supplied, the row gains button semantics, a tab stop, and Enter/Space activation.',
+} satisfies Partial<
+ Record<keyof ComponentProps<typeof MenuItemSuggestion>, string>
+>;
diff --git a/packages/twenty-ui/docs/menuPickerPropDescriptions.ts b/packages/twenty-ui/docs/menuPickerPropDescriptions.ts
new file mode 100644
index 00000000000..54d57b07810
--- /dev/null
+++ b/packages/twenty-ui/docs/menuPickerPropDescriptions.ts
@@ -0,0 +1,18 @@
+import { type ComponentProps } from 'react';
+
+import { type MenuPicker } from '../src/components/navigation/MenuPicker/MenuPicker';
+
+export const MENU_PICKER_PROP_DESCRIPTIONS = {
+ id: 'Button ID.',
+ className: 'Class applied to the button.',
+ disabled: 'Disables the button.',
+ icon: 'Leading icon component.',
+ label: 'Button label and accessible name, including when showLabel is false.',
+ onClick: 'Activation callback.',
+ selected: 'Controls selected styling and aria-pressed.',
+ showLabel: 'Shows the visible label beside the icon.',
+ testId: 'Value of the button’s data-testid attribute.',
+ tooltipContent: 'Optional tooltip text.',
+ tooltipDelay: 'Hover delay in milliseconds.',
+ tooltipOffset: 'Distance between the button and tooltip in pixels.',
+} satisfies Partial<Record<keyof ComponentProps<typeof MenuPicker>, string>>;
diff --git a/packages/twenty-ui/docs/navigationBarPropDescriptions.ts b/packages/twenty-ui/docs/navigationBarPropDescriptions.ts
new file mode 100644
index 00000000000..e29dbb1c58b
--- /dev/null
+++ b/packages/twenty-ui/docs/navigationBarPropDescriptions.ts
@@ -0,0 +1,11 @@
+import { type ComponentProps } from 'react';
+
+import { type NavigationBar } from '../src/components/navigation/NavigationBar/NavigationBar';
+
+export const NAVIGATION_BAR_PROP_DESCRIPTIONS = {
+ activeItemName:
+ 'Name of the item to highlight. The application owns navigation.',
+ isHidden: 'Hides the bar visually and from the accessibility tree.',
+ items:
+ 'Navigation items with a unique name, accessible label, Icon component, and onClick callback.',
+} satisfies Partial<Record<keyof ComponentProps<typeof NavigationBar>, string>>;
diff --git a/packages/twenty-ui/docs/notificationCounterPropDescriptions.ts b/packages/twenty-ui/docs/notificationCounterPropDescriptions.ts
new file mode 100644
index 00000000000..3f482c8e7cc
--- /dev/null
+++ b/packages/twenty-ui/docs/notificationCounterPropDescriptions.ts
@@ -0,0 +1,11 @@
+import { type ComponentProps } from 'react';
+
+import { type NotificationCounter } from '../src/components/data-display/NotificationCounter/NotificationCounter';
+
+export const NOTIFICATION_COUNTER_PROP_DESCRIPTIONS = {
+ count: 'Number to display as supplied, without clamping or hiding zero.',
+ variant: 'Primary or secondary badge styling.',
+ className: 'Class applied to the badge.',
+} satisfies Partial<
+ Record<keyof ComponentProps<typeof NotificationCounter>, string>
+>;
diff --git a/packages/twenty-ui/docs/roundedLinkPropDescriptions.ts b/packages/twenty-ui/docs/roundedLinkPropDescriptions.ts
new file mode 100644
index 00000000000..93d612e0195
--- /dev/null
+++ b/packages/twenty-ui/docs/roundedLinkPropDescriptions.ts
@@ -0,0 +1,11 @@
+import { type ComponentProps } from 'react';
+
+import { type RoundedLink } from '../src/components/navigation/RoundedLink/RoundedLink';
+
+export const ROUNDED_LINK_PROP_DESCRIPTIONS = {
+ href: 'Destination URL, normalized by the safe-URL helper. Opens in a new tab.',
+ label: 'Visible link text. An absent or empty label renders nothing.',
+ color: 'Label text color: primary or secondary.',
+ onClick: 'Click callback after propagation is stopped.',
+ className: 'Class applied to the link.',
+} satisfies Partial<Record<keyof ComponentProps<typeof RoundedLink>, string>>;
diff --git a/packages/twenty-ui/docs/searchInputPropDescriptions.ts b/packages/twenty-ui/docs/searchInputPropDescriptions.ts
new file mode 100644
index 00000000000..1afc606ae89
--- /dev/null
+++ b/packages/twenty-ui/docs/searchInputPropDescriptions.ts
@@ -0,0 +1,21 @@
+import { type ComponentProps } from 'react';
+
+import { type SearchInput } from '../src/components/input/SearchInput/SearchInput';
+
+export const SEARCH_INPUT_PROP_DESCRIPTIONS = {
+ value: 'Current search text.',
+ onChange:
+ 'Called with the new text, not a DOM change event. The application owns filtering.',
+ placeholder:
+ 'Hint shown when the input is empty. Also used as the accessible name if no explicit label is supplied.',
+ filterDropdown: 'Renders a filter popup around the supplied filter button.',
+ autoFocus: 'Focuses the input when mounted.',
+ disabled:
+ 'Disables the text input. Configure filter popup controls separately.',
+ className: 'Class applied to the wrapper.',
+ id: 'Input ID, generated when omitted.',
+ filterButtonAriaLabel: 'Accessible label for the optional filter button.',
+ 'aria-label': 'Accessible name when aria-labelledby is absent.',
+ 'aria-labelledby':
+ 'ID of the element that labels the input. Takes precedence over aria-label.',
+} satisfies Partial<Record<keyof ComponentProps<typeof SearchInput>, string>>;
diff --git a/packages/twenty-ui/docs/themeProviderPropDescriptions.ts b/packages/twenty-ui/docs/themeProviderPropDescriptions.ts
new file mode 100644
index 00000000000..ce70b97d1b4
--- /dev/null
+++ b/packages/twenty-ui/docs/themeProviderPropDescriptions.ts
@@ -0,0 +1,19 @@
+import { type ComponentProps } from 'react';
+
+import { type ThemeProvider } from '../src/theme/ThemeProvider';
+
+export const THEME_PROVIDER_PROP_DESCRIPTIONS = {
+ children: 'Components that share this theme.',
+ colorScheme:
+ 'Explicit light or dark palette; load its stylesheet before rendering.',
+ applyToRoot:
+ 'Applies the color-scheme class to the document root. Set false for a scoped wrapper.',
+ overrides:
+ 'CSS custom-property overrides. Supplying them creates a scoped wrapper.',
+ className:
+ 'Class applied to a scoped wrapper; no wrapper is created for className alone.',
+ scale:
+ 'Root interface scale stored in --t-scale-user. Ignored for scoped providers; application CSS must consume the variable.',
+ theme:
+ 'Explicit resolved theme values, bypassing computed-style token resolution.',
+} satisfies Partial<Record<keyof ComponentProps<typeof ThemeProvider>, string>>;
diff --git a/packages/twenty-ui/docs/thinkingOrbitLoaderIconPropDescriptions.ts b/packages/twenty-ui/docs/thinkingOrbitLoaderIconPropDescriptions.ts
new file mode 100644
index 00000000000..d37b098c6fa
--- /dev/null
+++ b/packages/twenty-ui/docs/thinkingOrbitLoaderIconPropDescriptions.ts
@@ -0,0 +1,11 @@
+import { type ComponentProps } from 'react';
+
+import { type ThinkingOrbitLoaderIcon } from '../src/icon/components/ThinkingOrbitLoaderIcon';
+
+export const THINKING_ORBIT_LOADER_ICON_PROP_DESCRIPTIONS = {
+ size: 'Width and height in pixels.',
+ className:
+ 'Class applied to the SVG. The icon is always hidden from assistive technology.',
+} satisfies Partial<
+ Record<keyof ComponentProps<typeof ThinkingOrbitLoaderIcon>, string>
+>;
diff --git a/packages/twenty-ui/docs/tintedIconTilePropDescriptions.ts b/packages/twenty-ui/docs/tintedIconTilePropDescriptions.ts
new file mode 100644
index 00000000000..62c3e18dd4f
--- /dev/null
+++ b/packages/twenty-ui/docs/tintedIconTilePropDescriptions.ts
@@ -0,0 +1,13 @@
+import { type ComponentProps } from 'react';
+
+import { type TintedIconTile } from '../src/components/data-display/TintedIconTile/TintedIconTile';
+
+export const TINTED_ICON_TILE_PROP_DESCRIPTIONS = {
+ Icon: 'Icon component rendered inside the tinted tile.',
+ color:
+ 'Theme palette name used to derive the background and icon shades. Invalid names use the default theme color.',
+ size: 'Icon and tile dimension in pixels. When omitted, the icon uses the medium theme size.',
+ stroke: 'Icon stroke width. Defaults to the medium theme stroke.',
+} satisfies Partial<
+ Record<keyof ComponentProps<typeof TintedIconTile>, string>
+>;
diff --git a/packages/twenty-ui/docs/toastProviderPropDescriptions.ts b/packages/twenty-ui/docs/toastProviderPropDescriptions.ts
new file mode 100644
index 00000000000..4ba963b08ab
--- /dev/null
+++ b/packages/twenty-ui/docs/toastProviderPropDescriptions.ts
@@ -0,0 +1,10 @@
+import { type ComponentProps } from 'react';
+
+import { type ToastProvider } from '../src/components/feedback/Toast/ToastProvider';
+
+export const TOAST_PROVIDER_PROP_DESCRIPTIONS = {
+ children:
+ 'Application content and a Toaster sharing this notification store.',
+ limit:
+ 'Maximum number of visible toasts, read once when the provider mounts. Must be a positive integer. Adding a toast above the limit dismisses the oldest visible notifications.',
+} satisfies Partial<Record<keyof ComponentProps<typeof ToastProvider>, string>>;
diff --git a/packages/twenty-ui/docs/toasterPropDescriptions.ts b/packages/twenty-ui/docs/toasterPropDescriptions.ts
new file mode 100644
index 00000000000..c8c00255c76
--- /dev/null
+++ b/packages/twenty-ui/docs/toasterPropDescriptions.ts
@@ -0,0 +1,11 @@
+import { type ComponentProps } from 'react';
+
+import { type Toaster } from '../src/components/feedback/Toaster/Toaster';
+
+export const TOASTER_PROP_DESCRIPTIONS = {
+ container:
+ 'Portal destination. Omit to use the theme container or document.body; null defers rendering.',
+ getToastProps:
+ 'Customizes each notification’s Toast props. The toaster owns id, ref, and dismissal.',
+ render: 'Custom root element composed through Base UI.',
+} satisfies Partial<Record<keyof ComponentProps<typeof Toaster>, string>>;
diff --git a/packages/twenty-ui/generated/components.docs.json b/packages/twenty-ui/generated/components.docs.json
index 4f562598260..890520d1f46 100644
--- a/packages/twenty-ui/generated/components.docs.json
+++ b/packages/twenty-ui/generated/components.docs.json
@@ -1465,7 +1465,7 @@
"type": "string | number | readonly string[]",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "The default value of the input. Use when uncontrolled."
},
{
"name": "onValueChange",
@@ -3659,7 +3659,7 @@
"type": "boolean | DialogBackdropProps",
"required": false,
"defaultValue": "true",
- "description": ""
+ "description": "Show the backdrop, customize its native props, or pass `false` to hide it."
},
{
"name": "className",
@@ -3673,7 +3673,7 @@
"type": "HTMLElement | ShadowRoot | RefObject<HTMLElement | ShadowRoot | null> | null",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Portal destination. Defaults to the theme container; `null` defers mounting."
},
{
"name": "finalFocus",
@@ -3694,7 +3694,7 @@
"type": "boolean",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Keeps content mounted while the dialog is closed."
},
{
"name": "render",
@@ -3708,7 +3708,7 @@
"type": "\"fullscreen\" | \"lg\" | \"md\" | \"sm\" | \"xl\"",
"required": false,
"defaultValue": "md",
- "description": ""
+ "description": "Width of the dialog, or `fullscreen` to fill the viewport."
},
{
"name": "style",
@@ -3722,7 +3722,7 @@
"type": "DialogViewportProps",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Native props and render composition for the viewport surrounding the popup."
}
]
},
@@ -5112,7 +5112,7 @@
"type": "((event: BaseUIEvent<MouseEvent<HTMLDivElement, MouseEvent>>) => void)",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "The click handler for the submenu trigger."
},
{
"name": "openOnHover",
@@ -6758,42 +6758,42 @@
"type": "boolean",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Whether the popup is initially open when uncontrolled."
},
{
"name": "defaultPage",
"type": "string",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "ID of the `Page` shown when the popup opens. Closing the popup resets the page history to it. Defaults to `root`."
},
{
"name": "multiple",
"type": "boolean",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Allows selecting several options. Options then keep the popup open and show a checkbox by default."
},
{
"name": "onOpenChange",
"type": "((open: boolean) => void)",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Called with the next open state when the popup opens or closes."
},
{
"name": "open",
"type": "boolean",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Whether the popup is open. Use with `onOpenChange` to control it."
},
{
"name": "type",
"type": "\"menu\" | \"panel\" | \"picker\"",
"required": true,
"defaultValue": null,
- "description": ""
+ "description": "Interaction model: `menu` for commands and links, `picker` for search and selectable options, or `panel` for forms. It sets the ARIA roles, initial focus, and keyboard navigation."
}
]
},
@@ -6964,7 +6964,7 @@
"type": "Width<string | number>",
"required": false,
"defaultValue": "200",
- "description": ""
+ "description": "CSS width of the popup. Numbers are in pixels."
}
]
},
@@ -6976,14 +6976,14 @@
"type": "string",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "CSS class applied to the row."
},
{
"name": "closeOnClick",
"type": "boolean",
"required": false,
"defaultValue": "true",
- "description": ""
+ "description": "Closes the dropdown after activation, along with parent menus when inside a submenu. Ignored when `page` is set."
},
{
"name": "color",
@@ -7046,14 +7046,14 @@
"type": "string",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "ID of the `Page` to show on activation. The popup stays open, and the row shows a chevron by default."
},
{
"name": "render",
"type": "ReactElement<unknown, string | JSXElementConstructor<any>>",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Element rendered as the row instead of a native button. Custom components must forward the supplied props and ref."
},
{
"name": "startIcon",
@@ -7067,7 +7067,7 @@
"type": "CSSProperties",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Inline styles applied to the row."
}
]
},
@@ -7079,14 +7079,14 @@
"type": "string",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "CSS class applied to the row."
},
{
"name": "closeOnSelect",
"type": "boolean",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Closes the dropdown after selection. Defaults to `true`, or `false` when `multiple` is set."
},
{
"name": "color",
@@ -7142,7 +7142,7 @@
"type": "\"check\" | \"checkbox\" | \"none\"",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Selection indicator: a check icon after the content, a checkbox before it, or none. Defaults to `checkbox` when `multiple` is set, otherwise `check`."
},
{
"name": "nativeButton",
@@ -7156,21 +7156,21 @@
"type": "(() => void)",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Called when the option is activated. The application owns the selected value."
},
{
"name": "render",
"type": "ReactElement<unknown, string | JSXElementConstructor<any>>",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Element rendered as the row instead of a native button. Custom components must forward the supplied props and ref."
},
{
"name": "selected",
"type": "boolean",
"required": true,
"defaultValue": null,
- "description": ""
+ "description": "Whether the option is selected. Exposed as `aria-checked` in menus and `aria-pressed` in other dropdown types."
},
{
"name": "startIcon",
@@ -7184,7 +7184,7 @@
"type": "CSSProperties",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Inline styles applied to the row."
}
]
},
@@ -7210,7 +7210,7 @@
"type": "((value: string) => void)",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Called with the search text on every change. The application filters the results."
},
{
"name": "render",
@@ -7281,7 +7281,7 @@
"type": "string",
"required": true,
"defaultValue": null,
- "description": ""
+ "description": "Accessible name of the close control. Required because the default control only shows an icon."
},
{
"name": "className",
@@ -7321,14 +7321,14 @@
"type": "string",
"required": true,
"defaultValue": null,
- "description": ""
+ "description": "Identifier matched by `defaultPage`, the `page` prop of actions, and `goToPage`. The page renders only while it is current."
},
{
"name": "type",
"type": "\"menu\" | \"panel\" | \"picker\"",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Interaction model while the page is shown. Defaults to the root `type`."
}
]
},
@@ -7340,7 +7340,7 @@
"type": "string",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "CSS class applied to the row."
},
{
"name": "color",
@@ -7403,7 +7403,7 @@
"type": "ReactElement<unknown, string | JSXElementConstructor<any>>",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Element rendered as the row instead of a native button. Custom components must forward the supplied props and ref."
},
{
"name": "startIcon",
@@ -7417,7 +7417,7 @@
"type": "CSSProperties",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Inline styles applied to the row."
}
]
},
@@ -7429,42 +7429,42 @@
"type": "boolean",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Whether the popup is initially open when uncontrolled."
},
{
"name": "defaultPage",
"type": "string",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "ID of the `Page` shown when the popup opens. Closing the popup resets the page history to it. Defaults to `root`."
},
{
"name": "multiple",
"type": "boolean",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Allows selecting several options. Options then keep the popup open and show a checkbox by default."
},
{
"name": "onOpenChange",
"type": "((open: boolean) => void)",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Called with the next open state when the popup opens or closes."
},
{
"name": "open",
"type": "boolean",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Whether the popup is open. Use with `onOpenChange` to control it."
},
{
"name": "type",
"type": "\"menu\" | \"panel\" | \"picker\"",
"required": false,
"defaultValue": "menu",
- "description": ""
+ "description": "Interaction model: `menu` for commands and links, `picker` for search and selectable options, or `panel` for forms. It sets the ARIA roles, initial focus, and keyboard navigation."
}
]
},
@@ -7476,14 +7476,14 @@
"type": "string",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "CSS class applied to the row."
},
{
"name": "closeDelay",
"type": "number",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Delay in milliseconds before a submenu opened on hover closes. Requires `openOnHover`. Defaults to `0`."
},
{
"name": "color",
@@ -7497,7 +7497,7 @@
"type": "number",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Delay in milliseconds before the submenu opens on hover. Requires `openOnHover`. Defaults to `300`."
},
{
"name": "description",
@@ -7553,14 +7553,14 @@
"type": "boolean",
"required": false,
"defaultValue": "true",
- "description": ""
+ "description": "Also opens the submenu when the row is hovered."
},
{
"name": "render",
"type": "ReactElement<unknown, string | JSXElementConstructor<any>>",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Element rendered as the row instead of a native button. Custom components must forward the supplied props and ref."
},
{
"name": "startIcon",
@@ -7574,7 +7574,7 @@
"type": "CSSProperties",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Inline styles applied to the row."
}
]
},
@@ -7586,14 +7586,64 @@
"type": "ReactNode",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Heading displayed above the rows. It also names the group for assistive technologies."
},
{
"name": "scrollable",
"type": "boolean",
"required": false,
"defaultValue": null,
- "description": ""
+ "description": "Caps the section height and scrolls its rows. Nest labelled sections inside it to scroll them as one list."
+ }
+ ]
+ },
+ {
+ "name": "Separator",
+ "props": [
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the separator. Native div attributes and refs are also accepted."
+ }
+ ]
+ },
+ {
+ "name": "Loading",
+ "props": [
+ {
+ "name": "children",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Loading message announced as a polite, busy status."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the status. Native div attributes and refs are also accepted."
+ }
+ ]
+ },
+ {
+ "name": "Empty",
+ "props": [
+ {
+ "name": "children",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Empty-state message announced as a polite status."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the status. Native div attributes and refs are also accepted."
}
]
}
@@ -7917,5 +7967,1496 @@
"description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
}
]
+ },
+ {
+ "name": "AvatarGroup",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/avatar-group",
+ "props": [
+ {
+ "name": "avatars",
+ "type": "ReactNode[]",
+ "required": true,
+ "defaultValue": null,
+ "description": "Avatar elements in display order. Only the first maxVisible elements are shown."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the group container."
+ },
+ {
+ "name": "maxVisible",
+ "type": "number",
+ "required": false,
+ "defaultValue": "4",
+ "description": "Maximum number of supplied avatars to show."
+ },
+ {
+ "name": "overflowAvatar",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Custom trailing element, used instead of the numeric overflow indicator."
+ },
+ {
+ "name": "overflowCount",
+ "type": "number",
+ "required": false,
+ "defaultValue": "0",
+ "description": "Number shown in the trailing +N indicator. Compute this in the application; it is not derived from avatars."
+ },
+ {
+ "name": "overflowShape",
+ "type": "\"circle\" | \"rounded-square\" | \"square\"",
+ "required": false,
+ "defaultValue": "square",
+ "description": "Shape of the numeric overflow indicator."
+ },
+ {
+ "name": "overlap",
+ "type": "\"left\" | \"right\"",
+ "required": false,
+ "defaultValue": "right",
+ "description": "Physical margin, left or right, that carries the negative overlap offset. Later avatars always render above earlier ones."
+ },
+ {
+ "name": "overlapOffset",
+ "type": "string",
+ "required": false,
+ "defaultValue": "3px",
+ "description": "CSS length of the overlap between avatars."
+ }
+ ]
+ },
+ {
+ "name": "CommandBlock",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/command-block",
+ "props": [
+ {
+ "name": "button",
+ "type": "ReactElement<unknown, string | JSXElementConstructor<any>>",
+ "required": false,
+ "defaultValue": null,
+ "description": "Optional action element beside the command lines, such as a copy button."
+ },
+ {
+ "name": "commands",
+ "type": "string[]",
+ "required": true,
+ "defaultValue": null,
+ "description": "Command lines to display. The component prefixes each line with > and does not execute commands."
+ }
+ ]
+ },
+ {
+ "name": "JsonTree",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/json-tree",
+ "props": [
+ {
+ "name": "arrowButtonCollapsedLabel",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Accessible label for the expand control on a collapsed node."
+ },
+ {
+ "name": "arrowButtonExpandedLabel",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Accessible label for the collapse control on an expanded node."
+ },
+ {
+ "name": "emptyArrayLabel",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Display text for an empty array."
+ },
+ {
+ "name": "emptyObjectLabel",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Display text for an empty object."
+ },
+ {
+ "name": "emptyStringLabel",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Display text for an empty string."
+ },
+ {
+ "name": "entries",
+ "type": "JsonTreeEntry[]",
+ "required": false,
+ "defaultValue": null,
+ "description": "Named entries with stable id, label, and JSON value fields. Supply entries or value, not both."
+ },
+ {
+ "name": "getNodeHighlighting",
+ "type": "GetJsonNodeHighlighting",
+ "required": false,
+ "defaultValue": null,
+ "description": "Returns blue, red, or partial-blue highlighting for a node key path."
+ },
+ {
+ "name": "onNodeValueClick",
+ "type": "((valueAsString: string) => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Called with the clicked value as displayed: leaf values as strings, and the empty label for empty strings, arrays, and objects."
+ },
+ {
+ "name": "shouldExpandNodeInitially",
+ "type": "((params: ShouldExpandNodeInitiallyProps) => boolean)",
+ "required": false,
+ "defaultValue": "({ depth }: ShouldExpandNodeInitiallyProps) =>\n depth <= 1",
+ "description": "Chooses initial expansion from the node keyPath and depth. The default expands the first two depths."
+ },
+ {
+ "name": "value",
+ "type": "JsonValue",
+ "required": false,
+ "defaultValue": null,
+ "description": "JSON value to display. Supply value or entries, not both."
+ }
+ ]
+ },
+ {
+ "name": "NotificationCounter",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/notification-counter",
+ "props": [
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the badge."
+ },
+ {
+ "name": "count",
+ "type": "number",
+ "required": true,
+ "defaultValue": null,
+ "description": "Number to display as supplied, without clamping or hiding zero."
+ },
+ {
+ "name": "variant",
+ "type": "\"primary\" | \"secondary\"",
+ "required": false,
+ "defaultValue": "primary",
+ "description": "Primary or secondary badge styling."
+ }
+ ]
+ },
+ {
+ "name": "TintedIconTile",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/tinted-icon-tile",
+ "props": [
+ {
+ "name": "color",
+ "type": "string | null",
+ "required": false,
+ "defaultValue": "gray",
+ "description": "Theme palette name used to derive the background and icon shades. Invalid names use the default theme color."
+ },
+ {
+ "name": "Icon",
+ "type": "IconComponent",
+ "required": true,
+ "defaultValue": null,
+ "description": "Icon component rendered inside the tinted tile."
+ },
+ {
+ "name": "size",
+ "type": "number",
+ "required": false,
+ "defaultValue": null,
+ "description": "Icon and tile dimension in pixels. When omitted, the icon uses the medium theme size."
+ },
+ {
+ "name": "stroke",
+ "type": "number",
+ "required": false,
+ "defaultValue": null,
+ "description": "Icon stroke width. Defaults to the medium theme stroke."
+ }
+ ]
+ },
+ {
+ "name": "Callout",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/callout",
+ "props": [
+ {
+ "name": "action",
+ "type": "{ label: string; onClick: () => void; }",
+ "required": false,
+ "defaultValue": null,
+ "description": "Optional footer action with a label and onClick callback."
+ },
+ {
+ "name": "description",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Optional supporting text. Empty strings are hidden."
+ },
+ {
+ "name": "fullWidth",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Fills the available container width."
+ },
+ {
+ "name": "Icon",
+ "type": "IconComponent",
+ "required": false,
+ "defaultValue": null,
+ "description": "Leading icon component. Defaults to the help icon."
+ },
+ {
+ "name": "isClosable",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Shows a close button that hides the callout until it is remounted."
+ },
+ {
+ "name": "onClose",
+ "type": "(() => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Called after the close button hides the callout."
+ },
+ {
+ "name": "title",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Main message displayed beside the icon."
+ },
+ {
+ "name": "variant",
+ "type": "\"error\" | \"info\" | \"neutral\" | \"success\" | \"warning\"",
+ "required": true,
+ "defaultValue": null,
+ "description": "Semantic appearance: info, warning, error, neutral, or success."
+ }
+ ]
+ },
+ {
+ "name": "Info",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/info",
+ "props": [
+ {
+ "name": "accent",
+ "type": "\"blue\" | \"danger\"",
+ "required": false,
+ "defaultValue": "blue",
+ "description": "Information or danger styling."
+ },
+ {
+ "name": "buttonTitle",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Visible label for the optional action. Requires href or onClick."
+ },
+ {
+ "name": "href",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Action destination. Takes precedence over onClick."
+ },
+ {
+ "name": "onClick",
+ "type": "((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Action callback when href is absent."
+ },
+ {
+ "name": "render",
+ "type": "ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ButtonState>",
+ "required": false,
+ "defaultValue": null,
+ "description": "Custom render element for the link action, forwarded to Button when href is supplied."
+ },
+ {
+ "name": "text",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Message displayed beside the information icon."
+ }
+ ]
+ },
+ {
+ "name": "InlineBanner",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/inline-banner",
+ "props": [
+ {
+ "name": "button",
+ "type": "{ title?: string | undefined; onClick?: (() => void) | undefined; hidden?: boolean | undefined; disabled?: boolean | undefined; Icon?: IconComponent | undefined; }",
+ "required": false,
+ "defaultValue": null,
+ "description": "Optional action with title, onClick, hidden, disabled, and Icon fields."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the banner."
+ },
+ {
+ "name": "color",
+ "type": "\"blue\" | \"danger\"",
+ "required": false,
+ "defaultValue": null,
+ "description": "Banner palette color. An omitted color uses Banner’s default."
+ },
+ {
+ "name": "embedded",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Uses the embedded banner appearance."
+ },
+ {
+ "name": "LeftIcon",
+ "type": "IconComponent",
+ "required": false,
+ "defaultValue": null,
+ "description": "Leading icon component. Defaults to the information icon."
+ },
+ {
+ "name": "message",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Message, truncated with its full text available in a tooltip."
+ }
+ ]
+ },
+ {
+ "name": "ToastProvider",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/toast-provider",
+ "props": [
+ {
+ "name": "children",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Application content and a Toaster sharing this notification store."
+ },
+ {
+ "name": "limit",
+ "type": "number",
+ "required": false,
+ "defaultValue": "3",
+ "description": "Maximum number of visible toasts, read once when the provider mounts. Must be a positive integer. Adding a toast above the limit dismisses the oldest visible notifications."
+ }
+ ]
+ },
+ {
+ "name": "Toaster",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/toaster",
+ "props": [
+ {
+ "name": "container",
+ "type": "HTMLElement | null",
+ "required": false,
+ "defaultValue": null,
+ "description": "Portal destination. Omit to use the theme container or document.body; null defers rendering."
+ },
+ {
+ "name": "getToastProps",
+ "type": "((toast: ToastNotification) => Partial<Omit<ToastProps, \"ref\" | \"id\" | \"onClose\">>)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Customizes each notification’s Toast props. The toaster owns id, ref, and dismissal."
+ },
+ {
+ "name": "render",
+ "type": "RenderProp<Record<string, unknown>>",
+ "required": false,
+ "defaultValue": null,
+ "description": "Custom root element composed through Base UI."
+ }
+ ]
+ },
+ {
+ "name": "CardPicker",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/card-picker",
+ "props": [
+ {
+ "name": "children",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Card content inside the radio control."
+ },
+ {
+ "name": "className",
+ "type": "string | ((state: RadioRootState) => string | undefined)",
+ "required": false,
+ "defaultValue": null,
+ "description": "CSS class applied to the element, or a function that\nreturns a class based on the component's state."
+ },
+ {
+ "name": "disabled",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Whether the component should ignore user interaction."
+ },
+ {
+ "name": "inputRef",
+ "type": "Ref<HTMLInputElement>",
+ "required": false,
+ "defaultValue": null,
+ "description": "A ref to access the hidden input element."
+ },
+ {
+ "name": "nativeButton",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Whether the component renders a native `<button>` element when replacing it\nvia the `render` prop.\nSet to `true` if the rendered element is a native button."
+ },
+ {
+ "name": "readOnly",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Whether the user should be unable to select the radio button."
+ },
+ {
+ "name": "render",
+ "type": "ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, RadioRootState>",
+ "required": false,
+ "defaultValue": null,
+ "description": "Allows you to replace the component's HTML element\nwith a different tag, or compose it with another component.\n\nAccepts a `ReactElement` or a function that returns the element to render."
+ },
+ {
+ "name": "required",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Whether the user must choose a value before submitting a form."
+ },
+ {
+ "name": "size",
+ "type": "\"md\" | \"sm\"",
+ "required": false,
+ "defaultValue": null,
+ "description": "Visual size of the radio."
+ },
+ {
+ "name": "style",
+ "type": "CSSProperties | ((state: RadioRootState) => CSSProperties | undefined)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Style applied to the element, or a function that\nreturns a style object based on the component's state."
+ },
+ {
+ "name": "value",
+ "type": "TValue",
+ "required": true,
+ "defaultValue": null,
+ "description": "The unique identifying value of the radio in a group."
+ }
+ ]
+ },
+ {
+ "name": "ColorSchemePicker",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/color-scheme-picker",
+ "props": [
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the outer container."
+ },
+ {
+ "name": "darkLabel",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Visible caption for the dark scheme. The control’s accessible name remains Dark."
+ },
+ {
+ "name": "lightLabel",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Visible caption for the light scheme. The control’s accessible name remains Light."
+ },
+ {
+ "name": "onChange",
+ "type": "(value: ColorScheme) => void",
+ "required": true,
+ "defaultValue": null,
+ "description": "Called with the newly selected color scheme."
+ },
+ {
+ "name": "systemLabel",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Visible caption for the system scheme. The control’s accessible name remains System."
+ },
+ {
+ "name": "value",
+ "type": "\"Dark\" | \"Light\" | \"System\"",
+ "required": true,
+ "defaultValue": null,
+ "description": "Selected scheme: Light, Dark, or System. The application resolves system to a concrete theme."
+ }
+ ]
+ },
+ {
+ "name": "SearchInput",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/search-input",
+ "props": [
+ {
+ "name": "aria-label",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Accessible name when aria-labelledby is absent."
+ },
+ {
+ "name": "aria-labelledby",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "ID of the element that labels the input. Takes precedence over aria-label."
+ },
+ {
+ "name": "autoFocus",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Focuses the input when mounted."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the wrapper."
+ },
+ {
+ "name": "disabled",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Disables the text input. Configure filter popup controls separately."
+ },
+ {
+ "name": "filterButtonAriaLabel",
+ "type": "string",
+ "required": false,
+ "defaultValue": "Filter",
+ "description": "Accessible label for the optional filter button."
+ },
+ {
+ "name": "filterDropdown",
+ "type": "((filterButton: ReactElement<unknown, string | JSXElementConstructor<any>>) => ReactNode)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Renders a filter popup around the supplied filter button."
+ },
+ {
+ "name": "id",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Input ID, generated when omitted."
+ },
+ {
+ "name": "onChange",
+ "type": "(value: string) => void",
+ "required": true,
+ "defaultValue": null,
+ "description": "Called with the new text, not a DOM change event. The application owns filtering."
+ },
+ {
+ "name": "placeholder",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Hint shown when the input is empty. Also used as the accessible name if no explicit label is supplied."
+ },
+ {
+ "name": "value",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Current search text."
+ }
+ ]
+ },
+ {
+ "name": "AnimatedIconCrossfade",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/animated-icon-crossfade",
+ "props": [
+ {
+ "name": "ActiveIcon",
+ "type": "IconComponent",
+ "required": true,
+ "defaultValue": null,
+ "description": "Icon component for the active state."
+ },
+ {
+ "name": "InactiveIcon",
+ "type": "IconComponent",
+ "required": true,
+ "defaultValue": null,
+ "description": "Icon component for the inactive state."
+ },
+ {
+ "name": "isActive",
+ "type": "boolean",
+ "required": true,
+ "defaultValue": null,
+ "description": "Shows ActiveIcon when true and InactiveIcon otherwise."
+ },
+ {
+ "name": "size",
+ "type": "number",
+ "required": false,
+ "defaultValue": null,
+ "description": "Icon dimension in pixels. Defaults to the small theme icon size."
+ }
+ ]
+ },
+ {
+ "name": "MenuItem",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/menu-item",
+ "props": [
+ {
+ "name": "accent",
+ "type": "\"danger\" | \"default\" | \"placeholder\"",
+ "required": false,
+ "defaultValue": "default",
+ "description": "Default, danger, or placeholder row styling."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the row."
+ },
+ {
+ "name": "contextualText",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Supporting text beside the main label."
+ },
+ {
+ "name": "contextualTextPosition",
+ "type": "\"left\" | \"right\"",
+ "required": false,
+ "defaultValue": "left",
+ "description": "Position of the supporting text."
+ },
+ {
+ "name": "disabled",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Disables activation and applies disabled styling."
+ },
+ {
+ "name": "focused",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Applies focused appearance without moving DOM focus."
+ },
+ {
+ "name": "hasSubMenu",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Shows a submenu chevron; does not create a submenu."
+ },
+ {
+ "name": "hotKeys",
+ "type": "Nullable<string[]>",
+ "required": false,
+ "defaultValue": null,
+ "description": "Visible shortcut hints. Register handlers in the application."
+ },
+ {
+ "name": "iconButtons",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Trailing action elements."
+ },
+ {
+ "name": "iconThemeColor",
+ "type": "ThemeColor | null",
+ "required": false,
+ "defaultValue": null,
+ "description": "Theme color for the leading icon."
+ },
+ {
+ "name": "isIconDisplayedOnHoverOnly",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "true",
+ "description": "Reveals trailing action elements only on hover."
+ },
+ {
+ "name": "isSubMenuOpened",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Applies the open treatment to the submenu chevron."
+ },
+ {
+ "name": "isTooltipOpen",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Accepted for compatibility; currently has no effect."
+ },
+ {
+ "name": "LeftComponent",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Custom leading content."
+ },
+ {
+ "name": "LeftIcon",
+ "type": "IconComponent | null",
+ "required": false,
+ "defaultValue": null,
+ "description": "Leading icon component."
+ },
+ {
+ "name": "onClick",
+ "type": "((event: MouseEvent<HTMLDivElement, MouseEvent>) => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Pointer activation callback. The row itself does not add keyboard or menu semantics."
+ },
+ {
+ "name": "onMouseEnter",
+ "type": "((event: MouseEvent<HTMLDivElement, MouseEvent>) => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Pointer-entry callback on the row."
+ },
+ {
+ "name": "onMouseLeave",
+ "type": "((event: MouseEvent<HTMLDivElement, MouseEvent>) => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Pointer-exit callback on the row."
+ },
+ {
+ "name": "RightComponent",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Custom trailing content."
+ },
+ {
+ "name": "RightIcon",
+ "type": "IconComponent | null",
+ "required": false,
+ "defaultValue": null,
+ "description": "Trailing icon component."
+ },
+ {
+ "name": "selected",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Applies selected appearance without owning selection state."
+ },
+ {
+ "name": "testId",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Value of the row’s data-testid attribute."
+ },
+ {
+ "name": "text",
+ "type": "ReactNode",
+ "required": true,
+ "defaultValue": null,
+ "description": "Main row label."
+ },
+ {
+ "name": "withIconContainer",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Places leading content in an icon container."
+ },
+ {
+ "name": "withIconContainerBackground",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "true",
+ "description": "Adds a background to the leading icon container."
+ }
+ ]
+ },
+ {
+ "name": "MenuItemAvatar",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/menu-item-avatar",
+ "props": [
+ {
+ "name": "accent",
+ "type": "\"danger\" | \"default\" | \"placeholder\"",
+ "required": false,
+ "defaultValue": "default",
+ "description": "Default, danger, or placeholder row styling."
+ },
+ {
+ "name": "avatar",
+ "type": "Pick<AvatarProps, \"size\" | \"name\" | \"shape\" | \"src\" | \"colorSeed\"> | null",
+ "required": false,
+ "defaultValue": null,
+ "description": "Avatar name, source, color seed, size, and shape. Omit to hide the avatar."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the row."
+ },
+ {
+ "name": "contextualText",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Supporting text beside the main label."
+ },
+ {
+ "name": "hasSubMenu",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Shows a submenu chevron; does not create a submenu."
+ },
+ {
+ "name": "iconButtons",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Trailing action elements."
+ },
+ {
+ "name": "isIconDisplayedOnHoverOnly",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "true",
+ "description": "Reveals trailing action elements only on hover."
+ },
+ {
+ "name": "isTooltipOpen",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Accepted for compatibility; currently has no effect."
+ },
+ {
+ "name": "onClick",
+ "type": "((event: MouseEvent<HTMLDivElement, MouseEvent>) => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Pointer activation callback. The row itself does not add keyboard or menu semantics."
+ },
+ {
+ "name": "onMouseEnter",
+ "type": "((event: MouseEvent<HTMLDivElement, MouseEvent>) => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Pointer-entry callback on the row."
+ },
+ {
+ "name": "onMouseLeave",
+ "type": "((event: MouseEvent<HTMLDivElement, MouseEvent>) => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Pointer-exit callback on the row."
+ },
+ {
+ "name": "testId",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Value of the row’s data-testid attribute."
+ },
+ {
+ "name": "text",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Main row label."
+ }
+ ]
+ },
+ {
+ "name": "MenuItemDraggable",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/menu-item-draggable",
+ "props": [
+ {
+ "name": "accent",
+ "type": "\"danger\" | \"default\" | \"placeholder\"",
+ "required": false,
+ "defaultValue": "default",
+ "description": "Default, danger, or placeholder row styling."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the row."
+ },
+ {
+ "name": "contextualText",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Supporting text beside the main label."
+ },
+ {
+ "name": "gripMode",
+ "type": "\"always\" | \"never\" | \"onHover\"",
+ "required": false,
+ "defaultValue": "never",
+ "description": "Grip visibility: never, always, or onHover. onHover swaps LeftIcon for the grip on hover and shows no grip without LeftIcon. Does not implement dragging."
+ },
+ {
+ "name": "iconButtons",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Trailing action elements."
+ },
+ {
+ "name": "isDragDisabled",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Disables drag appearance without installing or removing drag handlers."
+ },
+ {
+ "name": "isHoverDisabled",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Accepted for compatibility; currently has no effect."
+ },
+ {
+ "name": "isIconDisplayedOnHoverOnly",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "true",
+ "description": "Reveals trailing action elements only on hover."
+ },
+ {
+ "name": "isTooltipOpen",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Accepted for compatibility; currently has no effect."
+ },
+ {
+ "name": "LeftIcon",
+ "type": "IconComponent",
+ "required": false,
+ "defaultValue": null,
+ "description": "Leading icon component."
+ },
+ {
+ "name": "onClick",
+ "type": "(() => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Pointer activation callback. The row itself does not add keyboard or menu semantics."
+ },
+ {
+ "name": "text",
+ "type": "ReactNode",
+ "required": true,
+ "defaultValue": null,
+ "description": "Main row label."
+ },
+ {
+ "name": "withIconContainer",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Places leading content in an icon container."
+ }
+ ]
+ },
+ {
+ "name": "MenuItemSuggestion",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/menu-item-suggestion",
+ "props": [
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the row."
+ },
+ {
+ "name": "contextualText",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Supporting text beside the main label."
+ },
+ {
+ "name": "contextualTextPosition",
+ "type": "\"left\" | \"right\"",
+ "required": false,
+ "defaultValue": "left",
+ "description": "Position of the supporting text."
+ },
+ {
+ "name": "LeftIcon",
+ "type": "IconComponent | null",
+ "required": false,
+ "defaultValue": null,
+ "description": "Leading icon component."
+ },
+ {
+ "name": "onClick",
+ "type": "((event: MouseEvent<HTMLLIElement, MouseEvent>) => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Activation callback. When supplied, the row gains button semantics, a tab stop, and Enter/Space activation."
+ },
+ {
+ "name": "selected",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Applies selected styling. The application owns selection."
+ },
+ {
+ "name": "text",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Main row label."
+ },
+ {
+ "name": "withIconContainer",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Places leading content in an icon container."
+ }
+ ]
+ },
+ {
+ "name": "MenuPicker",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/menu-picker",
+ "props": [
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the button."
+ },
+ {
+ "name": "disabled",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Disables the button."
+ },
+ {
+ "name": "icon",
+ "type": "IconComponent",
+ "required": true,
+ "defaultValue": null,
+ "description": "Leading icon component."
+ },
+ {
+ "name": "id",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Button ID."
+ },
+ {
+ "name": "label",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Button label and accessible name, including when showLabel is false."
+ },
+ {
+ "name": "onClick",
+ "type": "(() => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Activation callback."
+ },
+ {
+ "name": "selected",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Controls selected styling and aria-pressed."
+ },
+ {
+ "name": "showLabel",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "true",
+ "description": "Shows the visible label beside the icon."
+ },
+ {
+ "name": "testId",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Value of the button’s data-testid attribute."
+ },
+ {
+ "name": "tooltipContent",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Optional tooltip text."
+ },
+ {
+ "name": "tooltipDelay",
+ "type": "number",
+ "required": false,
+ "defaultValue": "0",
+ "description": "Hover delay in milliseconds."
+ },
+ {
+ "name": "tooltipOffset",
+ "type": "number",
+ "required": false,
+ "defaultValue": "5",
+ "description": "Distance between the button and tooltip in pixels."
+ }
+ ]
+ },
+ {
+ "name": "NavigationBar",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/navigation-bar",
+ "props": [
+ {
+ "name": "activeItemName",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Name of the item to highlight. The application owns navigation."
+ },
+ {
+ "name": "isHidden",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Hides the bar visually and from the accessibility tree."
+ },
+ {
+ "name": "items",
+ "type": "{ name: string; label: string; Icon: IconComponent; onClick: () => void; }[]",
+ "required": true,
+ "defaultValue": null,
+ "description": "Navigation items with a unique name, accessible label, Icon component, and onClick callback."
+ }
+ ]
+ },
+ {
+ "name": "RoundedLink",
+ "entryPoint": "twenty-ui/components",
+ "slug": "components/rounded-link",
+ "props": [
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the link."
+ },
+ {
+ "name": "color",
+ "type": "\"primary\" | \"secondary\"",
+ "required": false,
+ "defaultValue": "primary",
+ "description": "Label text color: primary or secondary."
+ },
+ {
+ "name": "href",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Destination URL, normalized by the safe-URL helper. Opens in a new tab."
+ },
+ {
+ "name": "label",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Visible link text. An absent or empty label renders nothing."
+ },
+ {
+ "name": "onClick",
+ "type": "((event: MouseEvent<HTMLElement, MouseEvent>) => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Click callback after propagation is stopped."
+ }
+ ]
+ },
+ {
+ "name": "ThemeProvider",
+ "entryPoint": "twenty-ui/theme",
+ "slug": "theme/theme-provider",
+ "props": [
+ {
+ "name": "applyToRoot",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "true",
+ "description": "Applies the color-scheme class to the document root. Set false for a scoped wrapper."
+ },
+ {
+ "name": "children",
+ "type": "ReactNode",
+ "required": true,
+ "defaultValue": null,
+ "description": "Components that share this theme."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to a scoped wrapper; no wrapper is created for className alone."
+ },
+ {
+ "name": "colorScheme",
+ "type": "\"dark\" | \"light\"",
+ "required": true,
+ "defaultValue": null,
+ "description": "Explicit light or dark palette; load its stylesheet before rendering."
+ },
+ {
+ "name": "overrides",
+ "type": "ThemeOverrides",
+ "required": false,
+ "defaultValue": null,
+ "description": "CSS custom-property overrides. Supplying them creates a scoped wrapper."
+ },
+ {
+ "name": "scale",
+ "type": "number",
+ "required": false,
+ "defaultValue": null,
+ "description": "Root interface scale stored in --t-scale-user. Ignored for scoped providers; application CSS must consume the variable."
+ },
+ {
+ "name": "theme",
+ "type": "ThemeType | typeof THEME_LIGHT",
+ "required": false,
+ "defaultValue": null,
+ "description": "Explicit resolved theme values, bypassing computed-style token resolution."
+ }
+ ]
+ },
+ {
+ "name": "Icon",
+ "entryPoint": "twenty-ui/icon",
+ "slug": "icon/icon",
+ "props": [
+ {
+ "name": "aria-hidden",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Hides a decorative icon from assistive technology."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class forwarded to the resolved icon."
+ },
+ {
+ "name": "color",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Color forwarded to the resolved icon."
+ },
+ {
+ "name": "name",
+ "type": "string",
+ "required": true,
+ "defaultValue": null,
+ "description": "Icon name resolved through IconsProvider. Unknown names fall back to Icon123."
+ },
+ {
+ "name": "size",
+ "type": "string | number",
+ "required": false,
+ "defaultValue": null,
+ "description": "Width and height forwarded to the resolved icon."
+ },
+ {
+ "name": "stroke",
+ "type": "string | number",
+ "required": false,
+ "defaultValue": null,
+ "description": "Stroke width forwarded to the resolved icon."
+ },
+ {
+ "name": "style",
+ "type": "CSSProperties",
+ "required": false,
+ "defaultValue": null,
+ "description": "Styles forwarded to the resolved icon."
+ }
+ ]
+ },
+ {
+ "name": "IconsProvider",
+ "entryPoint": "twenty-ui/icon",
+ "slug": "icon/icons-provider",
+ "props": [
+ {
+ "name": "children",
+ "type": "Element",
+ "required": true,
+ "defaultValue": null,
+ "description": "One React element containing consumers of Icon or useIcons. Loads the complete icon map asynchronously."
+ }
+ ]
+ },
+ {
+ "name": "IllustrationIconWrapper",
+ "entryPoint": "twenty-ui/icon",
+ "slug": "icon/illustration-icon-wrapper",
+ "props": [
+ {
+ "name": "children",
+ "type": "ReactNode",
+ "required": false,
+ "defaultValue": null,
+ "description": "Illustration content to center inside the wrapper."
+ },
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class merged with the illustration wrapper styling."
+ }
+ ]
+ },
+ {
+ "name": "ThinkingOrbitLoaderIcon",
+ "entryPoint": "twenty-ui/icon",
+ "slug": "icon/thinking-orbit-loader-icon",
+ "props": [
+ {
+ "name": "className",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Class applied to the SVG. The icon is always hidden from assistive technology."
+ },
+ {
+ "name": "size",
+ "type": "string | number",
+ "required": false,
+ "defaultValue": "14",
+ "description": "Width and height in pixels."
+ }
+ ]
+ },
+ {
+ "name": "ComponentStorybookLayout",
+ "entryPoint": "twenty-ui/testing",
+ "slug": "testing/component-storybook-layout",
+ "props": [
+ {
+ "name": "backgroundColor",
+ "type": "string",
+ "required": false,
+ "defaultValue": null,
+ "description": "Background color override."
+ },
+ {
+ "name": "children",
+ "type": "Element",
+ "required": true,
+ "defaultValue": null,
+ "description": "The component preview element."
+ },
+ {
+ "name": "height",
+ "type": "number",
+ "required": false,
+ "defaultValue": null,
+ "description": "Container height in pixels. Defaults to fit-content."
+ },
+ {
+ "name": "width",
+ "type": "number",
+ "required": false,
+ "defaultValue": null,
+ "description": "Container width in pixels. When omitted, the container has a 300px minimum width."
+ }
+ ]
}
]
diff --git a/packages/twenty-ui/generated/icons.docs.json b/packages/twenty-ui/generated/icons.docs.json
new file mode 100644
index 00000000000..3b8f35e8759
--- /dev/null
+++ b/packages/twenty-ui/generated/icons.docs.json
@@ -0,0 +1,552 @@
+[
+ {
+ "names": [
+ "Icon123",
+ "IconAdjustments",
+ "IconAlertCircle",
+ "IconAlertTriangle",
+ "IconAlignBoxLeftTop",
+ "IconAlignCenter",
+ "IconAlignLeft",
+ "IconAlignRight",
+ "IconApi",
+ "IconAppWindow",
+ "IconApps",
+ "IconArchive",
+ "IconArchiveOff",
+ "IconArrowBackUp",
+ "IconArrowBarToDown",
+ "IconArrowBarToDownDashed",
+ "IconArrowDown",
+ "IconArrowLeft",
+ "IconArrowMerge",
+ "IconArrowRight",
+ "IconArrowUp",
+ "IconArrowUpRight",
+ "IconArrowsDiagonal",
+ "IconArrowsSort",
+ "IconArrowsSplit2",
+ "IconArrowsVertical",
+ "IconAt",
+ "IconAxisX",
+ "IconAxisY",
+ "IconBadge2k",
+ "IconBaselineDensitySmall",
+ "IconBell",
+ "IconBlockquote",
+ "IconBold",
+ "IconBolt",
+ "IconBook",
+ "IconBook2",
+ "IconBookmark",
+ "IconBookmarkPlus",
+ "IconBox",
+ "IconBoxMultiple",
+ "IconBrackets",
+ "IconBracketsAngle",
+ "IconBracketsContain",
+ "IconBrain",
+ "IconBrandDaysCounter",
+ "IconBrandDocker",
+ "IconBrandGithub",
+ "IconBrandGoogle",
+ "IconBrandGraphql",
+ "IconBrandLinkedin",
+ "IconBrandNpm",
+ "IconBrandOpenai",
+ "IconBrandTypescript",
+ "IconBrandWhatsapp",
+ "IconBrandX",
+ "IconBriefcase",
+ "IconBroadcast",
+ "IconBrowserMaximize",
+ "IconBuildingSkyscraper",
+ "IconCalendar",
+ "IconCalendarDue",
+ "IconCalendarEvent",
+ "IconCalendarMonth",
+ "IconCalendarRepeat",
+ "IconCalendarTime",
+ "IconCalendarWeek",
+ "IconCalendarX",
+ "IconCancel",
+ "IconCaretLeft",
+ "IconCaretRight",
+ "IconChartBar",
+ "IconChartBarPopular",
+ "IconChartCandle",
+ "IconChartDots3",
+ "IconChartLine",
+ "IconChartPie",
+ "IconCheck",
+ "IconCheckbox",
+ "IconChevronDown",
+ "IconChevronLeft",
+ "IconChevronRight",
+ "IconChevronRightPipe",
+ "IconChevronUp",
+ "IconChevronsRight",
+ "IconCircle",
+ "IconCircleDashed",
+ "IconCircleDot",
+ "IconCircleOff",
+ "IconCirclePlus",
+ "IconCircleX",
+ "IconClick",
+ "IconClock",
+ "IconClockHour8",
+ "IconClockPlay",
+ "IconClockShare",
+ "IconCode",
+ "IconCodeCircle",
+ "IconCoins",
+ "IconColorSwatch",
+ "IconColumnInsertRight",
+ "IconColumns",
+ "IconCommand",
+ "IconComment",
+ "IconCompass",
+ "IconCopy",
+ "IconCopyPlus",
+ "IconCpu",
+ "IconCreativeCommonsSa",
+ "IconCreditCard",
+ "IconCsv",
+ "IconCube",
+ "IconCurrencyAfghani",
+ "IconCurrencyBahraini",
+ "IconCurrencyBaht",
+ "IconCurrencyDinar",
+ "IconCurrencyDirham",
+ "IconCurrencyDollar",
+ "IconCurrencyDollarAustralian",
+ "IconCurrencyDollarBrunei",
+ "IconCurrencyDollarCanadian",
+ "IconCurrencyDollarGuyanese",
+ "IconCurrencyDollarSingapore",
+ "IconCurrencyDong",
+ "IconCurrencyDram",
+ "IconCurrencyEuro",
+ "IconCurrencyFlorin",
+ "IconCurrencyForint",
+ "IconCurrencyFrank",
+ "IconCurrencyGuarani",
+ "IconCurrencyHryvnia",
+ "IconCurrencyIranianRial",
+ "IconCurrencyKip",
+ "IconCurrencyKroneCzech",
+ "IconCurrencyKroneDanish",
+ "IconCurrencyKroneSwedish",
+ "IconCurrencyLari",
+ "IconCurrencyLeu",
+ "IconCurrencyLira",
+ "IconCurrencyLyd",
+ "IconCurrencyManat",
+ "IconCurrencyNaira",
+ "IconCurrencyPaanga",
+ "IconCurrencyPeso",
+ "IconCurrencyPound",
+ "IconCurrencyQuetzal",
+ "IconCurrencyReal",
+ "IconCurrencyRenminbi",
+ "IconCurrencyRiyal",
+ "IconCurrencyRubel",
+ "IconCurrencyRufiyaa",
+ "IconCurrencyRupee",
+ "IconCurrencyRupeeNepalese",
+ "IconCurrencyShekel",
+ "IconCurrencySom",
+ "IconCurrencyTaka",
+ "IconCurrencyTenge",
+ "IconCurrencyTugrik",
+ "IconCurrencyWon",
+ "IconCurrencyYen",
+ "IconCurrencyYuan",
+ "IconCurrencyZloty",
+ "IconDatabase",
+ "IconDatabaseExport",
+ "IconDecimal",
+ "IconDeviceDesktop",
+ "IconDeviceFloppy",
+ "IconDoorEnter",
+ "IconDotsVertical",
+ "IconDownload",
+ "IconEdit",
+ "IconEditCircle",
+ "IconEraser",
+ "IconExclamationCircle",
+ "IconExternalLink",
+ "IconEye",
+ "IconEyeOff",
+ "IconEyeShare",
+ "IconEyeX",
+ "IconFile",
+ "IconFileCheck",
+ "IconFileExport",
+ "IconFileImport",
+ "IconFileInfo",
+ "IconFilePencil",
+ "IconFileText",
+ "IconFileUpload",
+ "IconFileZip",
+ "IconFiles",
+ "IconFilter",
+ "IconFilterCog",
+ "IconFilterOff",
+ "IconFilterPlus",
+ "IconFilterX",
+ "IconFilters",
+ "IconFlag",
+ "IconFlask",
+ "IconFocusCentered",
+ "IconFolder",
+ "IconFolderOpen",
+ "IconFolderPlus",
+ "IconFolderRoot",
+ "IconFolderSymlink",
+ "IconForbid",
+ "IconFrame",
+ "IconFunction",
+ "IconGauge",
+ "IconGitBranch",
+ "IconGitBranchDeleted",
+ "IconGitCommit",
+ "IconGizmo",
+ "IconGraph",
+ "IconGripVertical",
+ "IconH1",
+ "IconH2",
+ "IconH3",
+ "IconH4",
+ "IconH5",
+ "IconH6",
+ "IconHandClick",
+ "IconHandMove",
+ "IconHeadphones",
+ "IconHeart",
+ "IconHeartOff",
+ "IconHeartRateMonitor",
+ "IconHelp",
+ "IconHelpCircle",
+ "IconHierarchy",
+ "IconHierarchy2",
+ "IconHistory",
+ "IconHistoryToggle",
+ "IconHome",
+ "IconHourglassHigh",
+ "IconHours24",
+ "IconHttpDelete",
+ "IconHttpGet",
+ "IconHttpPatch",
+ "IconHttpPost",
+ "IconHttpPut",
+ "IconId",
+ "IconInbox",
+ "IconInfoCircle",
+ "IconInfoSquareRounded",
+ "IconItalic",
+ "IconJetpack",
+ "IconJson",
+ "IconKey",
+ "IconLanguage",
+ "IconLayersLinked",
+ "IconLayout",
+ "IconLayoutDashboard",
+ "IconLayoutGrid",
+ "IconLayoutGridAdd",
+ "IconLayoutKanban",
+ "IconLayoutList",
+ "IconLayoutNavbar",
+ "IconLayoutSidebar",
+ "IconLayoutSidebarLeftCollapse",
+ "IconLayoutSidebarLeftExpand",
+ "IconLayoutSidebarRight",
+ "IconLayoutSidebarRightCollapse",
+ "IconLayoutSidebarRightExpand",
+ "IconLego",
+ "IconLetterK",
+ "IconLibraryPlus",
+ "IconLifebuoy",
+ "IconLink",
+ "IconLinkOff",
+ "IconLinkPlus",
+ "IconList",
+ "IconListCheck",
+ "IconListDetails",
+ "IconListNumbers",
+ "IconListSearch",
+ "IconLoader",
+ "IconLock",
+ "IconLockOpen",
+ "IconLogin2",
+ "IconLogout",
+ "IconMail",
+ "IconMailCog",
+ "IconMailX",
+ "IconMap",
+ "IconMathMax",
+ "IconMathMin",
+ "IconMathXy",
+ "IconMaximize",
+ "IconMessage",
+ "IconMessageCircle",
+ "IconMessageCirclePlus",
+ "IconMicrophone",
+ "IconMinimize",
+ "IconMinus",
+ "IconMoneybag",
+ "IconMoodSmile",
+ "IconMoon",
+ "IconMouse2",
+ "IconNewSection",
+ "IconNorthStar",
+ "IconNoteOff",
+ "IconNotes",
+ "IconNumber",
+ "IconNumber123",
+ "IconNumber9",
+ "IconNumbers",
+ "IconPaint",
+ "IconPaperclip",
+ "IconPassword",
+ "IconPencil",
+ "IconPencilOff",
+ "IconPercentage",
+ "IconPerspective",
+ "IconPhone",
+ "IconPhoto",
+ "IconPhotoUp",
+ "IconPilcrow",
+ "IconPin",
+ "IconPinned",
+ "IconPinnedOff",
+ "IconPlayerPause",
+ "IconPlayerPlay",
+ "IconPlayerStop",
+ "IconPlaylistAdd",
+ "IconPlaystationSquare",
+ "IconPlug",
+ "IconPlus",
+ "IconPoint",
+ "IconPower",
+ "IconPresentation",
+ "IconPrinter",
+ "IconProgressCheck",
+ "IconPrompt",
+ "IconPuzzle",
+ "IconPuzzle2",
+ "IconQuestionMark",
+ "IconRadiusBottomLeft",
+ "IconRadiusBottomRight",
+ "IconRadiusTopLeft",
+ "IconRadiusTopRight",
+ "IconRefresh",
+ "IconRefreshAlert",
+ "IconRefreshDot",
+ "IconRelationManyToMany",
+ "IconRelationOneToMany",
+ "IconRelationOneToOne",
+ "IconReload",
+ "IconReorder",
+ "IconRepeat",
+ "IconRestore",
+ "IconRobot",
+ "IconRocket",
+ "IconRotate",
+ "IconRotate2",
+ "IconRowInsertBottom",
+ "IconRowInsertTop",
+ "IconSearch",
+ "IconSend",
+ "IconServer",
+ "IconServer2",
+ "IconSettings",
+ "IconSettings2",
+ "IconSettingsAutomation",
+ "IconSettingsBolt",
+ "IconShare",
+ "IconShare2",
+ "IconShield",
+ "IconShoppingBag",
+ "IconSitemap",
+ "IconSlash",
+ "IconSortAZ",
+ "IconSortAscending",
+ "IconSortAscendingLetters",
+ "IconSortAscendingNumbers",
+ "IconSortDescending",
+ "IconSortDescendingLetters",
+ "IconSortDescendingNumbers",
+ "IconSortZA",
+ "IconSparkles",
+ "IconSpy",
+ "IconSql",
+ "IconSquare",
+ "IconSquareCheck",
+ "IconSquareKey",
+ "IconSquareNumber1",
+ "IconSquareNumber2",
+ "IconSquareNumber3",
+ "IconSquareNumber4",
+ "IconSquareNumber5",
+ "IconSquareNumber6",
+ "IconSquareNumber7",
+ "IconSquareNumber8",
+ "IconSquareNumber9",
+ "IconSquarePlus",
+ "IconSquareRoundedCheck",
+ "IconSquareRoundedX",
+ "IconSquareX",
+ "IconStack2",
+ "IconStairs",
+ "IconStar",
+ "IconStatusChange",
+ "IconStepInto",
+ "IconStrikethrough",
+ "IconSum",
+ "IconSun",
+ "IconSunMoon",
+ "IconSwitchHorizontal",
+ "IconTable",
+ "IconTag",
+ "IconTags",
+ "IconTarget",
+ "IconTargetArrow",
+ "IconTerminal",
+ "IconTestPipe",
+ "IconTextCaption",
+ "IconTextSize",
+ "IconTextWrap",
+ "IconTimeDuration30",
+ "IconTimeDuration60",
+ "IconTimelineEvent",
+ "IconTool",
+ "IconTransform",
+ "IconTrash",
+ "IconTrashOff",
+ "IconTrashX",
+ "IconTrendingDown",
+ "IconTrendingUp",
+ "IconTypography",
+ "IconUnderline",
+ "IconUnlink",
+ "IconUpload",
+ "IconUser",
+ "IconUserCircle",
+ "IconUserCog",
+ "IconUserPin",
+ "IconUserPlus",
+ "IconUsers",
+ "IconVariable",
+ "IconVariablePlus",
+ "IconVersions",
+ "IconVersionsOff",
+ "IconVideo",
+ "IconWand",
+ "IconWebhook",
+ "IconWindow",
+ "IconWorld",
+ "IconWorldWww",
+ "IconX"
+ ],
+ "props": [
+ "color",
+ "size",
+ "stroke",
+ "title"
+ ],
+ "supportsSvgAttributes": true
+ },
+ {
+ "names": [
+ "IconAddressBook",
+ "IconChartBarHorizontal"
+ ],
+ "props": [
+ "color",
+ "size",
+ "stroke"
+ ],
+ "supportsSvgAttributes": false
+ },
+ {
+ "names": [
+ "IconBrandAnthropic",
+ "IconBrandGemini",
+ "IconBrandGroq",
+ "IconBrandMistral",
+ "IconGmail",
+ "IconGoogle",
+ "IconGoogleCalendar",
+ "IconLockCustom",
+ "IconMicrosoft",
+ "IconMicrosoftCalendar",
+ "IconMicrosoftOutlook",
+ "IconModelClaude",
+ "IllustrationIconArray",
+ "IllustrationIconCalendarEvent",
+ "IllustrationIconCalendarTime",
+ "IllustrationIconCurrency",
+ "IllustrationIconFile",
+ "IllustrationIconJson",
+ "IllustrationIconLink",
+ "IllustrationIconMail",
+ "IllustrationIconManyToMany",
+ "IllustrationIconMap",
+ "IllustrationIconNumbers",
+ "IllustrationIconOneToMany",
+ "IllustrationIconOneToOne",
+ "IllustrationIconPhone",
+ "IllustrationIconSetting",
+ "IllustrationIconStar",
+ "IllustrationIconTag",
+ "IllustrationIconTags",
+ "IllustrationIconText",
+ "IllustrationIconToggle",
+ "IllustrationIconUid",
+ "IllustrationIconUser"
+ ],
+ "props": [
+ "size"
+ ],
+ "supportsSvgAttributes": false
+ },
+ {
+ "names": [
+ "IconBrandTypesafeAi",
+ "IconBrandXai",
+ "IconProviderOpenai"
+ ],
+ "props": [
+ "color",
+ "size"
+ ],
+ "supportsSvgAttributes": false
+ },
+ {
+ "names": [
+ "IconRelationManyToOne",
+ "IconTrashXOff",
+ "IconTwentyStar",
+ "IconTwentyStarFilled"
+ ],
+ "props": [
+ "size",
+ "stroke"
+ ],
+ "supportsSvgAttributes": false
+ },
+ {
+ "names": [
+ "IconSparkle2"
+ ],
+ "props": [
+ "aria-hidden",
+ "className",
+ "color",
+ "size",
+ "stroke"
+ ],
+ "supportsSvgAttributes": false
+ }
+]
diff --git a/packages/twenty-ui/scripts/generateDocsData.ts b/packages/twenty-ui/scripts/generateDocsData.ts
index 2dc6daf99f5..af66f5765ab 100644
--- a/packages/twenty-ui/scripts/generateDocsData.ts
+++ b/packages/twenty-ui/scripts/generateDocsData.ts
@@ -13,12 +13,17 @@ import { collectLeaves } from '../design-tokens/pipeline/collectLeaves';
import { DOCUMENTED_COMPONENTS } from '../docs/components';
import { DocumentationParser } from '../docs/DocumentationParser';
import { formatDocumentationTokenValue } from '../docs/formatDocumentationTokenValue';
+import { getIconDocumentationGroups } from '../docs/getIconDocumentationGroups';
+import { getIconProps } from '../docs/getIconProps';
+import { getPublicComponentExports } from '../docs/getPublicComponentExports';
+import { isIconComponent } from '../docs/isIconComponent';
import { normalizeDocumentationDefaultValue } from '../docs/normalizeDocumentationDefaultValue';
import { normalizeDocumentationPropType } from '../docs/normalizeDocumentationPropType';
import {
type ComponentDocumentation,
type TokenDocumentation,
} from '../docs/types';
+import { isDefined } from '../src/utilities/utils/isDefined';
const HIDDEN_PROP_TAGS = ['ignore', 'internal'];
const COMPONENT_PART_NAME_PATTERN = /^[A-Z]/;
@@ -51,11 +56,63 @@ if (errors.length > 0) {
const sourcePaths = DOCUMENTED_COMPONENTS.map((component) =>
resolve(sourceRoot, component.source),
);
-const program = ts.createProgram(sourcePaths, {
- ...options,
- preserveSymlinks: true,
-});
+const packageManifest: { exports: Record<string, unknown> } = JSON.parse(
+ readFileSync(resolve(packageRoot, 'package.json'), 'utf8'),
+);
+const entryPoints = Object.keys(packageManifest.exports)
+ .filter((subpath) => !subpath.endsWith('.css'))
+ .map((subpath) => ({
+ name: subpath === '.' ? 'twenty-ui' : `twenty-ui/${subpath.slice(2)}`,
+ path: resolve(sourceRoot, subpath, 'index.ts'),
+ }));
+const program = ts.createProgram(
+ [...sourcePaths, ...entryPoints.map((entry) => entry.path)],
+ {
+ ...options,
+ preserveSymlinks: true,
+ },
+);
const checker = program.getTypeChecker();
+const publicComponents = getPublicComponentExports({
+ checker,
+ entryPoints: entryPoints.map((entry) => {
+ const source = program.getSourceFile(entry.path);
+
+ if (!isDefined(source)) {
+ throw new Error(`Could not read ${entry.name}`);
+ }
+
+ return { name: entry.name, source };
+ }),
+});
+const documentedNames = new Set<string>(
+ DOCUMENTED_COMPONENTS.map((component) => component.name),
+);
+const documentedDecorators = new Set([
+ 'CatalogDecorator',
+ 'ComponentDecorator',
+]);
+const catalogIcons = publicComponents.filter(
+ (component) =>
+ component.entryPoints.includes('twenty-ui/icon') &&
+ !documentedNames.has(component.name) &&
+ isIconComponent(getIconProps({ checker, ...component })),
+);
+const iconNames = new Set(catalogIcons.map((icon) => icon.name));
+
+for (const component of publicComponents) {
+ if (
+ !documentedNames.has(component.name) &&
+ !iconNames.has(component.name) &&
+ !documentedDecorators.has(component.name)
+ ) {
+ throw new Error(
+ `Missing documentation for ${component.name} from ${component.entryPoints.join(', ')}. Add a public component reference.`,
+ );
+ }
+}
+
+const iconGroups = getIconDocumentationGroups({ checker, icons: catalogIcons });
const isReactNativeAttribute = (prop: PropItem): boolean =>
prop.declarations !== undefined &&
@@ -67,10 +124,14 @@ const isReactNativeAttribute = (prop: PropItem): boolean =>
const isHiddenProp = (prop: PropItem): boolean =>
HIDDEN_PROP_TAGS.some((tag) => tag in (prop.tags ?? {}));
-const isDeclaredInTwentyUi = (prop: PropItem): boolean =>
- prop.declarations?.some((declaration) =>
- declaration.fileName.startsWith(sourceRoot),
- ) ?? false;
+const isDeclaredInTwentyUi = (propsType: ts.Type, propName: string): boolean =>
+ (propsType.isUnion() ? propsType.types : [propsType])
+ .flatMap(
+ (memberType) => memberType.getProperty(propName)?.getDeclarations() ?? [],
+ )
+ .some((declaration) =>
+ declaration.getSourceFile().fileName.startsWith(sourceRoot),
+ );
const parserOptions: ParserOptions = {
shouldExtractLiteralValuesFromEnum: true,
@@ -106,11 +167,20 @@ const extractProps = ({
declaration.getSourceFile(),
() => name,
);
+ const propsSymbol = componentParser.extractPropsFromTypeIfStatelessComponent(
+ checker.getTypeOfSymbolAtLocation(symbol, declaration),
+ );
- if (!parsed || Object.keys(parsed.props).length === 0) {
+ if (
+ !isDefined(parsed) ||
+ !isDefined(propsSymbol) ||
+ Object.keys(parsed.props).length === 0
+ ) {
throw new Error(`Could not extract props for ${name}`);
}
+ const propsType = checker.getTypeOfSymbol(propsSymbol);
+
return Object.values(parsed.props)
.sort((left, right) => left.name.localeCompare(right.name, 'en'))
.map((prop) => {
@@ -118,7 +188,10 @@ const extractProps = ({
propDescriptions[prop.name] ?? prop.description
).trim();
- if (description.length === 0 && isDeclaredInTwentyUi(prop)) {
+ if (
+ description.length === 0 &&
+ isDeclaredInTwentyUi(propsType, prop.name)
+ ) {
throw new Error(
`Missing description for ${name}.${prop.name}. Document the prop in its props type or documentation metadata.`,
);
@@ -245,6 +318,7 @@ const tokens: TokenDocumentation[] = collectLeaves(DESIGN_TOKENS)
const outputs = [
{ name: 'components.docs.json', data: components },
{ name: 'tokens.docs.json', data: tokens },
+ { name: 'icons.docs.json', data: iconGroups },
];
const isCheckMode = process.argv.includes('--check');
diff --git a/packages/twenty-ui/src/components/code-editor/CodeEditor/__stories__/CodeEditor.stories.tsx b/packages/twenty-ui/src/components/code-editor/CodeEditor/__stories__/CodeEditor.stories.tsx
index 9ad45e6df66..a3ea92931bf 100644
--- a/packages/twenty-ui/src/components/code-editor/CodeEditor/__stories__/CodeEditor.stories.tsx
+++ b/packages/twenty-ui/src/components/code-editor/CodeEditor/__stories__/CodeEditor.stories.tsx
@@ -69,8 +69,7 @@ export const Resizable: Story = {
};
export const Documentation: Story = {
- ...Default,
- play: undefined,
+ decorators: Default.decorators,
args: { variant: 'with-header' },
render: (args) => (
<div style={{ width: '100%' }}>
diff --git a/packages/twenty-ui/src/components/feedback/Toast/__stories__/Toast.stories.tsx b/packages/twenty-ui/src/components/feedback/Toast/__stories__/Toast.stories.tsx
index 08930c08ec2..64c6b450389 100644
--- a/packages/twenty-ui/src/components/feedback/Toast/__stories__/Toast.stories.tsx
+++ b/packages/twenty-ui/src/components/feedback/Toast/__stories__/Toast.stories.tsx
@@ -37,9 +37,9 @@ export const Default: Story = {
};
export const Documentation: Story = {
- ...Default,
+ decorators: Default.decorators,
+ args: Default.args,
render: (args) => <DismissibleToast {...args} />,
- play: undefined,
};
export const WithDescriptionAndAction: Story = {
diff --git a/packages/twenty-ui/src/components/input/IconButton/__stories__/IconButton.stories.tsx b/packages/twenty-ui/src/components/input/IconButton/__stories__/IconButton.stories.tsx
index c58f1072e9a..25a300c0030 100644
--- a/packages/twenty-ui/src/components/input/IconButton/__stories__/IconButton.stories.tsx
+++ b/packages/twenty-ui/src/components/input/IconButton/__stories__/IconButton.stories.tsx
@@ -206,8 +206,8 @@ export const Tooltip: Story = {
};
export const TooltipDocumentation: Story = {
- ...Tooltip,
- play: undefined,
+ decorators: Tooltip.decorators,
+ args: Tooltip.args,
};
export const TooltipDisabled: Story = {
diff --git a/packages/twenty-ui/src/components/input/LightIconButton/__stories__/LightIconButton.stories.tsx b/packages/twenty-ui/src/components/input/LightIconButton/__stories__/LightIconButton.stories.tsx
index edf0c453ba0..281a58fec4c 100644
--- a/packages/twenty-ui/src/components/input/LightIconButton/__stories__/LightIconButton.stories.tsx
+++ b/packages/twenty-ui/src/components/input/LightIconButton/__stories__/LightIconButton.stories.tsx
@@ -34,8 +34,8 @@ export const Default: Story = {
};
export const Documentation: Story = {
- ...Default,
- play: undefined,
+ decorators: Default.decorators,
+ args: Default.args,
};
export const Appearance: Story = {
diff --git a/packages/twenty-ui/src/components/input/LightIconButton/__stories__/LightIconButtonGroups.stories.tsx b/packages/twenty-ui/src/components/input/LightIconButton/__stories__/LightIconButtonGroups.stories.tsx
index 869eb93eea4..862c2db8d92 100644
--- a/packages/twenty-ui/src/components/input/LightIconButton/__stories__/LightIconButtonGroups.stories.tsx
+++ b/packages/twenty-ui/src/components/input/LightIconButton/__stories__/LightIconButtonGroups.stories.tsx
@@ -65,8 +65,8 @@ export const Framed: Story = {
},
};
export const FramedDocumentation: Story = {
- ...Framed,
- play: undefined,
+ decorators: Framed.decorators,
+ render: Framed.render,
};
export const FramedDark: Story = {
diff --git a/packages/twenty-ui/src/components/layout/AnimatedIconCrossfade/__stories__/AnimatedIconCrossfade.stories.tsx b/packages/twenty-ui/src/components/layout/AnimatedIconCrossfade/__stories__/AnimatedIconCrossfade.stories.tsx
index eae46db5a7b..c64c4a95373 100644
--- a/packages/twenty-ui/src/components/layout/AnimatedIconCrossfade/__stories__/AnimatedIconCrossfade.stories.tsx
+++ b/packages/twenty-ui/src/components/layout/AnimatedIconCrossfade/__stories__/AnimatedIconCrossfade.stories.tsx
@@ -70,6 +70,6 @@ export const AnimatedIcon: Story = {
},
};
export const AnimatedIconDocumentation: Story = {
- ...AnimatedIcon,
- play: undefined,
+ decorators: AnimatedIcon.decorators,
+ render: AnimatedIcon.render,
};
diff --git a/packages/twenty-ui/src/components/layout/Section/__stories__/Section.stories.tsx b/packages/twenty-ui/src/components/layout/Section/__stories__/Section.stories.tsx
index 79aca07b2a1..81b9103d0ff 100644
--- a/packages/twenty-ui/src/components/layout/Section/__stories__/Section.stories.tsx
+++ b/packages/twenty-ui/src/components/layout/Section/__stories__/Section.stories.tsx
@@ -34,8 +34,8 @@ export const WithDescription: Story = {
};
export const Documentation: Story = {
- ...WithDescription,
- play: undefined,
+ decorators: WithDescription.decorators,
+ args: WithDescription.args,
render: (args) => (
<Section.Root>
<Section.Header {...args} />
diff --git a/packages/twenty-ui/src/components/navigation/Dropdown/__stories__/Dropdown.stories.tsx b/packages/twenty-ui/src/components/navigation/Dropdown/__stories__/Dropdown.stories.tsx
index b6e8e66fc51..b65e71ca64d 100644
--- a/packages/twenty-ui/src/components/navigation/Dropdown/__stories__/Dropdown.stories.tsx
+++ b/packages/twenty-ui/src/components/navigation/Dropdown/__stories__/Dropdown.stories.tsx
@@ -156,6 +156,10 @@ export const Picker: Story = {
},
};
+export const PickerDocumentation: Story = {
+ render: Picker.render,
+};
+
export const MultipleSelection: Story = {
render: () => <DropdownPickerExample multiple />,
play: async ({ canvasElement }) => {
@@ -173,6 +177,10 @@ export const MultipleSelection: Story = {
},
};
+export const MultipleSelectionDocumentation: Story = {
+ render: MultipleSelection.render,
+};
+
export const MultipleSelectionDark: Story = {
...MultipleSelection,
globals: { colorScheme: 'dark' },
@@ -221,6 +229,10 @@ export const Pages: Story = {
},
};
+export const PagesDocumentation: Story = {
+ render: Pages.render,
+};
+
export const PagesDark: Story = {
...Pages,
globals: { colorScheme: 'dark' },
@@ -246,6 +258,10 @@ export const Panel: Story = {
},
};
+export const PanelDocumentation: Story = {
+ render: Panel.render,
+};
+
export const Nested: Story = {
render: () => <DropdownNestedExample />,
play: async ({ canvasElement }) => {
@@ -289,3 +305,7 @@ export const Nested: Story = {
);
},
};
+
+export const NestedDocumentation: Story = {
+ render: Nested.render,
+};
diff --git a/packages/twenty-ui/src/primitives/data-display/Status/__stories__/Status.stories.tsx b/packages/twenty-ui/src/primitives/data-display/Status/__stories__/Status.stories.tsx
index 9d4e630771d..b6fa556ac05 100644
--- a/packages/twenty-ui/src/primitives/data-display/Status/__stories__/Status.stories.tsx
+++ b/packages/twenty-ui/src/primitives/data-display/Status/__stories__/Status.stories.tsx
@@ -39,8 +39,8 @@ export const Default: Story = {
};
export const Documentation: Story = {
- ...Default,
- play: undefined,
+ args: Default.args,
+ decorators: Default.decorators,
};
export const WithLongText: Story = {
diff --git a/packages/twenty-ui/src/primitives/data-display/Tag/__stories__/Tag.stories.tsx b/packages/twenty-ui/src/primitives/data-display/Tag/__stories__/Tag.stories.tsx
index 53efde71e2d..95ccb3b02aa 100644
--- a/packages/twenty-ui/src/primitives/data-display/Tag/__stories__/Tag.stories.tsx
+++ b/packages/twenty-ui/src/primitives/data-display/Tag/__stories__/Tag.stories.tsx
@@ -40,8 +40,8 @@ export const Default: Story = {
};
export const Documentation: Story = {
- ...Default,
- play: undefined,
+ args: Default.args,
+ decorators: Default.decorators,
};
export const WithLongText: Story = {
diff --git a/packages/twenty-ui/src/primitives/feedback/Loader/__stories__/Loader.stories.tsx b/packages/twenty-ui/src/primitives/feedback/Loader/__stories__/Loader.stories.tsx
index 09d0a19649e..b09caceded2 100644
--- a/packages/twenty-ui/src/primitives/feedback/Loader/__stories__/Loader.stories.tsx
+++ b/packages/twenty-ui/src/primitives/feedback/Loader/__stories__/Loader.stories.tsx
@@ -30,6 +30,10 @@ export const WithColor: Story = {
},
};
+export const WithColorDocumentation: Story = {
+ args: WithColor.args,
+};
+
export const WithDefaultCssVariable: Story = {
decorators: [
(Story) => (
diff --git a/packages/twenty-ui/src/primitives/input/ButtonGroup/__stories__/ButtonGroup.stories.tsx b/packages/twenty-ui/src/primitives/input/ButtonGroup/__stories__/ButtonGroup.stories.tsx
index 6e1c8653c50..f48a4029da1 100644
--- a/packages/twenty-ui/src/primitives/input/ButtonGroup/__stories__/ButtonGroup.stories.tsx
+++ b/packages/twenty-ui/src/primitives/input/ButtonGroup/__stories__/ButtonGroup.stories.tsx
@@ -38,6 +38,11 @@ export const Default: Story = {
},
};
+export const Documentation: Story = {
+ args: Default.args,
+ decorators: Default.decorators,
+};
+
export const Dark: Story = { ...Default, globals: { colorScheme: 'dark' } };
export const Single: Story = {
...Default,
diff --git a/packages/twenty-ui/src/primitives/input/Radio/__stories__/Radio.stories.tsx b/packages/twenty-ui/src/primitives/input/Radio/__stories__/Radio.stories.tsx
index 5bfd413a2ed..a7cc8092666 100644
--- a/packages/twenty-ui/src/primitives/input/Radio/__stories__/Radio.stories.tsx
+++ b/packages/twenty-ui/src/primitives/input/Radio/__stories__/Radio.stories.tsx
@@ -51,8 +51,7 @@ export const Default: Story = {
};
export const Documentation: Story = {
- ...Default,
- play: undefined,
+ decorators: Default.decorators,
};
export const Catalog: CatalogStory<Story, typeof RadioExample> = {
diff --git a/packages/twenty-ui/src/primitives/input/SegmentedControl/__stories__/SegmentedControl.stories.tsx b/packages/twenty-ui/src/primitives/input/SegmentedControl/__stories__/SegmentedControl.stories.tsx
index 58dd261b39b..b7b35d1c2b6 100644
--- a/packages/twenty-ui/src/primitives/input/SegmentedControl/__stories__/SegmentedControl.stories.tsx
+++ b/packages/twenty-ui/src/primitives/input/SegmentedControl/__stories__/SegmentedControl.stories.tsx
@@ -42,6 +42,8 @@ export const Default: Story = {
},
};
+export const Documentation: Story = {};
+
export const Dark: Story = {
globals: { colorScheme: 'dark' },
};
@@ -130,3 +132,7 @@ export const RightToLeft: Story = {
await waitFor(() => expect(annual).toBeChecked());
},
};
+
+export const RightToLeftDocumentation: Story = {
+ render: RightToLeft.render,
+};
diff --git a/packages/twenty-ui/src/primitives/input/Select/__stories__/Select.stories.tsx b/packages/twenty-ui/src/primitives/input/Select/__stories__/Select.stories.tsx
index 2cbc8c92252..52088d777df 100644
--- a/packages/twenty-ui/src/primitives/input/Select/__stories__/Select.stories.tsx
+++ b/packages/twenty-ui/src/primitives/input/Select/__stories__/Select.stories.tsx
@@ -49,8 +49,9 @@ export const Default: Story = {
};
export const Documentation: Story = {
- ...Default,
- play: undefined,
+ decorators: Default.decorators,
+ parameters: Default.parameters,
+ args: Default.args,
};
export const Placeholder: Story = {
diff --git a/packages/twenty-ui/src/primitives/layout/ResizeHandle/__stories__/ResizeHandle.stories.tsx b/packages/twenty-ui/src/primitives/layout/ResizeHandle/__stories__/ResizeHandle.stories.tsx
index c3c4d7707f2..95c488c55b3 100644
--- a/packages/twenty-ui/src/primitives/layout/ResizeHandle/__stories__/ResizeHandle.stories.tsx
+++ b/packages/twenty-ui/src/primitives/layout/ResizeHandle/__stories__/ResizeHandle.stories.tsx
@@ -33,6 +33,10 @@ export const Resizable: Story = {
},
};
+export const ResizableDocumentation: Story = {
+ render: Resizable.render,
+};
+
export const Horizontal: Story = {
render: () => <ResizableDemo axis="x" />,
play: async ({ canvasElement }) => {
diff --git a/packages/twenty-ui/src/primitives/navigation/Tabs/__stories__/Tabs.stories.tsx b/packages/twenty-ui/src/primitives/navigation/Tabs/__stories__/Tabs.stories.tsx
index d9a236637a5..4424ceac0d4 100644
--- a/packages/twenty-ui/src/primitives/navigation/Tabs/__stories__/Tabs.stories.tsx
+++ b/packages/twenty-ui/src/primitives/navigation/Tabs/__stories__/Tabs.stories.tsx
@@ -113,8 +113,8 @@ export const Default: Story = {
};
export const Documentation: Story = {
- ...Default,
- play: undefined,
+ decorators: Default.decorators,
+ parameters: Default.parameters,
};
export const Controlled: Story = {
diff --git a/packages/twenty-ui/src/primitives/surfaces/AlertDialog/__stories__/AlertDialog.stories.tsx b/packages/twenty-ui/src/primitives/surfaces/AlertDialog/__stories__/AlertDialog.stories.tsx
index ac69490c682..a42494b9b3e 100644
--- a/packages/twenty-ui/src/primitives/surfaces/AlertDialog/__stories__/AlertDialog.stories.tsx
+++ b/packages/twenty-ui/src/primitives/surfaces/AlertDialog/__stories__/AlertDialog.stories.tsx
@@ -48,9 +48,8 @@ export const Default: Story = {
};
export const Documentation: Story = {
- ...Default,
+ decorators: Default.decorators,
args: { defaultOpen: false },
- play: undefined,
};
export const Small: Story = {
diff --git a/packages/twenty-ui/src/primitives/surfaces/Dialog/__stories__/Dialog.stories.tsx b/packages/twenty-ui/src/primitives/surfaces/Dialog/__stories__/Dialog.stories.tsx
index 62985ed4310..91b988a0956 100644
--- a/packages/twenty-ui/src/primitives/surfaces/Dialog/__stories__/Dialog.stories.tsx
+++ b/packages/twenty-ui/src/primitives/surfaces/Dialog/__stories__/Dialog.stories.tsx
@@ -47,9 +47,8 @@ export const Default: Story = {
};
export const Documentation: Story = {
- ...Default,
+ decorators: Default.decorators,
args: { defaultOpen: false },
- play: undefined,
};
export const DocumentationInteractions: Story = {
diff --git a/packages/twenty-ui/src/primitives/surfaces/Menu/__stories__/Menu.stories.tsx b/packages/twenty-ui/src/primitives/surfaces/Menu/__stories__/Menu.stories.tsx
index d1eadc93bbe..2a6fdea00a2 100644
--- a/packages/twenty-ui/src/primitives/surfaces/Menu/__stories__/Menu.stories.tsx
+++ b/packages/twenty-ui/src/primitives/surfaces/Menu/__stories__/Menu.stories.tsx
@@ -155,9 +155,9 @@ export const Default: Story = {
};
export const Documentation: Story = {
- ...Default,
+ decorators: Default.decorators,
+ parameters: Default.parameters,
args: { defaultOpen: false },
- play: undefined,
};
export const DocumentationInteractions: Story = {
diff --git a/packages/twenty-ui/src/primitives/typography/OverflowingTextWithTooltip/__stories__/OverflowTextWithTooltip.stories.tsx b/packages/twenty-ui/src/primitives/typography/OverflowingTextWithTooltip/__stories__/OverflowTextWithTooltip.stories.tsx
index d264c5bcf4c..7026d6c2153 100644
--- a/packages/twenty-ui/src/primitives/typography/OverflowingTextWithTooltip/__stories__/OverflowTextWithTooltip.stories.tsx
+++ b/packages/twenty-ui/src/primitives/typography/OverflowingTextWithTooltip/__stories__/OverflowTextWithTooltip.stories.tsx
@@ -34,6 +34,11 @@ export const SingleLineOverflowing: Story = {
},
};
+export const SingleLineOverflowingDocumentation: Story = {
+ args: SingleLineOverflowing.args,
+ decorators: SingleLineOverflowing.decorators,
+};
+
export const SingleLineNotOverflowing: Story = {
args: {
text: 'Short',
diff --git a/packages/twenty-ui/src/primitives/typography/Text/__stories__/Text.stories.tsx b/packages/twenty-ui/src/primitives/typography/Text/__stories__/Text.stories.tsx
index 4c3e3fd5ca7..84f1e6f7fb5 100644
--- a/packages/twenty-ui/src/primitives/typography/Text/__stories__/Text.stories.tsx
+++ b/packages/twenty-ui/src/primitives/typography/Text/__stories__/Text.stories.tsx
@@ -44,8 +44,9 @@ export const Truncate: Story = {
};
export const Documentation: Story = {
- ...Truncate,
- play: undefined,
+ decorators: Truncate.decorators,
+ args: Truncate.args,
+ parameters: Truncate.parameters,
};
export const LineClamp: Story = {