The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
import { SELECT_PART_PROP_DESCRIPTIONS } from './selectPartPropDescriptions';
import { CHECKBOX_PROP_DESCRIPTIONS } from './checkboxPropDescriptions';
import { SWITCH_PROP_DESCRIPTIONS } from './switchPropDescriptions';
import { TEXTAREA_PROP_DESCRIPTIONS } from './textareaPropDescriptions';
import { INPUT_GROUP_PROP_DESCRIPTIONS } from './inputGroupPropDescriptions';
import { FORM_FIELD_ROW_PROP_DESCRIPTIONS } from './formFieldRowPropDescriptions';
import { INPUT_PROP_DESCRIPTIONS } from './inputPropDescriptions';
import { COUNTRY_SELECT_PROP_DESCRIPTIONS } from './countrySelectPropDescriptions';
import { COUNTRY_SELECT_PART_PROP_DESCRIPTIONS } from './countrySelectPartPropDescriptions';
import { CURRENCY_PICKER_PART_PROP_DESCRIPTIONS } from './currencyPickerPartPropDescriptions';
import { CURRENCY_PICKER_PROP_DESCRIPTIONS } from './currencyPickerPropDescriptions';
import { COUNT_PAGER_PROP_DESCRIPTIONS } from './countPagerPropDescriptions';
import { OVERFLOWING_LIST_PROP_DESCRIPTIONS } from './overflowingListPropDescriptions';
import { METRIC_ROW_PROP_DESCRIPTIONS } from './metricRowPropDescriptions';
import { DETAILS_ROW_PROP_DESCRIPTIONS } from './detailsRowPropDescriptions';
import { PROGRESS_PART_PROP_DESCRIPTIONS } from './progressPartPropDescriptions';
import { PROGRESS_RING_PROP_DESCRIPTIONS } from './progressRingPropDescriptions';
import { AVATAR_GROUP_PROP_DESCRIPTIONS } from './avatarGroupPropDescriptions';
import { COMMAND_BLOCK_PROP_DESCRIPTIONS } from './commandBlockPropDescriptions';
import { JSON_TREE_PROP_DESCRIPTIONS } from './jsonTreePropDescriptions';
import { STACK_ICON_PROP_DESCRIPTIONS } from './stackIconPropDescriptions';
import { TINTED_ICON_TILE_PROP_DESCRIPTIONS } from './tintedIconTilePropDescriptions';
import { CALLOUT_PROP_DESCRIPTIONS } from './calloutPropDescriptions';
import { INLINE_BANNER_PROP_DESCRIPTIONS } from './inlineBannerPropDescriptions';
import { TOAST_PROP_DESCRIPTIONS } from './toastPropDescriptions';
import { TOAST_PROVIDER_PROP_DESCRIPTIONS } from './toastProviderPropDescriptions';
import { TOASTER_PROP_DESCRIPTIONS } from './toasterPropDescriptions';
import { RADIO_PROP_DESCRIPTIONS } from './radioPropDescriptions';
import { RADIO_GROUP_PROP_DESCRIPTIONS } from './radioGroupPropDescriptions';
import { PHONE_COUNTRY_PICKER_PART_PROP_DESCRIPTIONS } from './phoneCountryPickerPartPropDescriptions';
import { PHONE_COUNTRY_PICKER_PROP_DESCRIPTIONS } from './phoneCountryPickerPropDescriptions';
import { SEARCH_INPUT_PROP_DESCRIPTIONS } from './searchInputPropDescriptions';
import { DATE_PICKER_PROP_DESCRIPTIONS } from './datePickerPropDescriptions';
import { NUMBER_STEPPER_PROP_DESCRIPTIONS } from './numberStepperPropDescriptions';
import { NUMBER_FIELD_PART_PROP_DESCRIPTIONS } from './numberFieldPartPropDescriptions';
import { IMAGE_INPUT_PROP_DESCRIPTIONS } from './imageInputPropDescriptions';
import { ANIMATED_ICON_CROSSFADE_PROP_DESCRIPTIONS } from './animatedIconCrossfadePropDescriptions';
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 { GROUPED_CATALOG_PROP_DESCRIPTIONS } from './groupedCatalogPropDescriptions';
import { COLLAPSIBLE_PART_PROP_DESCRIPTIONS } from './collapsiblePropDescriptions';
import { AVATAR_PROP_DESCRIPTIONS } from './avatarPropDescriptions';
import { AVATAR_PART_PROP_DESCRIPTIONS } from './avatarPartPropDescriptions';
import { BANNER_PROP_DESCRIPTIONS } from './bannerPropDescriptions';
import { BREADCRUMB_PROP_DESCRIPTIONS } from './breadcrumbPropDescriptions';
import { BUTTON_GROUP_PROP_DESCRIPTIONS } from './buttonGroupPropDescriptions';
import { BUTTON_PROP_DESCRIPTIONS } from './buttonPropDescriptions';
import { CARD_ACTION_PROP_DESCRIPTIONS } from './cardActionPropDescriptions';
import { CARD_CONTROL_PROP_DESCRIPTIONS } from './cardControlPropDescriptions';
import { CARD_CONTENT_PROP_DESCRIPTIONS } from './cardContentPropDescriptions';
import { CARD_FOOTER_PROP_DESCRIPTIONS } from './cardFooterPropDescriptions';
import { CARD_HEADER_PROP_DESCRIPTIONS } from './cardHeaderPropDescriptions';
import { CARD_PROP_DESCRIPTIONS } from './cardPropDescriptions';
import { CHIP_PROP_DESCRIPTIONS } from './chipPropDescriptions';
import { CODE_EDITOR_HEADER_PROP_DESCRIPTIONS } from './codeEditorHeaderPropDescriptions';
import { CODE_EDITOR_PROP_DESCRIPTIONS } from './codeEditorPropDescriptions';
import { COLOR_SAMPLE_PROP_DESCRIPTIONS } from './colorSamplePropDescriptions';
import { ALERT_DIALOG_PART_PROP_DESCRIPTIONS } from './alertDialogPartPropDescriptions';
import { DIALOG_POPUP_PROP_DESCRIPTIONS } from './dialogPopupPropDescriptions';
import { DIALOG_PORTAL_PROP_DESCRIPTIONS } from './dialogPortalPropDescriptions';
import { DIALOG_TITLE_PROP_DESCRIPTIONS } from './dialogTitlePropDescriptions';
import { DROPDOWN_PART_PROP_DESCRIPTIONS } from './dropdownPartPropDescriptions';
import { TEXT_PROP_DESCRIPTIONS } from './textPropDescriptions';
import { HEADING_PROP_DESCRIPTIONS } from './headingPropDescriptions';
import { SEPARATOR_PROP_DESCRIPTIONS } from './separatorPropDescriptions';
import { ICON_BUTTON_PROP_DESCRIPTIONS } from './iconButtonPropDescriptions';
import { LIGHT_BUTTON_PROP_DESCRIPTIONS } from './lightButtonPropDescriptions';
import { REACTION_BUTTON_PROP_DESCRIPTIONS } from './reactionButtonPropDescriptions';
import { EMOJI_PICKER_PROP_DESCRIPTIONS } from './emojiPickerPropDescriptions';
import { LIGHT_ICON_BUTTON_PROP_DESCRIPTIONS } from './lightIconButtonPropDescriptions';
import { LOADER_PROP_DESCRIPTIONS } from './loaderPropDescriptions';
import { SKELETON_PROP_DESCRIPTIONS } from './skeletonPropDescriptions';
import { OVERFLOWING_TEXT_TOOLTIP_MODE_PROVIDER_PROP_DESCRIPTIONS } from './overflowingTextTooltipModeProviderPropDescriptions';
import { OVERFLOWING_TEXT_WITH_TOOLTIP_PROP_DESCRIPTIONS } from './overflowingTextWithTooltipPropDescriptions';
import { BADGE_PROP_DESCRIPTIONS } from './badgePropDescriptions';
import { PROGRESS_BAR_PROP_DESCRIPTIONS } from './progressBarPropDescriptions';
import { RESIZE_HANDLE_PROP_DESCRIPTIONS } from './resizeHandlePropDescriptions';
import { SECTION_HEADER_PROP_DESCRIPTIONS } from './sectionHeaderPropDescriptions';
import { SECTION_ROOT_PROP_DESCRIPTIONS } from './sectionRootPropDescriptions';
import { SEGMENTED_CONTROL_PROP_DESCRIPTIONS } from './segmentedControlPropDescriptions';
import { SETTINGS_ROW_PROP_DESCRIPTIONS } from './settingsRowPropDescriptions';
import { STATUS_PROP_DESCRIPTIONS } from './statusPropDescriptions';
import { TAG_PROP_DESCRIPTIONS } from './tagPropDescriptions';
import { DIRECTION_PROVIDER_PROP_DESCRIPTIONS } from './directionProviderPropDescriptions';
import { POPOVER_PART_PROP_DESCRIPTIONS } from './popoverPartPropDescriptions';
import { TOOLTIP_PART_PROP_DESCRIPTIONS } from './tooltipPartPropDescriptions';
import { TOOLTIP_PROP_DESCRIPTIONS } from './tooltipPropDescriptions';
import { VISUALLY_HIDDEN_PROP_DESCRIPTIONS } from './visuallyHiddenPropDescriptions';
const CHECKBOX_PROP_DEFAULTS = {
size: 'sm',
variant: 'solid',
shape: 'square',
color: 'accent',
hoverable: 'true',
};
const SWITCH_PROP_DEFAULTS = { size: 'md' };
export const DOCUMENTED_COMPONENTS = [
{
name: 'CountrySelect',
source: 'components/input/CountrySelect/CountrySelect.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/country-select',
propDescriptions: COUNTRY_SELECT_PROP_DESCRIPTIONS,
parts: ['Root', 'Trigger', 'Options'],
partPropDescriptions: COUNTRY_SELECT_PART_PROP_DESCRIPTIONS,
},
{
name: 'CurrencyPicker',
source: 'components/input/CurrencyPicker/CurrencyPicker.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/currency-picker',
propDescriptions: CURRENCY_PICKER_PROP_DESCRIPTIONS,
propDefaults: {
defaultValue: 'null',
disabled: 'false',
selectedFirst: 'false',
getOptionLabel: 'Name (CODE)',
getSearchText: 'Name (CODE) and symbol',
},
parts: ['Root', 'Trigger', 'Options'],
partPropDescriptions: CURRENCY_PICKER_PART_PROP_DESCRIPTIONS,
partPropDefaults: {
Root: {
getOptionLabel: 'Name (CODE)',
getSearchText: 'Name (CODE) and symbol',
},
},
},
{
name: 'ProgressRing',
source: 'primitives/feedback/ProgressRing/ProgressRing.tsx',
entryPoint: 'twenty-ui/primitives/feedback',
slug: 'feedback/progress-ring',
propDescriptions: PROGRESS_RING_PROP_DESCRIPTIONS,
},
{
name: 'DetailsRow',
source: 'components/data-display/DetailsRow/DetailsRow.tsx',
entryPoint: 'twenty-ui/components/data-display',
slug: 'components/data-display/details-row',
propDescriptions: DETAILS_ROW_PROP_DESCRIPTIONS,
propDefaults: { labelWidth: '7rem' },
},
{
name: 'MetricRow',
source: 'components/data-display/MetricRow/MetricRow.tsx',
entryPoint: 'twenty-ui/components/data-display',
slug: 'components/data-display/metric-row',
propDescriptions: METRIC_ROW_PROP_DESCRIPTIONS,
},
{
name: 'Shortcut',
source: 'primitives/typography/Shortcut/Shortcut.tsx',
entryPoint: 'twenty-ui/primitives/typography',
slug: 'typography/shortcut',
propDescriptions: {
shortcut:
'Flat key array for a simultaneous combination, or nested key arrays for an ordered sequence of combinations.',
platform:
'Optional mac or other platform override. Defaults to server-safe device detection.',
sequenceJoinLabel: 'Text between sequence steps. Defaults to then.',
combinationSeparator:
'Optional separator between simultaneous keys. Defaults to no separator on Apple devices and a space elsewhere.',
accessibleKeyLabels:
'Optional localized names for individual keys in screen reader output.',
variant: 'Keycaps, inline text, or a separated button hint.',
visibility:
'Always visible by default. Desktop hints hide on mobile viewports.',
},
},
{
name: 'VisuallyHidden',
source: 'primitives/accessibility/components/VisuallyHidden.tsx',
entryPoint: 'twenty-ui/primitives/accessibility',
slug: 'accessibility/visually-hidden',
propDescriptions: VISUALLY_HIDDEN_PROP_DESCRIPTIONS,
},
{
name: 'ColorSample',
source: 'primitives/data-display/ColorSample/ColorSample.tsx',
entryPoint: 'twenty-ui/primitives/data-display',
slug: 'data-display/color-sample',
propDescriptions: COLOR_SAMPLE_PROP_DESCRIPTIONS,
},
{
name: 'Badge',
nativeProps: 'span',
source: 'primitives/data-display/Badge/Badge.tsx',
entryPoint: 'twenty-ui/primitives/data-display',
slug: 'data-display/badge',
propDescriptions: BADGE_PROP_DESCRIPTIONS,
propDefaults: { size: 'sm', color: 'tertiary', shape: 'pill' },
},
{
name: 'Banner',
source: 'primitives/feedback/Banner/Banner.tsx',
entryPoint: 'twenty-ui/primitives/feedback',
slug: 'feedback/banner',
propDescriptions: BANNER_PROP_DESCRIPTIONS,
propDefaults: {
color: 'status palette',
status: 'info',
variant: 'solid',
closeLabel: 'Close',
},
parts: ['Action'],
partPropDescriptions: { Action: BUTTON_PROP_DESCRIPTIONS },
},
{
name: 'Loader',
source: 'primitives/feedback/Loader/Loader.tsx',
entryPoint: 'twenty-ui/primitives/feedback',
slug: 'feedback/loader',
propDescriptions: LOADER_PROP_DESCRIPTIONS,
},
{
name: 'Skeleton',
source: 'primitives/feedback/Skeleton/Skeleton.tsx',
entryPoint: 'twenty-ui/primitives/feedback',
slug: 'feedback/skeleton',
propDescriptions: SKELETON_PROP_DESCRIPTIONS,
},
{
name: 'Progress',
source: 'primitives/feedback/Progress/Progress.tsx',
entryPoint: 'twenty-ui/primitives/feedback',
slug: 'feedback/progress',
parts: ['Root', 'Track', 'Indicator', 'Label', 'Value'],
partPropDescriptions: PROGRESS_PART_PROP_DESCRIPTIONS,
},
{
name: 'ProgressBar',
source: 'primitives/feedback/ProgressBar/ProgressBar.tsx',
entryPoint: 'twenty-ui/primitives/feedback',
slug: 'feedback/progress-bar',
propDescriptions: PROGRESS_BAR_PROP_DESCRIPTIONS,
},
{
name: 'SegmentedControl',
source: 'components/input/SegmentedControl/SegmentedControl.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/segmented-control',
propDescriptions: SEGMENTED_CONTROL_PROP_DESCRIPTIONS,
},
{
name: 'Collapsible',
source: 'primitives/layout/Collapsible/Collapsible.tsx',
entryPoint: 'twenty-ui/primitives/layout',
slug: 'layout/collapsible',
partPropDescriptions: COLLAPSIBLE_PART_PROP_DESCRIPTIONS,
partPropDefaults: {
Panel: {
dimension: 'height',
containAnimation: 'true',
duration: 'normal',
},
},
},
{
name: 'Separator',
source: 'primitives/layout/Separator/Separator.tsx',
entryPoint: 'twenty-ui/primitives/layout',
slug: 'layout/separator',
propDescriptions: SEPARATOR_PROP_DESCRIPTIONS,
},
{
name: 'ResizeHandle',
source: 'primitives/layout/ResizeHandle/ResizeHandle.tsx',
entryPoint: 'twenty-ui/primitives/layout',
slug: 'layout/resize-handle',
propDescriptions: RESIZE_HANDLE_PROP_DESCRIPTIONS,
propDefaults: {
axis: 'y without edge',
defaultValue: '150',
dragThreshold: '5 with edge; 0 otherwise',
min: '50',
max: '500',
placement: 'edge with edge; inline otherwise',
step: '10',
},
},
{
name: 'DirectionProvider',
source: 'primitives/layout/DirectionProvider/DirectionProvider.tsx',
entryPoint: 'twenty-ui/primitives/layout',
slug: 'layout/direction-provider',
propDescriptions: DIRECTION_PROVIDER_PROP_DESCRIPTIONS,
},
{
name: 'OverflowingTextWithTooltip',
source:
'primitives/typography/OverflowingTextWithTooltip/OverflowingTextWithTooltip.tsx',
entryPoint: 'twenty-ui/primitives/typography',
slug: 'typography/overflowing-text-with-tooltip',
propDescriptions: OVERFLOWING_TEXT_WITH_TOOLTIP_PROP_DESCRIPTIONS,
},
{
name: 'OverflowingTextTooltipModeProvider',
source:
'primitives/typography/OverflowingTextWithTooltip/OverflowingTextTooltipModeProvider.tsx',
entryPoint: 'twenty-ui/primitives/typography',
slug: 'typography/overflowing-text-tooltip-mode-provider',
propDescriptions: OVERFLOWING_TEXT_TOOLTIP_MODE_PROVIDER_PROP_DESCRIPTIONS,
},
{
name: 'LightIconButton',
source: 'components/input/LightIconButton/LightIconButton.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/light-icon-button',
propDescriptions: LIGHT_ICON_BUTTON_PROP_DESCRIPTIONS,
propDefaults: { variant: 'ghost', size: 'sm' },
},
{
name: 'IconButton',
source: 'components/input/IconButton/IconButton.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/icon-button',
propDescriptions: ICON_BUTTON_PROP_DESCRIPTIONS,
propDefaults: {
variant: 'outline',
color: 'neutral',
size: 'md',
nativeButton: 'true (false for the built-in href anchor)',
},
},
{
name: 'MainButton',
source: 'components/input/MainButton/MainButton.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/main-button',
propDescriptions: BUTTON_PROP_DESCRIPTIONS,
propDefaults: { variant: 'solid' },
},
{
name: 'LightButton',
source: 'components/input/LightButton/LightButton.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/light-button',
propDescriptions: LIGHT_BUTTON_PROP_DESCRIPTIONS,
propDefaults: { variant: 'ghost', size: 'sm' },
},
{
name: 'EmojiPicker',
source: 'components/input/EmojiPicker/EmojiPicker.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/emoji-picker',
propDescriptions: EMOJI_PICKER_PROP_DESCRIPTIONS,
propDefaults: {
locale: 'en',
searchPlaceholder: 'searchLabel',
autoFocus: 'false',
},
},
{
name: 'ReactionButton',
source: 'components/input/ReactionButton/ReactionButton.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/reaction-button',
propDescriptions: REACTION_BUTTON_PROP_DESCRIPTIONS,
propDefaults: { loading: 'false', disabled: 'false' },
},
{
name: 'Button',
source: 'primitives/input/Button/Button.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/button',
propDescriptions: BUTTON_PROP_DESCRIPTIONS,
propDefaults: {
variant: 'outline',
color: 'neutral',
size: 'md',
nativeButton: 'true (false for the built-in href anchor)',
},
},
{
name: 'ButtonGroup',
source: 'primitives/input/ButtonGroup/ButtonGroup.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/button-group',
propDescriptions: BUTTON_GROUP_PROP_DESCRIPTIONS,
},
{
name: 'Field',
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',
source: 'primitives/input/Input/Input.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/input',
propDescriptions: INPUT_PROP_DESCRIPTIONS,
},
{
name: 'InputGroup',
source: 'primitives/input/InputGroup/InputGroup.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/input-group',
propDescriptions: INPUT_GROUP_PROP_DESCRIPTIONS,
},
{
name: 'NumberField',
source: 'primitives/input/NumberField/NumberField.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/number-field',
parts: [
'Root',
'Group',
'Input',
'Decrement',
'Increment',
'ScrubArea',
'ScrubAreaCursor',
],
partPropDescriptions: NUMBER_FIELD_PART_PROP_DESCRIPTIONS,
partPropDefaults: {
Root: {
defaultValue: 'empty',
step: '1',
smallStep: '0.1',
largeStep: '10',
allowOutOfRange: 'false',
allowWheelScrub: 'false',
snapOnStep: 'false',
required: 'false',
disabled: 'false',
readOnly: 'false',
},
Decrement: { nativeButton: 'true' },
Increment: { nativeButton: 'true' },
ScrubArea: { direction: 'horizontal', pixelSensitivity: '2' },
},
},
{
name: 'NumberStepper',
source: 'components/input/NumberStepper/NumberStepper.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/number-stepper',
propDescriptions: NUMBER_STEPPER_PROP_DESCRIPTIONS,
propDefaults: {
step: '1',
allowOutOfRange: 'false',
showButtons: 'true',
decrementLabel: 'Decrease value',
incrementLabel: 'Increase value',
},
},
{
name: 'Textarea',
source: 'primitives/input/Textarea/Textarea.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/textarea',
propDescriptions: TEXTAREA_PROP_DESCRIPTIONS,
},
{
name: 'Checkbox',
source: 'primitives/input/Checkbox/Checkbox.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/checkbox',
parts: ['Root', 'Indicator'],
propDescriptions: CHECKBOX_PROP_DESCRIPTIONS,
partPropDescriptions: { Root: CHECKBOX_PROP_DESCRIPTIONS },
propDefaults: CHECKBOX_PROP_DEFAULTS,
partPropDefaults: { Root: CHECKBOX_PROP_DEFAULTS },
},
{
name: 'Radio',
source: 'primitives/input/Radio/Radio.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/radio',
parts: ['Root', 'Indicator'],
propDescriptions: RADIO_PROP_DESCRIPTIONS,
propDefaults: { size: 'sm', variant: 'default' },
},
{
name: 'RadioGroup',
source: 'primitives/input/RadioGroup/RadioGroup.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/radio-group',
propDescriptions: RADIO_GROUP_PROP_DESCRIPTIONS,
propDefaults: { orientation: 'vertical' },
},
{
name: 'Autocomplete',
source: 'primitives/input/Autocomplete/Autocomplete.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/autocomplete',
partPropOverrides: {
Root: {
items: {
type: 'readonly TItem[] | readonly { items: readonly TItem[] }[]',
required: false,
},
filteredItems: {
type: 'readonly TItem[] | readonly { items: readonly TItem[] }[]',
},
filter: {
type: 'AutocompleteRootProps<TItem>["filter"]',
},
itemToStringValue: {
type: '(itemValue: TItem) => string',
},
onItemHighlighted: {
type: '(highlightedValue: TItem | undefined, eventDetails: AutocompleteRootHighlightEventDetails) => void',
},
},
Input: {
render: {
type: 'ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxInputState>',
},
},
},
partPropDescriptions: {
Item: {
descriptionPlacement:
'Where the description renders: inline after the content or at the end of the row.',
},
Root: {
items:
'Flat items or groups with an items array. Preserves the upstream item type; nullish entries are not supported.',
},
Value: {
children:
'Content or render function receiving the current input text.',
},
Collection: {
children: 'Render function receiving each filtered item and its index.',
},
Input: {
size: 'Visual size of the input. Inside an InputGroup, the group size applies. Not accepted with render.',
},
Popup: {
width:
'Width of the popup. Overrides its default minimum anchor width.',
},
Portal: {
container:
'Portal destination. Omitted uses the scoped theme container; explicit null waits without rendering. Element, ShadowRoot and ref targets pass through to Base UI.',
},
Positioner: {
ref: 'Ref to the positioning div, separate from Popup and Portal.',
sideOffset:
'Distance from the anchor. Defaults to 8; supports functional offsets.',
align: 'Alignment relative to the anchor. Defaults to start.',
},
},
},
{
name: 'Select',
source: 'primitives/input/Select/Select.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/select',
partPropDescriptions: SELECT_PART_PROP_DESCRIPTIONS,
partPropDefaults: { Trigger: { size: 'md' } },
},
{
name: 'Slider',
source: 'primitives/input/Slider/Slider.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/slider',
},
{
name: 'Switch',
source: 'primitives/input/Switch/Switch.tsx',
entryPoint: 'twenty-ui/primitives/input',
slug: 'input/switch',
parts: ['Root', 'Thumb'],
propDescriptions: SWITCH_PROP_DESCRIPTIONS,
partPropDescriptions: { Root: SWITCH_PROP_DESCRIPTIONS },
propDefaults: SWITCH_PROP_DEFAULTS,
partPropDefaults: { Root: SWITCH_PROP_DEFAULTS },
},
{
name: 'Breadcrumb',
source: 'primitives/navigation/Breadcrumb/Breadcrumb.tsx',
entryPoint: 'twenty-ui/primitives/navigation',
slug: 'navigation/breadcrumb',
propDescriptions: BREADCRUMB_PROP_DESCRIPTIONS,
},
{
name: 'ListItem',
source: 'primitives/navigation/ListItem/ListItem.tsx',
entryPoint: 'twenty-ui/primitives/navigation',
slug: 'navigation/list-item',
propDescriptions: {
ref: 'Ref to the actual DOM root, including a composed native button or link.',
selectionAppearance:
'Selection styling independent of description placement. `default` preserves indicator-based styling; `accent` fills selected rows with the accent background.',
active:
'Marks the open or current item independently of selection and focus. Does not add accessible state or activate the item.',
descriptionPlacement:
'Places supporting content inline after the label, at the end, or below it with wrapping. Inline is the default.',
selected:
'Applies selected styling and the configured decorative indicator. Selection state and accessible semantics belong to the owner.',
focused:
'Applies highlighted styling without moving DOM focus or handling keyboard navigation.',
disabled:
'Applies disabled styling only. Set native disabled behavior and accessible semantics on the button, link, or popup item owner.',
render:
'Composes the row with an element or render callback. The owner supplies interaction semantics, native attributes, and behavior.',
shortcutJoinLabel:
'Text between sequential shortcut steps. Defaults to `then`; pass an empty string to omit it.',
actionsVisibility:
'When trailing actions are visible: on hover and focus, or always.',
actionsPlacement:
'Keeps actions beside the content at every width when set to `end`. The default `auto` preserves responsive wrapping. Hidden end actions do not reserve width on devices without touch.',
},
},
{
name: 'Tabs',
source: 'primitives/navigation/Tabs/Tabs.tsx',
entryPoint: 'twenty-ui/primitives/navigation',
slug: 'navigation/tabs',
partPropDescriptions: {
Tab: {
endIcon: 'Decorative content after the label and before the badge.',
highlighted: 'Emphasizes the tab content without changing selection.',
size: 'Visual tab size. Compact uses a 24px minimum height, small text, and 4px content padding; sm and md keep a 40px minimum height.',
},
},
},
{
name: 'Card',
source: 'primitives/surfaces/Card/Card.tsx',
entryPoint: 'twenty-ui/primitives/surfaces',
slug: 'surfaces/card',
partPropDescriptions: {
Root: CARD_PROP_DESCRIPTIONS,
Action: CARD_ACTION_PROP_DESCRIPTIONS,
Control: CARD_CONTROL_PROP_DESCRIPTIONS,
Header: CARD_HEADER_PROP_DESCRIPTIONS,
Content: CARD_CONTENT_PROP_DESCRIPTIONS,
Footer: CARD_FOOTER_PROP_DESCRIPTIONS,
},
partPropDefaults: {
Action: { disabled: 'false' },
Footer: { divider: 'true' },
},
},
{
name: 'Dialog',
source: 'primitives/surfaces/Dialog/Dialog.tsx',
entryPoint: 'twenty-ui/primitives/surfaces',
slug: 'surfaces/dialog',
parts: [
'Root',
'Trigger',
'Portal',
'Backdrop',
'Viewport',
'Popup',
'Title',
'Description',
'Close',
'Header',
'Body',
'Footer',
],
partPropDescriptions: {
Root: {
children:
'Parts or a render function receiving the active trigger payload. Root renders no DOM node.',
handle: 'Connects detached triggers and imperative dialog actions.',
onOpenChange:
'Receives the requested state and Base UI event details, including reason, event, trigger and cancel().',
},
Trigger: {
ref: 'Ref to the trigger button, or the element supplied through render.',
},
Portal: DIALOG_PORTAL_PROP_DESCRIPTIONS,
Backdrop: {
ref: 'Ref to the backdrop div, or the element supplied through render.',
forceRender: 'Renders the backdrop even when this dialog is nested.',
},
Viewport: {
ref: 'Ref to the viewport div, or the element supplied through render.',
children:
'Popup and any other content within the positioning viewport.',
},
Popup: DIALOG_POPUP_PROP_DESCRIPTIONS,
Title: DIALOG_TITLE_PROP_DESCRIPTIONS,
Description: {
ref: 'Ref to the description paragraph, or the element supplied through render.',
},
Close: {
ref: 'Ref to the close button, or the element supplied through render.',
},
},
},
{
name: 'AlertDialog',
source: 'primitives/surfaces/AlertDialog/AlertDialog.tsx',
entryPoint: 'twenty-ui/primitives/surfaces',
slug: 'surfaces/alert-dialog',
parts: [
'Root',
'Trigger',
'Portal',
'Backdrop',
'Viewport',
'Popup',
'Title',
'Description',
'Close',
'Header',
'Body',
'Footer',
],
partPropDescriptions: ALERT_DIALOG_PART_PROP_DESCRIPTIONS,
partPropDefaults: { Popup: { size: 'md' } },
},
{
name: 'Popover',
source: 'primitives/surfaces/Popover/Popover.tsx',
entryPoint: 'twenty-ui/primitives/surfaces',
slug: 'surfaces/popover',
parts: [
'Root',
'Trigger',
'Portal',
'Positioner',
'Popup',
'Arrow',
'Backdrop',
'Title',
'Description',
'Close',
'Viewport',
],
partPropDescriptions: POPOVER_PART_PROP_DESCRIPTIONS,
partPropDefaults: { Positioner: { sideOffset: '8' } },
},
{
name: 'Tooltip',
source: 'primitives/surfaces/Tooltip/Tooltip.tsx',
entryPoint: 'twenty-ui/primitives/surfaces',
slug: 'surfaces/tooltip',
parts: [
'Root',
'Trigger',
'Portal',
'Positioner',
'Popup',
'Body',
'Arrow',
'Viewport',
'Provider',
],
propDescriptions: TOOLTIP_PROP_DESCRIPTIONS,
propDefaults: { sideOffset: '10' },
partPropDescriptions: TOOLTIP_PART_PROP_DESCRIPTIONS,
},
{
name: 'Toast',
source: 'components/feedback/Toast/Toast.tsx',
entryPoint: 'twenty-ui/components/feedback',
slug: 'components/feedback/toast',
propDescriptions: TOAST_PROP_DESCRIPTIONS,
},
{
name: 'Text',
source: 'primitives/typography/Text/Text.tsx',
entryPoint: 'twenty-ui/primitives/typography',
slug: 'typography/text',
propDescriptions: TEXT_PROP_DESCRIPTIONS,
},
{
name: 'Avatar',
source: 'primitives/data-display/Avatar/Avatar.tsx',
entryPoint: 'twenty-ui/primitives/data-display',
slug: 'data-display/avatar',
propDescriptions: AVATAR_PROP_DESCRIPTIONS,
propDefaults: {
size: 'md',
shape: 'square',
variant: 'soft',
pulsing: 'false',
ring: 'false',
},
parts: ['Root', 'Image', 'Fallback'],
partPropDescriptions: AVATAR_PART_PROP_DESCRIPTIONS,
},
{
name: 'Chip',
source: 'primitives/data-display/Chip/Chip.tsx',
entryPoint: 'twenty-ui/primitives/data-display',
slug: 'data-display/chip',
propDescriptions: CHIP_PROP_DESCRIPTIONS,
},
{
name: 'Tag',
source: 'primitives/data-display/Tag/Tag.tsx',
entryPoint: 'twenty-ui/primitives/data-display',
slug: 'data-display/tag',
propDescriptions: TAG_PROP_DESCRIPTIONS,
},
{
name: 'Status',
source: 'primitives/data-display/Status/Status.tsx',
entryPoint: 'twenty-ui/primitives/data-display',
slug: 'data-display/status',
propDescriptions: STATUS_PROP_DESCRIPTIONS,
},
{
name: 'Heading',
source: 'primitives/typography/Heading/Heading.tsx',
entryPoint: 'twenty-ui/primitives/typography',
slug: 'typography/heading',
propDescriptions: HEADING_PROP_DESCRIPTIONS,
},
{
name: 'SettingsRow',
source: 'components/settings/SettingsRow/SettingsRow.tsx',
entryPoint: 'twenty-ui/components/settings',
slug: 'components/settings/settings-row',
propDescriptions: SETTINGS_ROW_PROP_DESCRIPTIONS,
propDefaults: { size: 'sm' },
},
{
name: 'PhoneCountryPicker',
source: 'components/input/PhoneCountryPicker/PhoneCountryPicker.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/phone-country-picker',
propDescriptions: PHONE_COUNTRY_PICKER_PROP_DESCRIPTIONS,
parts: ['Root', 'Trigger', 'Options'],
partPropDescriptions: PHONE_COUNTRY_PICKER_PART_PROP_DESCRIPTIONS,
},
{
name: 'Dropdown',
source: 'components/navigation/Dropdown/Dropdown.tsx',
entryPoint: 'twenty-ui/components/navigation',
slug: 'components/navigation/dropdown',
parts: [
'Root',
'Trigger',
'Content',
'ActionItem',
'SelectionGroup',
'OptionItem',
'Search',
'Header',
'Title',
'Close',
'Page',
'Back',
'Submenu',
'SubmenuTrigger',
'Section',
'Separator',
'Loading',
'Empty',
],
partPropDescriptions: DROPDOWN_PART_PROP_DESCRIPTIONS,
partPropDefaults: {
ActionItem: {
nativeButton: 'true when render is omitted; false otherwise',
},
OptionItem: {
nativeButton: 'true when render is omitted; false otherwise',
},
Back: {
nativeButton: 'true when render is omitted; false otherwise',
},
SubmenuTrigger: {
nativeButton: 'true when render is omitted; false otherwise',
},
},
},
{
name: 'OverflowingList',
source: 'components/layout/OverflowingList/OverflowingList.tsx',
entryPoint: 'twenty-ui/components/layout',
slug: 'components/layout/overflowing-list',
propDescriptions: OVERFLOWING_LIST_PROP_DESCRIPTIONS,
},
{
name: 'LabeledSeparator',
source: 'components/layout/LabeledSeparator/LabeledSeparator.tsx',
entryPoint: 'twenty-ui/components/layout',
slug: 'components/layout/labeled-separator',
propDescriptions: {
children:
'Text naming the separator. Supplied and localized by the caller.',
labelPosition:
'Place the label between two lines or at the end of one line.',
tone: 'Neutral divider or red marker with a thicker rule.',
hasStartMarker: 'Show a decorative cap at the beginning of the rule.',
},
propDefaults: {
labelPosition: 'center',
tone: 'neutral',
hasStartMarker: 'false',
},
},
{
name: 'Section',
source: 'components/layout/Section/Section.tsx',
entryPoint: 'twenty-ui/components/layout',
slug: 'components/layout/section',
partPropDescriptions: {
Root: SECTION_ROOT_PROP_DESCRIPTIONS,
Header: SECTION_HEADER_PROP_DESCRIPTIONS,
},
},
{
name: 'CodeEditor',
source: 'components/code-editor/CodeEditor/CodeEditor.tsx',
entryPoint: 'twenty-ui/components/code-editor',
slug: 'components/code-editor/code-editor',
propDescriptions: CODE_EDITOR_PROP_DESCRIPTIONS,
propDefaults: { theme: 'Twenty theme', saveViewState: 'true' },
},
{
name: 'CodeEditorHeader',
source: 'components/code-editor/CodeEditorHeader/CodeEditorHeader.tsx',
entryPoint: 'twenty-ui/components/code-editor',
slug: 'components/code-editor/code-editor-header',
propDescriptions: CODE_EDITOR_HEADER_PROP_DESCRIPTIONS,
},
{
name: 'ListItemButton',
source: 'components/navigation/ListItemButton/ListItemButton.tsx',
entryPoint: 'twenty-ui/components/navigation',
slug: 'components/navigation/list-item-button',
propDescriptions: {
ref: 'Ref to the native HTMLButtonElement.',
disabled: 'Disables activation and applies the matching row appearance.',
focusableWhenDisabled:
'Keeps a disabled button focusable with aria-disabled while preventing activation.',
selectionAppearance:
'Selection styling independent of description placement. `default` preserves indicator-based styling; `accent` fills selected rows with the accent background.',
active:
'Marks the open or current item independently of selection and focus. The caller supplies accessible state.',
descriptionPlacement:
'Places supporting content inline after the label, at the end, or below it with wrapping. Inline is the default.',
selected:
'Applies selected styling and a decorative indicator. The caller supplies selection state and accessible semantics.',
focused: 'Highlights the row without moving DOM focus.',
shortcut:
'Displays decorative shortcut hints. The caller registers the shortcuts.',
shortcutJoinLabel:
'Text between sequential shortcut steps. Defaults to `then`; pass an empty string to omit it.',
hasSubmenu: 'Displays a decorative submenu indicator.',
},
propDefaults: { type: 'button', disabled: 'false' },
},
{
name: 'CountPager',
source: 'components/navigation/CountPager/CountPager.tsx',
entryPoint: 'twenty-ui/components/navigation',
slug: 'components/navigation/count-pager',
propDescriptions: COUNT_PAGER_PROP_DESCRIPTIONS,
propDefaults: {
disabled: 'false',
positionPlacement: 'between',
role: 'group',
},
},
{
name: 'TabButton',
source: 'components/navigation/TabButton/TabButton.tsx',
entryPoint: 'twenty-ui/components/navigation',
slug: 'components/navigation/tab-button',
propDescriptions: {
...BUTTON_PROP_DESCRIPTIONS,
active:
'Highlights the current destination or an action associated with the active tab. Does not change the control role.',
badge: 'Content following the label and trailing icon, such as a count.',
size: 'Padding of the tab content: sm or md. Explicit size takes precedence over the ButtonGroup size, then sm applies.',
},
propDefaults: { size: 'sm' },
},
{
name: 'AvatarGroup',
source: 'components/data-display/AvatarGroup/AvatarGroup.tsx',
entryPoint: 'twenty-ui/components/data-display',
slug: 'components/data-display/avatar-group',
propDescriptions: AVATAR_GROUP_PROP_DESCRIPTIONS,
},
{
name: 'CommandBlock',
source: 'components/data-display/CommandBlock/CommandBlock.tsx',
entryPoint: 'twenty-ui/components/data-display',
slug: 'components/data-display/command-block',
propDescriptions: COMMAND_BLOCK_PROP_DESCRIPTIONS,
},
{
name: 'JsonTree',
source: 'components/data-display/JsonTree/JsonTree.tsx',
entryPoint: 'twenty-ui/components/data-display',
slug: 'components/data-display/json-tree',
propDescriptions: JSON_TREE_PROP_DESCRIPTIONS,
},
{
name: 'TintedIconTile',
source: 'components/data-display/TintedIconTile/TintedIconTile.tsx',
entryPoint: 'twenty-ui/components/data-display',
slug: 'components/data-display/tinted-icon-tile',
propDescriptions: TINTED_ICON_TILE_PROP_DESCRIPTIONS,
},
{
name: 'StackIcon',
source: 'components/data-display/StackIcon/StackIcon.tsx',
entryPoint: 'twenty-ui/components/data-display',
slug: 'components/data-display/stack-icon',
propDescriptions: STACK_ICON_PROP_DESCRIPTIONS,
},
{
name: 'Callout',
nativeProps: 'div',
source: 'components/feedback/Callout/Callout.tsx',
entryPoint: 'twenty-ui/components/feedback',
slug: 'components/feedback/callout',
propDescriptions: CALLOUT_PROP_DESCRIPTIONS,
parts: ['Action'],
partPropDescriptions: { Action: BUTTON_PROP_DESCRIPTIONS },
propDefaults: {
closeLabel: 'Close',
color: 'status palette',
fullWidth: 'false',
icon: 'decorative help icon',
status: 'info',
variant: 'soft',
},
},
{
name: 'InlineBanner',
source: 'components/feedback/InlineBanner/InlineBanner.tsx',
entryPoint: 'twenty-ui/components/feedback',
slug: 'components/feedback/inline-banner',
propDescriptions: INLINE_BANNER_PROP_DESCRIPTIONS,
parts: ['Action'],
partPropDescriptions: { Action: BUTTON_PROP_DESCRIPTIONS },
propDefaults: {
color: 'status palette',
status: 'info',
variant: 'soft',
layout: 'standard',
embedded: 'false',
fullWidth: 'false',
icon: 'decorative information icon',
},
},
{
name: 'ToastProvider',
source: 'components/feedback/Toast/ToastProvider.tsx',
entryPoint: 'twenty-ui/components/feedback',
slug: 'components/feedback/toast-provider',
propDescriptions: TOAST_PROVIDER_PROP_DESCRIPTIONS,
},
{
name: 'Toaster',
source: 'components/feedback/Toaster/Toaster.tsx',
entryPoint: 'twenty-ui/components/feedback',
slug: 'components/feedback/toaster',
propDescriptions: TOASTER_PROP_DESCRIPTIONS,
},
{
name: 'FormFieldRow',
source: 'components/input/FormFieldRow/FormFieldRow.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/form-field-row',
propDescriptions: FORM_FIELD_ROW_PROP_DESCRIPTIONS,
propDefaults: {
labelWidth: '80',
contentPaddingInline: 'var(--t-spacing-2)',
isHoverable: 'false',
hasDivider: 'true',
},
},
{
name: 'ImageInput',
source: 'components/input/ImageInput/ImageInput.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/image-input',
propDescriptions: IMAGE_INPUT_PROP_DESCRIPTIONS,
},
{
name: 'DatePicker',
source: 'components/input/DatePicker/DatePicker.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/date-picker',
propDescriptions: DATE_PICKER_PROP_DESCRIPTIONS,
propDefaults: {
isKeyboardNavigationDisabled: 'false',
loadingFallback: '300px-high Skeleton',
disabled: 'false',
readOnly: 'false',
isGridHidden: 'false',
role: 'group',
},
},
{
name: 'SearchInput',
source: 'components/input/SearchInput/SearchInput.tsx',
entryPoint: 'twenty-ui/components/input',
slug: 'components/input/search-input',
propDescriptions: SEARCH_INPUT_PROP_DESCRIPTIONS,
},
{
name: 'AnimatedIconCrossfade',
source: 'components/layout/AnimatedIconCrossfade/AnimatedIconCrossfade.tsx',
entryPoint: 'twenty-ui/components/layout',
slug: 'components/layout/animated-icon-crossfade',
propDescriptions: ANIMATED_ICON_CROSSFADE_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/provider/components/Icon.tsx',
entryPoint: 'twenty-ui/icon/provider',
slug: 'icon/icon',
propDescriptions: ICON_PROP_DESCRIPTIONS,
},
{
name: 'IconsProvider',
source: 'icon/provider/IconsProvider.tsx',
entryPoint: 'twenty-ui/icon/provider',
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,
},
{
name: 'GroupedCatalog',
source: 'testing/GroupedCatalog.tsx',
entryPoint: 'twenty-ui/testing',
slug: 'testing/grouped-catalog',
propDescriptions: GROUPED_CATALOG_PROP_DESCRIPTIONS,
},
] as const;