{ "src/components/AlertBanner/AlertBanner.tsx": [ { "description": "", "methods": [], "displayName": "AlertBanner", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "Set external styling to the progress bar." }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "backgroundColor": { "required": false, "tsType": { "name": "AlertBannerBackgroundColor" }, "description": "", "defaultValue": { "value": "AlertBanner.backgroundColors.PRIMARY", "computed": true } }, "isCloseHidden": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "ARIA description for the progress bar", "defaultValue": { "value": "\"\"", "computed": false } }, "closeButtonAriaLabel": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"Close\"", "computed": false } }, "onClose": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "elements": [ { "name": "HTMLButtonElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "", "defaultValue": { "value": "function NOOP() {}", "computed": false } }, "children": { "required": false, "tsType": { "name": "union", "raw": "ChildrenType | ChildrenType[]", "elements": [ { "name": "ReactElement", "elements": [ { "name": "union", "raw": "AlertBannerButtonProps | AlertBannerLinkProps | AlertBannerTextProps", "elements": [ { "name": "AlertBannerButtonProps" }, { "name": "AlertBannerLinkProps" }, { "name": "AlertBannerTextProps" } ] } ], "raw": "ReactElement" }, { "name": "Array", "elements": [ { "name": "ReactElement", "elements": [ { "name": "union", "raw": "AlertBannerButtonProps | AlertBannerLinkProps | AlertBannerTextProps", "elements": [ { "name": "AlertBannerButtonProps" }, { "name": "AlertBannerLinkProps" }, { "name": "AlertBannerTextProps" } ] } ], "raw": "ReactElement" } ], "raw": "ChildrenType[]" } ] }, "description": "" } } } ], "src/components/AttentionBox/AttentionBox.tsx": [ { "description": "", "methods": [], "displayName": "AttentionBox", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "componentClassName": { "required": false, "tsType": { "name": "string" }, "description": "@deprecated - use className instead" }, "withIconWithoutHeader": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "type": { "required": false, "tsType": { "name": "AttentionBoxType" }, "description": "we support 5 types of attention boxes", "defaultValue": { "value": "AttentionBox.types.PRIMARY", "computed": true } }, "icon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Icon classname for icon font or SVG Icon Component for SVG Type" }, "iconType": { "required": false, "tsType": { "name": "union", "raw": "IconType.SVG | IconType.ICON_FONT", "elements": [ { "name": "IconType.SVG" }, { "name": "IconType.ICON_FONT" } ] }, "description": "", "defaultValue": { "value": "Icon.type.SVG", "computed": true } }, "title": { "required": false, "tsType": { "name": "string" }, "description": "" }, "text": { "required": false, "tsType": { "name": "string" }, "description": "" }, "children": { "required": false, "tsType": { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ] }, "description": "" }, "withoutIcon": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "onClose": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "" }, "compact": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "closeButtonAriaLabel": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"Close\"", "computed": false } } } } ], "src/components/Avatar/Avatar.tsx": [ { "description": "", "methods": [], "displayName": "Avatar", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "src": { "required": false, "tsType": { "name": "string" }, "description": "" }, "text": { "required": false, "tsType": { "name": "string" }, "description": "" }, "tooltipProps": { "required": false, "tsType": { "name": "intersection", "raw": "TooltipBaseProps & (TooltipWithChildrenProps | TooltipWithoutChildrenProps)", "elements": [ { "name": "TooltipBaseProps" }, { "name": "unknown" } ] }, "description": "" }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "" }, "withoutTooltip": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "icon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "" }, "type": { "required": false, "tsType": { "name": "AvatarType" }, "description": "", "defaultValue": { "value": "AvatarType.TEXT", "computed": true } }, "textClassName": { "required": false, "tsType": { "name": "string" }, "description": "Class name for the avatar content of text type", "defaultValue": { "value": "\"\"", "computed": false } }, "avatarContentWrapperClassName": { "required": false, "tsType": { "name": "string" }, "description": "Class name for a div-wrapper of avatar content" }, "backgroundColor": { "required": false, "tsType": { "name": "union", "raw": "(typeof ElementAllowedColor)[keyof typeof ElementAllowedColor] | string", "elements": [ { "name": "unknown[unknown]", "raw": "(typeof ElementAllowedColor)[keyof typeof ElementAllowedColor]" }, { "name": "string" } ] }, "description": "", "defaultValue": { "value": "Avatar.colors.CHILI_BLUE", "computed": true } }, "customBackgroundColor": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "null", "computed": false } }, "role": { "required": false, "tsType": { "name": "AriaRole" }, "description": "" }, "size": { "required": false, "tsType": { "name": "AvatarSize" }, "description": "", "defaultValue": { "value": "AvatarSize.LARGE", "computed": true } }, "customSize": { "required": false, "tsType": { "name": "number" }, "description": "", "defaultValue": { "value": "null", "computed": false } }, "tabIndex": { "required": false, "tsType": { "name": "number" }, "description": "" }, "ariaHidden": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "disabled": { "required": false, "tsType": { "name": "boolean" }, "description": "" }, "isSquare": { "required": false, "tsType": { "name": "boolean" }, "description": "@deprecated - use square instead" }, "isDisabled": { "required": false, "tsType": { "name": "boolean" }, "description": "@deprecated - use disabled instead" }, "square": { "required": false, "tsType": { "name": "boolean" }, "description": "" }, "topLeftBadgeProps": { "required": false, "tsType": { "name": "AvatarBadgeProps" }, "description": "" }, "topRightBadgeProps": { "required": false, "tsType": { "name": "AvatarBadgeProps" }, "description": "" }, "bottomLeftBadgeProps": { "required": false, "tsType": { "name": "AvatarBadgeProps" }, "description": "" }, "bottomRightBadgeProps": { "required": false, "tsType": { "name": "AvatarBadgeProps" }, "description": "" }, "withoutBorder": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent | React.KeyboardEvent, avatarId: string) => void", "signature": { "arguments": [ { "type": { "name": "union", "raw": "React.MouseEvent | React.KeyboardEvent", "elements": [ { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" } ] }, "name": "event" }, { "type": { "name": "string" }, "name": "avatarId" } ], "return": { "name": "void" } } }, "description": "" } } } ], "src/components/Avatar/AvatarBadge.tsx": [ { "description": "", "methods": [], "displayName": "AvatarBadge", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "src": { "required": false, "tsType": { "name": "string" }, "description": "" }, "icon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Use to provide SVG Components" }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "" }, "tabIndex": { "required": false, "tsType": { "name": "union", "raw": "string | number", "elements": [ { "name": "string" }, { "name": "number" } ] }, "description": "", "defaultValue": { "value": "0", "computed": false } }, "size": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "AvatarSize.LARGE", "computed": true } } } } ], "src/components/Avatar/AvatarContent.tsx": [ { "description": "", "methods": [], "displayName": "AvatarContent", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "src": { "required": false, "tsType": { "name": "string" }, "description": "" }, "type": { "required": false, "tsType": { "name": "AvatarType" }, "description": "", "defaultValue": { "value": "AvatarType.TEXT", "computed": true } }, "size": { "required": false, "tsType": { "name": "AvatarSize" }, "description": "", "defaultValue": { "value": "AvatarSize.LARGE", "computed": true } }, "role": { "required": false, "tsType": { "name": "string" }, "description": "" }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "" }, "icon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "we support two types of icons - SVG and FONT (classname) so this prop is either the name of the icon or the component" }, "textClassName": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "text": { "required": false, "tsType": { "name": "string" }, "description": "" } } } ], "src/components/AvatarGroup/AvatarGroupCounterTooltipHelper.tsx": [ { "description": "", "methods": [], "displayName": "avatarRenderer", "props": { "value": { "required": true, "tsType": { "name": "intersection", "raw": "AvatarProps & { tooltipContent: ElementContent }", "elements": [ { "name": "AvatarProps" }, { "name": "signature", "type": "object", "raw": "{ tooltipContent: ElementContent }", "signature": { "properties": [ { "key": "tooltipContent", "value": { "name": "ElementContent", "required": true } } ] } } ] }, "description": "" } } } ], "src/components/AvatarGroup/AvatarGroup.tsx": [ { "description": "", "methods": [], "displayName": "AvatarGroup", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "avatarClassName": { "required": false, "tsType": { "name": "string" }, "description": "" }, "children": { "required": false, "tsType": { "name": "union", "raw": "ReactElement | ReactElement[]", "elements": [ { "name": "ReactElement", "elements": [ { "name": "AvatarProps" } ], "raw": "ReactElement" }, { "name": "Array", "elements": [ { "name": "ReactElement", "elements": [ { "name": "AvatarProps" } ], "raw": "ReactElement" } ], "raw": "ReactElement[]" } ] }, "description": "Array of `Avatar` components" }, "size": { "required": false, "tsType": { "name": "AvatarSize" }, "description": "" }, "type": { "required": false, "tsType": { "name": "AvatarType" }, "description": "" }, "max": { "required": false, "tsType": { "name": "number" }, "description": "", "defaultValue": { "value": "5", "computed": false } }, "counterProps": { "required": false, "tsType": { "name": "signature", "type": "object", "raw": "{\n color?: CounterColor.LIGHT | CounterColor.DARK;\n count?: number;\n prefix?: string;\n maxDigits?: number;\n ariaLabelItemsName?: string;\n noAnimation?: boolean;\n}", "signature": { "properties": [ { "key": "color", "value": { "name": "union", "raw": "CounterColor.LIGHT | CounterColor.DARK", "elements": [ { "name": "CounterColor.LIGHT" }, { "name": "CounterColor.DARK" } ], "required": false } }, { "key": "count", "value": { "name": "number", "required": false } }, { "key": "prefix", "value": { "name": "string", "required": false } }, { "key": "maxDigits", "value": { "name": "number", "required": false } }, { "key": "ariaLabelItemsName", "value": { "name": "string", "required": false } }, { "key": "noAnimation", "value": { "name": "boolean", "required": false } } ] } }, "description": "4 `Counter.props` for customization + ariaLabelItemsName for specifying the \"items\" name in aria label" }, "counterTooltipCustomProps": { "required": false, "tsType": { "name": "intersection", "raw": "TooltipBaseProps & (TooltipWithChildrenProps | TooltipWithoutChildrenProps)", "elements": [ { "name": "TooltipBaseProps" }, { "name": "unknown" } ] }, "description": "`Tooltip.props`: props for custom counter tooltip" }, "counterTooltipIsVirtualizedList": { "required": false, "tsType": { "name": "boolean" }, "description": "Using counter default tooltip virtualized list for rendering only visible items (performance optimization)", "defaultValue": { "value": "false", "computed": false } }, "removePadding": { "required": false, "tsType": { "name": "boolean" }, "description": "If true, padding will be removed from the container", "defaultValue": { "value": "false", "computed": false } } } } ], "src/components/AvatarGroup/AvatarGroupCounterTooltipContentVirtualizedList.tsx": [ { "description": "", "methods": [], "displayName": "AvatarGroupCounterTooltipContentVirtualizedList", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "avatarItems": { "required": false, "tsType": { "name": "Array", "elements": [ { "name": "signature", "type": "object", "raw": "{\n value: AvatarProps & { tooltipContent: ElementContent };\n}", "signature": { "properties": [ { "key": "value", "value": { "name": "intersection", "raw": "AvatarProps & { tooltipContent: ElementContent }", "elements": [ { "name": "AvatarProps" }, { "name": "signature", "type": "object", "raw": "{ tooltipContent: ElementContent }", "signature": { "properties": [ { "key": "tooltipContent", "value": { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ], "required": true } } ] } } ], "required": true } } ] } } ], "raw": "AvatarItem[]" }, "description": "Array of Avatar components", "defaultValue": { "value": "[]", "computed": false } }, "avatarRenderer": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(\n item: AvatarItem,\n index: number,\n style: CSSProperties,\n type: AvatarType,\n displayAsGrid: boolean\n) => ReactElement", "signature": { "arguments": [ { "type": { "name": "signature", "type": "object", "raw": "{\n value: AvatarProps & { tooltipContent: ElementContent };\n}", "signature": { "properties": [ { "key": "value", "value": { "name": "intersection", "raw": "AvatarProps & { tooltipContent: ElementContent }", "elements": [ { "name": "AvatarProps" }, { "name": "signature", "type": "object", "raw": "{ tooltipContent: ElementContent }", "signature": { "properties": [ { "key": "tooltipContent", "value": { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ], "required": true } } ] } } ], "required": true } } ] } }, "name": "item" }, { "type": { "name": "number" }, "name": "index" }, { "type": { "name": "CSSProperties" }, "name": "style" }, { "type": { "name": "AvatarType" }, "name": "type" }, { "type": { "name": "boolean" }, "name": "displayAsGrid" } ], "return": { "name": "ReactElement" } } }, "description": "" }, "tooltipContainerAriaLabel": { "required": false, "tsType": { "name": "string" }, "description": "" }, "tooltipContentContainerRef": { "required": false, "tsType": { "name": "Ref", "elements": [ { "name": "HTMLDivElement" } ], "raw": "Ref" }, "description": "" }, "type": { "required": false, "tsType": { "name": "AvatarType" }, "description": "" } } } ], "src/components/Badge/Badge.tsx": [ { "description": "", "methods": [], "displayName": "Badge", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "anchor": { "required": false, "tsType": { "name": "BadgeAnchor" }, "description": "", "defaultValue": { "value": "Badge.anchors.TOP_END", "computed": true } }, "alignment": { "required": false, "tsType": { "name": "BadgeAlignments" }, "description": "", "defaultValue": { "value": "Badge.alignments.RECTANGULAR", "computed": true } }, "children": { "required": true, "tsType": { "name": "ReactReactNode", "raw": "React.ReactNode" }, "description": "" }, "type": { "defaultValue": { "value": "Badge.types.INDICATOR", "computed": true }, "required": false } } } ], "src/components/AvatarGroup/AvatarGroupCounterTooltipContainer.tsx": [ { "description": "", "methods": [], "displayName": "AvatarGroupCounterTooltipContainer", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "type": { "required": false, "tsType": { "name": "AvatarType" }, "description": "" }, "children": { "required": false, "tsType": { "name": "Array", "elements": [ { "name": "ReactElement" } ], "raw": "ReactElement[]" }, "description": "Counter element & focus placeholders", "defaultValue": { "value": "[]", "computed": false } }, "avatars": { "required": false, "tsType": { "name": "Array", "elements": [ { "name": "ReactElement", "elements": [ { "name": "AvatarProps" } ], "raw": "ReactElement" } ], "raw": "ReactElement[]" }, "description": "Array of Avatar elements", "defaultValue": { "value": "[]", "computed": false } }, "counterTooltipCustomProps": { "required": false, "tsType": { "name": "intersection", "raw": "TooltipBaseProps & (TooltipWithChildrenProps | TooltipWithoutChildrenProps)", "elements": [ { "name": "TooltipBaseProps" }, { "name": "unknown" } ] }, "description": "" }, "counterTooltipIsVirtualizedList": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "focusPrevPlaceholderRef": { "required": false, "tsType": { "name": "RefObject", "elements": [ { "name": "HTMLDivElement" } ], "raw": "RefObject" }, "description": "" }, "focusNextPlaceholderRef": { "required": false, "tsType": { "name": "RefObject", "elements": [ { "name": "HTMLDivElement" } ], "raw": "RefObject" }, "description": "" }, "counterContainerRef": { "required": false, "tsType": { "name": "RefObject", "elements": [ { "name": "HTMLDivElement" } ], "raw": "RefObject" }, "description": "" } } } ], "src/components/AvatarGroup/AvatarGroupCounter.tsx": [ { "description": "", "methods": [], "displayName": "AvatarGroupCounter", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "counterTooltipAvatars": { "required": false, "tsType": { "name": "Array", "elements": [ { "name": "ReactElement", "elements": [ { "name": "AvatarProps" } ], "raw": "ReactElement" } ], "raw": "ReactElement[]" }, "description": "Array of Avatar elements", "defaultValue": { "value": "[]", "computed": false } }, "counterProps": { "required": false, "tsType": { "name": "signature", "type": "object", "raw": "{\n color?: CounterColor.LIGHT | CounterColor.DARK;\n count?: number;\n prefix?: string;\n maxDigits?: number;\n ariaLabelItemsName?: string;\n noAnimation?: boolean;\n}", "signature": { "properties": [ { "key": "color", "value": { "name": "union", "raw": "CounterColor.LIGHT | CounterColor.DARK", "elements": [ { "name": "CounterColor.LIGHT" }, { "name": "CounterColor.DARK" } ], "required": false } }, { "key": "count", "value": { "name": "number", "required": false } }, { "key": "prefix", "value": { "name": "string", "required": false } }, { "key": "maxDigits", "value": { "name": "number", "required": false } }, { "key": "ariaLabelItemsName", "value": { "name": "string", "required": false } }, { "key": "noAnimation", "value": { "name": "boolean", "required": false } } ] } }, "description": "AvatarGroupCounterVisualProps: props for counter" }, "counterTooltipCustomProps": { "required": false, "tsType": { "name": "intersection", "raw": "TooltipBaseProps & (TooltipWithChildrenProps | TooltipWithoutChildrenProps)", "elements": [ { "name": "TooltipBaseProps" }, { "name": "unknown" } ] }, "description": "" }, "counterTooltipIsVirtualizedList": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "size": { "required": false, "tsType": { "name": "AvatarSize" }, "description": "", "defaultValue": { "value": "Avatar.sizes.MEDIUM", "computed": true } }, "type": { "required": false, "tsType": { "name": "AvatarType" }, "description": "" }, "counterAriaLabel": { "required": false, "tsType": { "name": "string" }, "description": "" } } } ], "src/components/AvatarGroup/AvatarGroupCounterTooltipContent.tsx": [ { "description": "", "methods": [], "displayName": "AvatarGroupCounterTooltipContent", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "type": { "required": false, "tsType": { "name": "AvatarType" }, "description": "" }, "avatars": { "required": false, "tsType": { "name": "Array", "elements": [ { "name": "ReactElement", "elements": [ { "name": "AvatarProps" } ], "raw": "ReactElement" } ], "raw": "ReactElement[]" }, "description": "Array of Avatar components", "defaultValue": { "value": "[]", "computed": false } }, "isVirtualizedList": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "tooltipContentContainerRef": { "required": false, "tsType": { "name": "Ref", "elements": [ { "name": "HTMLDivElement" } ], "raw": "Ref" }, "description": "" } } } ], "src/components/BreadcrumbsBar/BreadcrumbsBar.tsx": [ { "description": "", "methods": [], "displayName": "BreadcrumbsBar", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "type": { "required": false, "tsType": { "name": "BreadcrumbsBarType" }, "description": "The type of the bar is responsible for whether it will be navigational or for indication only", "defaultValue": { "value": "BreadcrumbsBar.types.INDICATION", "computed": true } }, "children": { "required": true, "tsType": { "name": "union", "raw": "ReactElement | ReactElement[]", "elements": [ { "name": "ReactElement", "elements": [ { "name": "BreadcrumbItemProps" } ], "raw": "ReactElement" }, { "name": "Array", "elements": [ { "name": "ReactElement", "elements": [ { "name": "BreadcrumbItemProps" } ], "raw": "ReactElement" } ], "raw": "ReactElement[]" } ] }, "description": "" } } } ], "src/components/Box/Box.tsx": [ { "description": "", "methods": [], "displayName": "Box", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "elementType": { "required": false, "tsType": { "name": "union", "raw": "keyof JSX.IntrinsicElements | string", "elements": [ { "name": "JSX.IntrinsicElements" }, { "name": "string" } ] }, "description": "", "defaultValue": { "value": "\"div\"", "computed": false } }, "children": { "required": false, "tsType": { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ] }, "description": "" }, "disabled": { "required": false, "tsType": { "name": "boolean" }, "description": "" }, "border": { "required": false, "tsType": { "name": "BORDER[BORDER]", "raw": "T[keyof T]" }, "description": "" }, "borderColor": { "required": false, "tsType": { "name": "BORDER_COLOR[BORDER_COLOR]", "raw": "T[keyof T]" }, "description": "" }, "rounded": { "required": false, "tsType": { "name": "ROUNDED[ROUNDED]", "raw": "T[keyof T]" }, "description": "" }, "shadow": { "required": false, "tsType": { "name": "SHADOW[SHADOW]", "raw": "T[keyof T]" }, "description": "" }, "margin": { "required": false, "tsType": { "name": "MARGIN[MARGIN]", "raw": "T[keyof T]" }, "description": "" }, "marginX": { "required": false, "tsType": { "name": "MARGIN_X[MARGIN_X]", "raw": "T[keyof T]" }, "description": "" }, "marginY": { "required": false, "tsType": { "name": "MARGIN_Y[MARGIN_Y]", "raw": "T[keyof T]" }, "description": "" }, "marginTop": { "required": false, "tsType": { "name": "MARGIN_TOP[MARGIN_TOP]", "raw": "T[keyof T]" }, "description": "" }, "marginEnd": { "required": false, "tsType": { "name": "MARGIN_END[MARGIN_END]", "raw": "T[keyof T]" }, "description": "" }, "marginBottom": { "required": false, "tsType": { "name": "MARGIN_BOTTOM[MARGIN_BOTTOM]", "raw": "T[keyof T]" }, "description": "" }, "marginStart": { "required": false, "tsType": { "name": "MARGIN_START[MARGIN_START]", "raw": "T[keyof T]" }, "description": "" }, "padding": { "required": false, "tsType": { "name": "PADDING[PADDING]", "raw": "T[keyof T]" }, "description": "" }, "paddingX": { "required": false, "tsType": { "name": "PADDING_X[PADDING_X]", "raw": "T[keyof T]" }, "description": "" }, "paddingY": { "required": false, "tsType": { "name": "PADDING_Y[PADDING_Y]", "raw": "T[keyof T]" }, "description": "" }, "paddingTop": { "required": false, "tsType": { "name": "PADDING_TOP[PADDING_TOP]", "raw": "T[keyof T]" }, "description": "" }, "paddingEnd": { "required": false, "tsType": { "name": "PADDING_END[PADDING_END]", "raw": "T[keyof T]" }, "description": "" }, "paddingBottom": { "required": false, "tsType": { "name": "PADDING_BOTTOM[PADDING_BOTTOM]", "raw": "T[keyof T]" }, "description": "" }, "paddingStart": { "required": false, "tsType": { "name": "PADDING_START[PADDING_START]", "raw": "T[keyof T]" }, "description": "" }, "backgroundColor": { "required": false, "tsType": { "name": "BACKGROUND_COLORS[BACKGROUND_COLORS]", "raw": "T[keyof T]" }, "description": "" }, "textColor": { "required": false, "tsType": { "name": "COLORS[COLORS]", "raw": "T[keyof T]" }, "description": "" }, "scrollable": { "required": false, "tsType": { "name": "boolean" }, "description": "TODO: make default in next major version" } } } ], "src/components/Button/Button.tsx": [ { "description": "", "methods": [], "displayName": "Button", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "Custom class names to pass to the component", "defaultValue": { "value": "undefined", "computed": true } }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "id to pass to the button", "defaultValue": { "value": "undefined", "computed": true } }, "children": { "required": false, "tsType": { "name": "ReactReactNode", "raw": "React.ReactNode" }, "description": "" }, "activeButtonClassName": { "required": false, "tsType": { "name": "string" }, "description": "" }, "kind": { "required": false, "tsType": { "name": "ButtonType" }, "description": "The button's kind", "defaultValue": { "value": "ButtonType.PRIMARY", "computed": true } }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "elements": [ { "name": "HTMLButtonElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "Callback function to run when the button is clicked", "defaultValue": { "value": "function NOOP() {}", "computed": false } }, "onMouseDown": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "elements": [ { "name": "HTMLButtonElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "", "defaultValue": { "value": "function NOOP() {}", "computed": false } }, "blurOnMouseUp": { "required": false, "tsType": { "name": "boolean" }, "description": "Blur on button click", "defaultValue": { "value": "true", "computed": false } }, "name": { "required": false, "tsType": { "name": "string" }, "description": "Name of the button - for form submit usages", "defaultValue": { "value": "undefined", "computed": true } }, "size": { "required": false, "tsType": { "name": "union", "raw": "(typeof SIZES)[keyof typeof SIZES] | keyof typeof OLD_BUTTON_SIZES", "elements": [ { "name": "unknown[union]", "raw": "(typeof SIZES)[keyof typeof SIZES]" }, { "name": "union", "raw": "keyof typeof OLD_BUTTON_SIZES", "elements": [ { "name": "literal", "value": "sm" }, { "name": "literal", "value": "md" }, { "name": "literal", "value": "lg" } ] } ] }, "description": "The button's size", "defaultValue": { "value": "SIZES.MEDIUM", "computed": true } }, "color": { "required": false, "tsType": { "name": "ButtonColor" }, "description": "The button's color", "defaultValue": { "value": "ButtonColor.PRIMARY", "computed": true } }, "type": { "required": false, "tsType": { "name": "ButtonInputType" }, "description": "The button's type", "defaultValue": { "value": "ButtonInputType.BUTTON", "computed": true } }, "disabled": { "required": false, "tsType": { "name": "boolean" }, "description": "Whether the button should be disabled or not", "defaultValue": { "value": "false", "computed": false } }, "rightIcon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Icon to place on the right", "defaultValue": { "value": "null", "computed": false } }, "leftIcon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Icon to place on the left", "defaultValue": { "value": "null", "computed": false } }, "success": { "required": false, "tsType": { "name": "boolean" }, "description": "the success props are used when you have async action and wants to display a success message", "defaultValue": { "value": "false", "computed": false } }, "successIcon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Success icon name", "defaultValue": { "value": "null", "computed": false } }, "successText": { "required": false, "tsType": { "name": "string" }, "description": "Success text", "defaultValue": { "value": "\"\"", "computed": false } }, "loading": { "required": false, "tsType": { "name": "boolean" }, "description": "loading boolean which switches the text to a loader", "defaultValue": { "value": "false", "computed": false } }, "style": { "required": false, "tsType": { "name": "ReactCSSProperties", "raw": "React.CSSProperties" }, "description": "", "defaultValue": { "value": "undefined", "computed": true } }, "active": { "required": false, "tsType": { "name": "boolean" }, "description": "displays the active state", "defaultValue": { "value": "false", "computed": false } }, "marginRight": { "required": false, "tsType": { "name": "boolean" }, "description": "adds 8px margin to the right", "defaultValue": { "value": "false", "computed": false } }, "marginLeft": { "required": false, "tsType": { "name": "boolean" }, "description": "adds 8px margin to the left", "defaultValue": { "value": "false", "computed": false } }, "ariaLabeledBy": { "required": false, "tsType": { "name": "string" }, "description": "element id to describe the button accordingly", "defaultValue": { "value": "undefined", "computed": true } }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "aria label to provide important when providing only Icon", "defaultValue": { "value": "undefined", "computed": true } }, "ariaHasPopup": { "required": false, "tsType": { "name": "ReactHTMLProps[\"aria-haspopup\"]", "raw": "React.HTMLProps[\"aria-haspopup\"]" }, "description": "aria for a button popup", "defaultValue": { "value": "undefined", "computed": true } }, "ariaExpanded": { "required": false, "tsType": { "name": "boolean" }, "description": "aria to be set if the popup is open", "defaultValue": { "value": "undefined", "computed": true } }, "ariaControls": { "required": false, "tsType": { "name": "string" }, "description": "aria controls - receives id for the controlled region", "defaultValue": { "value": "undefined", "computed": true } }, "aria-describedby": { "required": false, "tsType": { "name": "AriaAttributes[\"aria-describedby\"]", "raw": "AriaAttributes[\"aria-describedby\"]" }, "description": "" }, "aria-hidden": { "required": false, "tsType": { "name": "AriaAttributes[\"aria-hidden\"]", "raw": "AriaAttributes[\"aria-hidden\"]" }, "description": "aria to be used for screen reader to know if the button is hidden" }, "onFocus": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.FocusEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactFocusEvent", "raw": "React.FocusEvent", "elements": [ { "name": "HTMLButtonElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "On Button Focus callback", "defaultValue": { "value": "function NOOP() {}", "computed": false } }, "onBlur": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.FocusEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactFocusEvent", "raw": "React.FocusEvent", "elements": [ { "name": "HTMLButtonElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "On Button Blur callback", "defaultValue": { "value": "function NOOP() {}", "computed": false } }, "rightFlat": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "leftFlat": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "preventClickAnimation": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "noSidePadding": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "defaultTextColorOnPrimaryColor": { "required": false, "tsType": { "name": "string" }, "description": "default color for text color in ON_PRIMARY_COLOR kind (should be any type of css color (rbg, var, hex...)", "defaultValue": { "value": "\"rgba(0, 0, 0, 0)\"", "computed": false } }, "dataTestId": { "required": false, "tsType": { "name": "string" }, "description": "@deprecated - use \"data-testid\" instead", "defaultValue": { "value": "undefined", "computed": true } }, "insetFocus": { "required": false, "tsType": { "name": "boolean" }, "description": "Change the focus indicator from around the button to within it", "defaultValue": { "value": "false", "computed": false } }, "tabIndex": { "required": false, "tsType": { "name": "number" }, "description": "Specifies the tab order of an element" } } } ], "src/components/ButtonGroup/ButtonWrapper.tsx": [ { "description": "", "methods": [], "displayName": "ButtonWrapper", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "Custom class names to pass to the component" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "id to pass to the button" }, "children": { "required": false, "tsType": { "name": "ReactReactNode", "raw": "React.ReactNode" }, "description": "" }, "activeButtonClassName": { "required": false, "tsType": { "name": "string" }, "description": "" }, "kind": { "required": false, "tsType": { "name": "ButtonType" }, "description": "The button's kind" }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "elements": [ { "name": "HTMLButtonElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "Callback function to run when the button is clicked" }, "onMouseDown": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "elements": [ { "name": "HTMLButtonElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "" }, "blurOnMouseUp": { "required": false, "tsType": { "name": "boolean" }, "description": "Blur on button click" }, "name": { "required": false, "tsType": { "name": "string" }, "description": "Name of the button - for form submit usages" }, "size": { "required": false, "tsType": { "name": "union", "raw": "(typeof SIZES)[keyof typeof SIZES] | keyof typeof OLD_BUTTON_SIZES", "elements": [ { "name": "unknown[union]", "raw": "(typeof SIZES)[keyof typeof SIZES]" }, { "name": "union", "raw": "keyof typeof OLD_BUTTON_SIZES", "elements": [ { "name": "literal", "value": "sm" }, { "name": "literal", "value": "md" }, { "name": "literal", "value": "lg" } ] } ] }, "description": "The button's size" }, "color": { "required": false, "tsType": { "name": "ButtonColor" }, "description": "The button's color" }, "type": { "required": false, "tsType": { "name": "ButtonInputType" }, "description": "The button's type" }, "disabled": { "required": false, "tsType": { "name": "boolean" }, "description": "Whether the button should be disabled or not" }, "rightIcon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Icon to place on the right" }, "leftIcon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Icon to place on the left" }, "success": { "required": false, "tsType": { "name": "boolean" }, "description": "the success props are used when you have async action and wants to display a success message" }, "successIcon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Success icon name" }, "successText": { "required": false, "tsType": { "name": "string" }, "description": "Success text" }, "loading": { "required": false, "tsType": { "name": "boolean" }, "description": "loading boolean which switches the text to a loader" }, "style": { "required": false, "tsType": { "name": "ReactCSSProperties", "raw": "React.CSSProperties" }, "description": "" }, "active": { "required": false, "tsType": { "name": "boolean" }, "description": "displays the active state" }, "marginRight": { "required": false, "tsType": { "name": "boolean" }, "description": "adds 8px margin to the right" }, "marginLeft": { "required": false, "tsType": { "name": "boolean" }, "description": "adds 8px margin to the left" }, "ariaLabeledBy": { "required": false, "tsType": { "name": "string" }, "description": "element id to describe the button accordingly" }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "aria label to provide important when providing only Icon" }, "ariaHasPopup": { "required": false, "tsType": { "name": "ReactHTMLProps[\"aria-haspopup\"]", "raw": "React.HTMLProps[\"aria-haspopup\"]" }, "description": "aria for a button popup" }, "ariaExpanded": { "required": false, "tsType": { "name": "boolean" }, "description": "aria to be set if the popup is open" }, "ariaControls": { "required": false, "tsType": { "name": "string" }, "description": "aria controls - receives id for the controlled region" }, "aria-describedby": { "required": false, "tsType": { "name": "AriaAttributes[\"aria-describedby\"]", "raw": "AriaAttributes[\"aria-describedby\"]" }, "description": "" }, "aria-hidden": { "required": false, "tsType": { "name": "AriaAttributes[\"aria-hidden\"]", "raw": "AriaAttributes[\"aria-hidden\"]" }, "description": "aria to be used for screen reader to know if the button is hidden" }, "onFocus": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.FocusEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactFocusEvent", "raw": "React.FocusEvent", "elements": [ { "name": "HTMLButtonElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "On Button Focus callback" }, "onBlur": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.FocusEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactFocusEvent", "raw": "React.FocusEvent", "elements": [ { "name": "HTMLButtonElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "On Button Blur callback" }, "rightFlat": { "required": false, "tsType": { "name": "boolean" }, "description": "" }, "leftFlat": { "required": false, "tsType": { "name": "boolean" }, "description": "" }, "preventClickAnimation": { "required": false, "tsType": { "name": "boolean" }, "description": "" }, "noSidePadding": { "required": false, "tsType": { "name": "boolean" }, "description": "" }, "defaultTextColorOnPrimaryColor": { "required": false, "tsType": { "name": "string" }, "description": "default color for text color in ON_PRIMARY_COLOR kind (should be any type of css color (rbg, var, hex...)" }, "dataTestId": { "required": false, "tsType": { "name": "string" }, "description": "@deprecated - use \"data-testid\" instead" }, "insetFocus": { "required": false, "tsType": { "name": "boolean" }, "description": "Change the focus indicator from around the button to within it" }, "tabIndex": { "required": false, "tsType": { "name": "number" }, "description": "Specifies the tab order of an element" }, "tooltipContent": { "required": false, "tsType": { "name": "string" }, "description": "" }, "tooltipPosition": { "required": false, "tsType": { "name": "DialogPosition" }, "description": "Where the tooltip should be in reference to the children: Top, Left, Right, Bottom ..." }, "tooltipHideDelay": { "required": false, "tsType": { "name": "number" }, "description": "" }, "tooltipShowDelay": { "required": false, "tsType": { "name": "number" }, "description": "" }, "tooltipContainerSelector": { "required": false, "tsType": { "name": "string" }, "description": "" }, "tooltipMoveBy": { "required": false, "tsType": { "name": "signature", "type": "object", "raw": "{\n main?: number;\n secondary?: number;\n}", "signature": { "properties": [ { "key": "main", "value": { "name": "number", "required": false } }, { "key": "secondary", "value": { "name": "number", "required": false } } ] } }, "description": "" } } } ], "src/components/Chips/Chips.tsx": [ { "description": "", "methods": [], "displayName": "Chips", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "label": { "required": false, "tsType": { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ] }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "disabled": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "readOnly": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "dataTestId": { "required": false, "tsType": { "name": "string" }, "description": "@deprecated - use \"data-testid\" instead" }, "rightRenderer": { "required": false, "tsType": { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ] }, "description": "A React element that is positioned to the right of the text" }, "leftRenderer": { "required": false, "tsType": { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ] }, "description": "A React element that is positioned to the left of the text" }, "rightIcon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Icon to place on the right", "defaultValue": { "value": "null", "computed": false } }, "leftIcon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Icon to place on the left", "defaultValue": { "value": "null", "computed": false } }, "rightAvatar": { "required": false, "tsType": { "name": "string" }, "description": "Img to place as avatar on the right", "defaultValue": { "value": "null", "computed": false } }, "rightAvatarType": { "required": false, "tsType": { "name": "AvatarType" }, "description": "the type of right avatar", "defaultValue": { "value": "AvatarType.IMG", "computed": true } }, "leftAvatar": { "required": false, "tsType": { "name": "string" }, "description": "Img to place as avatar on the left", "defaultValue": { "value": "null", "computed": false } }, "leftAvatarType": { "required": false, "tsType": { "name": "AvatarType" }, "description": "the type of left avatar", "defaultValue": { "value": "AvatarType.IMG", "computed": true } }, "iconClassName": { "required": false, "tsType": { "name": "string" }, "description": "ClassName for left or right icon" }, "avatarClassName": { "required": false, "tsType": { "name": "string" }, "description": "ClassName for left or right avatar" }, "color": { "required": false, "tsType": { "name": "union", "raw": "(typeof ElementAllowedColor)[keyof typeof ElementAllowedColor] | string", "elements": [ { "name": "unknown[unknown]", "raw": "(typeof ElementAllowedColor)[keyof typeof ElementAllowedColor]" }, { "name": "string" } ] }, "description": "", "defaultValue": { "value": "Chips.colors.PRIMARY", "computed": true } }, "iconSize": { "required": false, "tsType": { "name": "union", "raw": "number | string", "elements": [ { "name": "number" }, { "name": "string" } ] }, "description": "Size for font icon", "defaultValue": { "value": "18", "computed": false } }, "onDelete": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(id: string, event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "id" }, { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "elements": [ { "name": "HTMLSpanElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "", "defaultValue": { "value": "(_id: string, _e: React.MouseEvent) => {}", "computed": false } }, "noAnimation": { "required": false, "tsType": { "name": "boolean" }, "description": "Disables the Chip's entry animation", "defaultValue": { "value": "true", "computed": false } }, "allowTextSelection": { "required": false, "tsType": { "name": "boolean" }, "description": "Allow user to select text", "defaultValue": { "value": "false", "computed": false } }, "onMouseDown": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "elements": [ { "name": "HTMLDivElement" }, { "name": "MouseEvent" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "Callback function to be called when the user clicks the component." }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "elements": [ { "name": "HTMLDivElement" }, { "name": "MouseEvent" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "Callback function to be called when the user clicks the component." }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "Applies when element has onClick or onMouseDown props" }, "clickable": { "required": false, "tsType": { "name": "boolean" }, "description": "Deprecated, there is no need to use this prop for implementing clickable chips. Please use onClick for this purpose.\n@deprecated" }, "isClickable": { "required": false, "tsType": { "name": "boolean" }, "description": "Deprecated, there is no need to use this prop for implementing clickable chips. Please use onClick for this purpose.\n@deprecated" }, "disableClickableBehavior": { "required": false, "tsType": { "name": "boolean" }, "description": "Disable click behaviors", "defaultValue": { "value": "false", "computed": false } }, "showBorder": { "required": false, "tsType": { "name": "boolean" }, "description": "Show border, the border color is `--text-color-on-primary`, should be when the chip is a colored background like\nselected-color", "defaultValue": { "value": "false", "computed": false } }, "closeButtonAriaLabel": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"Remove\"", "computed": false } } } } ], "src/components/Checkbox/Checkbox.tsx": [ { "description": "", "methods": [], "displayName": "Checkbox", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "A classname to be added to the wrapping element" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "An id to be added the input element" }, "componentClassName": { "required": false, "tsType": { "name": "string" }, "description": "@deprecated - use className instead" }, "checkboxClassName": { "required": false, "tsType": { "name": "string" }, "description": "A classname to be added to the checkbox element label" }, "labelClassName": { "required": false, "tsType": { "name": "string" }, "description": "A classname to be added to the label element" }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "A11y prop to describe the content for screen readers" }, "label": { "required": false, "tsType": { "name": "union", "raw": "React.ReactNode | Array", "elements": [ { "name": "ReactReactNode", "raw": "React.ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactReactNode", "raw": "React.ReactNode" } ], "raw": "Array" } ] }, "description": "The content to be rendered within the option" }, "ariaLabelledBy": { "required": false, "tsType": { "name": "string" }, "description": "A11y prop - An Id of an element which describes this option" }, "onChange": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.ChangeEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactChangeEvent", "raw": "React.ChangeEvent", "elements": [ { "name": "HTMLInputElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "callback function when the value changes", "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false } }, "checked": { "required": false, "tsType": { "name": "boolean" }, "description": "Use this when you want to control the component, this will set the state of the component" }, "indeterminate": { "required": false, "tsType": { "name": "boolean" }, "description": "An in between state to display a non selected", "defaultValue": { "value": "false", "computed": false } }, "disabled": { "required": false, "tsType": { "name": "boolean" }, "description": "Set the option to be disabled", "defaultValue": { "value": "false", "computed": false } }, "defaultChecked": { "required": false, "tsType": { "name": "boolean" }, "description": "the default value which the checkbox will start from" }, "value": { "required": false, "tsType": { "name": "string" }, "description": "The input control's value. When specified in the HTML, this is the initial value, and from then on it can be altered or retrieved at any time using JavaScript to access the respective HTMLInputElement object's value property. The value attribute is always optional, though should be considered mandatory for checkbox, radio, and hidden.l", "defaultValue": { "value": "\"\"", "computed": false } }, "name": { "required": false, "tsType": { "name": "string" }, "description": "A string specifying a name for the input control. This name is submitted along with the control's value when the form data is submitted.", "defaultValue": { "value": "\"\"", "computed": false } }, "tabIndex": { "required": false, "tsType": { "name": "number" }, "description": "Specifies the tab order of the input element" } } } ], "src/components/Clickable/ClickableWrapper.tsx": [ { "description": "", "methods": [], "displayName": "ClickableWrapper", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "children": { "required": true, "tsType": { "name": "ReactReactNode", "raw": "React.ReactNode" }, "description": "" }, "isClickable": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "true", "computed": false } }, "clickableProps": { "required": false, "tsType": { "name": "ClickableProps" }, "description": "", "defaultValue": { "value": "{}", "computed": false } } } } ], "src/components/Counter/Counter.tsx": [ { "description": "", "methods": [], "displayName": "Counter", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "Custom class names to pass to the component wrapper" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "id to pass to the element", "defaultValue": { "value": "\"\"", "computed": false } }, "ariaLabeledBy": { "required": false, "tsType": { "name": "string" }, "description": "element id to describe the counter accordingly", "defaultValue": { "value": "\"\"", "computed": false } }, "wrapperClassName": { "required": false, "tsType": { "name": "string" }, "description": "Use className instead\n@deprecated" }, "counterClassName": { "required": false, "tsType": { "name": "string" }, "description": "Custom class names to pass to the component" }, "count": { "required": false, "tsType": { "name": "number" }, "description": "The numeric value of the counter", "defaultValue": { "value": "0", "computed": false } }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "Counter description", "defaultValue": { "value": "\"\"", "computed": false } }, "size": { "required": false, "tsType": { "name": "CounterSize" }, "description": "The size of the counter", "defaultValue": { "value": "Counter.sizes.LARGE", "computed": true } }, "kind": { "required": false, "tsType": { "name": "CounterType" }, "description": "", "defaultValue": { "value": "Counter.kinds.FILL", "computed": true } }, "color": { "required": false, "tsType": { "name": "CounterColor" }, "description": "The color of the counter", "defaultValue": { "value": "Counter.colors.PRIMARY", "computed": true } }, "maxDigits": { "required": false, "tsType": { "name": "number" }, "description": "maximum number of digits to display (see relevant story)", "defaultValue": { "value": "3", "computed": false } }, "prefix": { "required": false, "tsType": { "name": "string" }, "description": "Text prepended to counter value", "defaultValue": { "value": "\"\"", "computed": false } }, "onMouseDown": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "elements": [ { "name": "HTMLSpanElement" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "Callback to be called when the counter is clicked.", "defaultValue": { "value": "function NOOP() {}", "computed": false } }, "noAnimation": { "required": false, "tsType": { "name": "boolean" }, "description": "Disables the component's animation", "defaultValue": { "value": "false", "computed": false } } } } ], "src/components/Combobox/Combobox.tsx": [ { "description": "", "methods": [], "displayName": "Combobox", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "Unique element id", "defaultValue": { "value": "\"\"", "computed": false } }, "optionClassName": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "searchWrapperClassName": { "required": false, "tsType": { "name": "string" }, "description": "" }, "placeholder": { "required": false, "tsType": { "name": "string" }, "description": "Placeholder to show when no value was selected", "defaultValue": { "value": "\"\"", "computed": false } }, "noResultsMessage": { "required": false, "tsType": { "name": "string" }, "description": "A message that will be displayed inside the combo box when no results are found", "defaultValue": { "value": "\"No results found\"", "computed": false } }, "disabled": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "options": { "required": false, "tsType": { "name": "Array", "elements": [ { "name": "IComboboxOption" } ], "raw": "IComboboxOption[]" }, "description": "", "defaultValue": { "value": "[]", "computed": false } }, "categories": { "required": false, "tsType": { "name": "IComboboxCategoryMap" }, "description": "" }, "withCategoriesDivider": { "required": false, "tsType": { "name": "boolean" }, "description": "Divider between categories sections", "defaultValue": { "value": "false", "computed": false } }, "size": { "required": false, "tsType": { "name": "unknown[union]", "raw": "(typeof BASE_SIZES)[keyof typeof BASE_SIZES]" }, "description": "", "defaultValue": { "value": "Combobox.sizes.MEDIUM", "computed": true } }, "optionLineHeight": { "required": false, "tsType": { "name": "number" }, "description": "", "defaultValue": { "value": "32", "computed": false } }, "optionsListHeight": { "required": false, "tsType": { "name": "number" }, "description": "" }, "autoFocus": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "onAddNew": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" } ], "return": { "name": "void" } } }, "description": "Callback that called after clicking on the add new combo box button.\n@param {string} _filterValue" }, "addNewLabel": { "required": false, "tsType": { "name": "union", "raw": "((label: string) => ElementContent) | string", "elements": [ { "name": "unknown" }, { "name": "string" } ] }, "description": "The label of the button that appears at the end of the combo box when the search does not return appropriate options", "defaultValue": { "value": "\"Add new\"", "computed": false } }, "filter": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(filterValue: string, options: IComboboxOption[]) => IComboboxOption[]", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "filterValue" }, { "type": { "name": "Array", "elements": [ { "name": "IComboboxOption" } ], "raw": "IComboboxOption[]" }, "name": "options" } ], "return": { "name": "Array", "elements": [ { "name": "IComboboxOption" } ], "raw": "IComboboxOption[]" } } }, "description": "", "defaultValue": { "value": "(filterValue: string, options: IComboboxOption[]) =>\noptions.filter(\n ({ label }: { label: string }) => !filterValue || label.toLowerCase().includes(filterValue.toLowerCase())\n)", "computed": false } }, "defaultFilter": { "required": false, "tsType": { "name": "string" }, "description": "Default search input", "defaultValue": { "value": "\"\"", "computed": false } }, "disableFilter": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "onFilterChanged": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" } ], "return": { "name": "void" } } }, "description": "" }, "loading": { "required": false, "tsType": { "name": "boolean" }, "description": "Display the combo box with loading state", "defaultValue": { "value": "false", "computed": false } }, "onOptionHover": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent, index: number, option: IComboboxOption) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" }, { "type": { "name": "number" }, "name": "index" }, { "type": { "name": "IComboboxOption" }, "name": "option" } ], "return": { "name": "void" } } }, "description": "on mouse hover callback for option", "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false } }, "onOptionLeave": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "() => void", "signature": { "arguments": [], "return": { "name": "void" } } }, "description": "on mouse leave callback for option", "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false } }, "shouldScrollToSelectedItem": { "required": false, "tsType": { "name": "boolean" }, "description": "Allowed to the following behavior: scrolling automatically to the combo box's selected option", "defaultValue": { "value": "true", "computed": false } }, "noResultsRenderer": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "() => JSX.Element", "signature": { "arguments": [], "return": { "name": "JSX.Element" } } }, "description": "" }, "stickyCategories": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "defaultVisualFocusFirstIndex": { "required": false, "tsType": { "name": "boolean" }, "description": "By default, the first option will be selected, when focusing selecting the first option, or when changing items" }, "clearFilterOnSelection": { "required": false, "tsType": { "name": "boolean" }, "description": "Clear the filter/search on selection (click or enter)", "defaultValue": { "value": "false", "computed": false } }, "optionRenderer": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(option: IComboboxOption) => JSX.Element", "signature": { "arguments": [ { "type": { "name": "IComboboxOption" }, "name": "option" } ], "return": { "name": "JSX.Element" } } }, "description": "Replace the regular appearance of combo box option with custom renderer.", "defaultValue": { "value": "null", "computed": false } }, "maxOptionsWithoutScroll": { "required": false, "tsType": { "name": "number" }, "description": "Maximum options count without scroll" }, "renderOnlyVisibleOptions": { "required": false, "tsType": { "name": "boolean" }, "description": "Using virtualized list for rendering only the items which visible to the user in any given user (performance optimization)", "defaultValue": { "value": "false", "computed": false } }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(optionData: IComboboxOption) => void", "signature": { "arguments": [ { "type": { "name": "IComboboxOption" }, "name": "optionData" } ], "return": { "name": "void" } } }, "description": "On option click callback", "defaultValue": { "value": "(_optionData: IComboboxOption) => {}", "computed": false } }, "searchIcon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Custom search icon" }, "searchInputAriaLabel": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"Search for content\"", "computed": false } } } } ], "src/components/DatePicker/DatePicker.tsx": [ { "description": "", "methods": [], "displayName": "DatePicker", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "firstDayOfWeek": { "required": false, "tsType": { "name": "DayOfWeekShape" }, "description": "set the first day of the week to display", "defaultValue": { "value": "1", "computed": false } }, "date": { "required": false, "tsType": { "name": "moment.Moment" }, "description": "current start date" }, "endDate": { "required": false, "tsType": { "name": "moment.Moment" }, "description": "current end date" }, "onPickDate": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(date: Moment | RangeDate) => void", "signature": { "arguments": [ { "type": { "name": "union", "raw": "Moment | RangeDate", "elements": [ { "name": "moment.Moment" }, { "name": "RangeDate" } ] }, "name": "date" } ], "return": { "name": "void" } } }, "description": "on date selected callback" }, "hideNavigationKeys": { "required": false, "tsType": { "name": "boolean" }, "description": "hide the month navigations keys", "defaultValue": { "value": "false", "computed": false } }, "enableOutsideDays": { "required": false, "tsType": { "name": "boolean" }, "description": "show days outside the cuurent month view", "defaultValue": { "value": "false", "computed": false } }, "showWeekNumber": { "required": false, "tsType": { "name": "boolean" }, "description": "show week number column", "defaultValue": { "value": "false", "computed": false } }, "daySize": { "required": false, "tsType": { "name": "number" }, "description": "set the size of single day element", "defaultValue": { "value": "40", "computed": false } }, "shouldBlockDay": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(date: Moment) => boolean", "signature": { "arguments": [ { "type": { "name": "moment.Moment" }, "name": "date" } ], "return": { "name": "boolean" } } }, "description": "determine if day should be disabled" }, "range": { "required": false, "tsType": { "name": "boolean" }, "description": "date range mode", "defaultValue": { "value": "false", "computed": false } }, "numberOfMonths": { "required": false, "tsType": { "name": "number" }, "description": "number of month to display", "defaultValue": { "value": "1", "computed": false } }, "shouldBlockYear": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(year: number) => boolean", "signature": { "arguments": [ { "type": { "name": "number" }, "name": "year" } ], "return": { "name": "boolean" } } }, "description": "determine if year should be disabled" }, "shouldBlockRange": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(date: Moment) => boolean", "signature": { "arguments": [ { "type": { "name": "moment.Moment" }, "name": "date" } ], "return": { "name": "boolean" } } }, "description": "determine if date range should be disabled" } } } ], "src/components/Dialog/Dialog.tsx": [ { "description": "", "methods": [ { "name": "closeDialogOnEscape", "docblock": null, "modifiers": [], "params": [ { "name": "event", "optional": false, "type": { "name": "KeyboardEvent", "alias": "KeyboardEvent" } } ], "returns": null }, { "name": "getContainer", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "showDialog", "docblock": null, "modifiers": [], "params": [ { "name": "options", "optional": true, "type": null } ], "returns": null }, { "name": "onShowDialog", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "showDialogIfNeeded", "docblock": null, "modifiers": [], "params": [ { "name": "options", "optional": true, "type": null } ], "returns": null }, { "name": "hideDialog", "docblock": null, "modifiers": [], "params": [ { "name": "event", "optional": false, "type": { "name": "union", "raw": "React.MouseEvent | React.KeyboardEvent | KeyboardEvent | React.FocusEvent | CustomEvent", "elements": [ { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, { "name": "KeyboardEvent" }, { "name": "ReactFocusEvent", "raw": "React.FocusEvent" }, { "name": "CustomEvent" } ], "alias": "DialogEvent" } }, { "name": "eventName", "optional": false, "type": { "name": "union", "raw": "HideShowEvent | string", "elements": [ { "name": "HideShowEvent" }, { "name": "string" } ] } } ], "returns": null }, { "name": "onHideDialog", "docblock": null, "modifiers": [], "params": [ { "name": "event", "optional": false, "type": { "name": "union", "raw": "React.MouseEvent | React.KeyboardEvent | KeyboardEvent | React.FocusEvent | CustomEvent", "elements": [ { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, { "name": "KeyboardEvent" }, { "name": "ReactFocusEvent", "raw": "React.FocusEvent" }, { "name": "CustomEvent" } ], "alias": "DialogEvent" } }, { "name": "eventName", "optional": false, "type": { "name": "union", "raw": "HideShowEvent | string", "elements": [ { "name": "HideShowEvent" }, { "name": "string" } ] } } ], "returns": null }, { "name": "hideDialogIfNeeded", "docblock": null, "modifiers": [], "params": [ { "name": "event", "optional": false, "type": { "name": "union", "raw": "React.MouseEvent | React.KeyboardEvent | KeyboardEvent | React.FocusEvent | CustomEvent", "elements": [ { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, { "name": "KeyboardEvent" }, { "name": "ReactFocusEvent", "raw": "React.FocusEvent" }, { "name": "CustomEvent" } ], "alias": "DialogEvent" } }, { "name": "eventName", "optional": false, "type": { "name": "union", "raw": "HideShowEvent | string", "elements": [ { "name": "HideShowEvent" }, { "name": "string" } ] } } ], "returns": null }, { "name": "handleEvent", "docblock": null, "modifiers": [], "params": [ { "name": "eventName", "optional": false, "type": { "name": "HideShowEvent", "alias": "HideShowEvent" } }, { "name": "target", "optional": false, "type": { "name": "EventTarget", "alias": "EventTarget" } }, { "name": "event", "optional": false, "type": { "name": "union", "raw": "React.MouseEvent | React.KeyboardEvent | KeyboardEvent | React.FocusEvent | CustomEvent", "elements": [ { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, { "name": "KeyboardEvent" }, { "name": "ReactFocusEvent", "raw": "React.FocusEvent" }, { "name": "CustomEvent" } ], "alias": "DialogEvent" } } ], "returns": null }, { "name": "isShown", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "isShowTrigger", "docblock": null, "modifiers": [], "params": [ { "name": "eventName", "optional": false, "type": { "name": "HideShowEvent", "alias": "HideShowEvent" } } ], "returns": null }, { "name": "isHideTrigger", "docblock": null, "modifiers": [], "params": [ { "name": "eventName", "optional": false, "type": { "name": "HideShowEvent", "alias": "HideShowEvent" } } ], "returns": null }, { "name": "onMouseEnter", "docblock": null, "modifiers": [], "params": [ { "name": "e", "optional": false, "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "alias": "React.MouseEvent" } } ], "returns": null }, { "name": "onMouseLeave", "docblock": null, "modifiers": [], "params": [ { "name": "e", "optional": false, "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "alias": "React.MouseEvent" } } ], "returns": null }, { "name": "onClick", "docblock": null, "modifiers": [], "params": [ { "name": "e", "optional": false, "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "alias": "React.MouseEvent" } } ], "returns": null }, { "name": "onKeyDown", "docblock": null, "modifiers": [], "params": [ { "name": "event", "optional": false, "type": { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent", "alias": "React.KeyboardEvent" } } ], "returns": null }, { "name": "onMouseDown", "docblock": null, "modifiers": [], "params": [ { "name": "e", "optional": false, "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "alias": "React.MouseEvent" } } ], "returns": null }, { "name": "onFocus", "docblock": null, "modifiers": [], "params": [ { "name": "e", "optional": false, "type": { "name": "ReactFocusEvent", "raw": "React.FocusEvent", "alias": "React.FocusEvent" } } ], "returns": null }, { "name": "onBlur", "docblock": null, "modifiers": [], "params": [ { "name": "e", "optional": false, "type": { "name": "ReactFocusEvent", "raw": "React.FocusEvent", "alias": "React.FocusEvent" } } ], "returns": null }, { "name": "onEsc", "docblock": null, "modifiers": [], "params": [ { "name": "e", "optional": false, "type": { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent", "alias": "React.KeyboardEvent" } } ], "returns": null }, { "name": "onContextMenu", "docblock": null, "modifiers": [], "params": [ { "name": "e", "optional": false, "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "alias": "React.MouseEvent" } } ], "returns": null }, { "name": "onClickOutside", "docblock": null, "modifiers": [], "params": [ { "name": "event", "optional": false, "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "alias": "React.MouseEvent" } } ], "returns": null }, { "name": "onDialogEnter", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onDialogLeave", "docblock": null, "modifiers": [], "params": [ { "name": "event", "optional": false, "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "alias": "React.MouseEvent" } } ], "returns": null }, { "name": "onContentClick", "docblock": null, "modifiers": [], "params": [ { "name": "e", "optional": false, "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "alias": "React.MouseEvent" } } ], "returns": null } ], "displayName": "Dialog", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "referenceWrapperClassName": { "required": false, "tsType": { "name": "string" }, "description": "A Classname to be added to element which wraps the children" }, "position": { "required": false, "tsType": { "name": "DialogPosition" }, "description": "Where the dialog should be in reference to the children,\nTop, Left, Right, Bottom ...", "defaultValue": { "value": "\"top\"", "computed": false } }, "modifiers": { "required": false, "tsType": { "name": "Array", "elements": [ { "name": "Modifier", "elements": [ { "name": "any" } ], "raw": "Modifier" } ], "raw": "Modifier[]" }, "description": "PopperJS Modifiers type\nhttps://popper.js.org/docs/v2/modifiers/", "defaultValue": { "value": "[]", "computed": false } }, "startingEdge": { "required": false, "tsType": { "name": "string" }, "description": "" }, "moveBy": { "required": false, "tsType": { "name": "signature", "type": "object", "raw": "{ main?: number; secondary?: number }", "signature": { "properties": [ { "key": "main", "value": { "name": "number", "required": false } }, { "key": "secondary", "value": { "name": "number", "required": false } } ] } }, "description": "How much to move the dialog in relative to children\nmain is the axis in which the position is aligned to\nsecondary is the vertical axes to the position", "defaultValue": { "value": "{ main: 0, secondary: 0 }", "computed": false } }, "showDelay": { "required": false, "tsType": { "name": "number" }, "description": "how much delay should the Dialog wait until it should trigger the show in MS", "defaultValue": { "value": "100", "computed": false } }, "hideDelay": { "required": false, "tsType": { "name": "number" }, "description": "how much delay should the Dialog wait until it should trigger the hide in MS", "defaultValue": { "value": "100", "computed": false } }, "showTrigger": { "required": false, "tsType": { "name": "union", "raw": "HideShowEvent | HideShowEvent[]", "elements": [ { "name": "HideShowEvent" }, { "name": "Array", "elements": [ { "name": "HideShowEvent" } ], "raw": "HideShowEvent[]" } ] }, "description": "an array of hide/show trigger -\nDialog.hideShowTriggers", "defaultValue": { "value": "Dialog.hideShowTriggers.MOUSE_ENTER", "computed": true } }, "hideTrigger": { "required": false, "tsType": { "name": "union", "raw": "HideShowEvent | HideShowEvent[]", "elements": [ { "name": "HideShowEvent" }, { "name": "Array", "elements": [ { "name": "HideShowEvent" } ], "raw": "HideShowEvent[]" } ] }, "description": "an array of hide/show trigger -\nDialog.hideShowTriggers", "defaultValue": { "value": "Dialog.hideShowTriggers.MOUSE_LEAVE", "computed": true } }, "showOnDialogEnter": { "required": false, "tsType": { "name": "boolean" }, "description": "If true, prevents open Dialog from closing on mouseEnter and closes Dialog, when mouse leaves it", "defaultValue": { "value": "false", "computed": false } }, "shouldShowOnMount": { "required": false, "tsType": { "name": "boolean" }, "description": "Show the Dialog when the children are mounting", "defaultValue": { "value": "false", "computed": false } }, "disable": { "required": false, "tsType": { "name": "boolean" }, "description": "disable the opening of the dialog", "defaultValue": { "value": "false", "computed": false } }, "open": { "required": false, "tsType": { "name": "boolean" }, "description": "open is a controlled prop to open the dialog", "defaultValue": { "value": "false", "computed": false } }, "isOpen": { "required": false, "tsType": { "name": "boolean" }, "description": "used when state is derived from props" }, "showTriggerIgnoreClass": { "required": false, "tsType": { "name": "union", "raw": "string | Array", "elements": [ { "name": "string" }, { "name": "Array", "elements": [ { "name": "string" } ], "raw": "Array" } ] }, "description": "if this class exists on the children the show trigger will be ignored" }, "hideTriggerIgnoreClass": { "required": false, "tsType": { "name": "union", "raw": "string | Array", "elements": [ { "name": "string" }, { "name": "Array", "elements": [ { "name": "string" } ], "raw": "Array" } ] }, "description": "if this class exists on the children the hide trigger will be ignored" }, "animationType": { "required": false, "tsType": { "name": "AnimationType" }, "description": "Dialog animation type", "defaultValue": { "value": "Dialog.animationTypes.EXPAND", "computed": true } }, "wrapperClassName": { "required": false, "tsType": { "name": "string" }, "description": "Classname to be added to the content container" }, "preventAnimationOnMount": { "required": false, "tsType": { "name": "boolean" }, "description": "Prevent Animation", "defaultValue": { "value": "false", "computed": false } }, "containerSelector": { "required": false, "tsType": { "name": "string" }, "description": "the container selector in which to append the dialog\nfor examples: \"body\" , \".my-class\", \"#my-id\"", "defaultValue": { "value": "\"body\"", "computed": false } }, "tooltip": { "required": false, "tsType": { "name": "boolean" }, "description": "should position the tooltip element\nhttps://popper.js.org/docs/v2/modifiers/arrow/", "defaultValue": { "value": "false", "computed": false } }, "tooltipClassName": { "required": false, "tsType": { "name": "string" }, "description": "class name to add to the tooltip element" }, "onDialogDidShow": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "() => void", "signature": { "arguments": [], "return": { "name": "void" } } }, "description": "callback to be called when the dialog is shown", "defaultValue": { "value": "function NOOP() {}", "computed": false } }, "onDialogDidHide": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: DialogEvent, eventName: HideShowEvent | string) => void", "signature": { "arguments": [ { "type": { "name": "union", "raw": "React.MouseEvent | React.KeyboardEvent | KeyboardEvent | React.FocusEvent | CustomEvent", "elements": [ { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, { "name": "KeyboardEvent" }, { "name": "ReactFocusEvent", "raw": "React.FocusEvent" }, { "name": "CustomEvent" } ] }, "name": "event" }, { "type": { "name": "union", "raw": "HideShowEvent | string", "elements": [ { "name": "HideShowEvent" }, { "name": "string" } ] }, "name": "eventName" } ], "return": { "name": "void" } } }, "description": "callback to be called when the dialog is hidden", "defaultValue": { "value": "function NOOP() {}", "computed": false } }, "onClickOutside": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "callback to be called when click outside is being triggered", "defaultValue": { "value": "function NOOP() {}", "computed": false } }, "onContentClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "callback to be called when click on the content is being triggered", "defaultValue": { "value": "function NOOP() {}", "computed": false } }, "zIndex": { "required": false, "tsType": { "name": "number" }, "description": "z-index to add to the dialog" }, "useDerivedStateFromProps": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "hideWhenReferenceHidden": { "required": false, "tsType": { "name": "boolean" }, "description": "Make the dialog disappear when the element it is attached to becomes hidden", "defaultValue": { "value": "false", "computed": false } }, "shoudlCallbackOnMount": { "required": false, "tsType": { "name": "boolean" }, "description": "@deprecated - use shouldCallbackOnMount instead", "defaultValue": { "value": "false", "computed": false } }, "shouldCallbackOnMount": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "instantShowAndHide": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "getDynamicShowDelay": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "() => { showDelay: number; preventAnimation: boolean }", "signature": { "arguments": [], "return": { "name": "signature", "type": "object", "raw": "{ showDelay: number; preventAnimation: boolean }", "signature": { "properties": [ { "key": "showDelay", "value": { "name": "number", "required": true } }, { "key": "preventAnimation", "value": { "name": "boolean", "required": true } } ] } } } }, "description": "" }, "content": { "required": false, "tsType": { "name": "union", "raw": "(() => JSX.Element) | JSX.Element", "elements": [ { "name": "unknown" }, { "name": "JSX.Element" } ] }, "description": "" }, "children": { "required": false, "tsType": { "name": "union", "raw": "ReactElement | ReactElement[] | string", "elements": [ { "name": "ReactElement" }, { "name": "Array", "elements": [ { "name": "ReactElement" } ], "raw": "ReactElement[]" }, { "name": "string" } ] }, "description": "The element where we will position the dialog beside." }, "addKeyboardHideShowTriggersByDefault": { "required": false, "tsType": { "name": "boolean" }, "description": "Treats keyboard focus/blur events as mouse-enter/mouse-leave events", "defaultValue": { "value": "false", "computed": false } }, "disableContainerScroll": { "required": false, "tsType": { "name": "union", "raw": "boolean | string", "elements": [ { "name": "boolean" }, { "name": "string" } ] }, "description": "If true disable the scroll for the containerSelector element.\nIf string use it as selector to prevent scroll." } } } ], "src/components/Dropdown/Dropdown.jsx": [ { "description": "", "methods": [], "displayName": "Dropdown", "props": { "multi": { "defaultValue": { "value": "false", "computed": false }, "description": "If set to true, the dropdown will be in multi-select mode.\nWhen in multi-select mode, the selected value will be an array,\nand it will be displayed as our [``](/?path=/docs/components-chips--sandbox) component.", "type": { "name": "bool" }, "required": false }, "multiline": { "defaultValue": { "value": "false", "computed": false }, "description": "If set to true together with `multi`, it will make the dropdown expand to multiple lines when new values are selected.", "type": { "name": "bool" }, "required": false }, "closeMenuOnSelect": { "defaultValue": { "value": "undefined", "computed": true }, "description": "Pass closeMenuOnSelect to close the multi choose any time an options is chosen.", "type": { "name": "bool" }, "required": false }, "tabSelectsValue": { "defaultValue": { "value": "true", "computed": false }, "description": "Overrides the built-in logic of tab selecting value (default: true)", "type": { "name": "bool" }, "required": false }, "className": { "defaultValue": { "value": "\"\"", "computed": false }, "description": "Custom style", "type": { "name": "string" }, "required": false }, "optionWrapperClassName": { "defaultValue": { "value": "undefined", "computed": true }, "description": "ClassName to be added to dropdown option wrapper (dropdown-wrapper__option--reset)", "type": { "name": "string" }, "required": false }, "dropdownMenuWrapperClassName": { "defaultValue": { "value": "undefined", "computed": true }, "description": "ClassName to be added to dropdown menu wrapper (dropdown-menu-wrapper)", "type": { "name": "string" }, "required": false }, "singleValueWrapperClassName": { "defaultValue": { "value": "undefined", "computed": true }, "description": "ClassName to be added to dropdown single value wrapper (dropdown-wrapper__single-value--reset)", "type": { "name": "string" }, "required": false }, "placeholder": { "defaultValue": { "value": "\"\"", "computed": false }, "description": "Placeholder to show when no value was selected", "type": { "name": "string" }, "required": false }, "onMenuOpen": { "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false }, "description": "Called when menu is opened", "type": { "name": "func" }, "required": false }, "onMenuClose": { "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false }, "description": "Called when menu is closed", "type": { "name": "func" }, "required": false }, "onKeyDown": { "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false }, "description": "Called when key is pressed in the dropdown", "type": { "name": "func" }, "required": false }, "onFocus": { "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false }, "description": "Called when focused", "type": { "name": "func" }, "required": false }, "onBlur": { "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false }, "description": "Called when blurred", "type": { "name": "func" }, "required": false }, "onChange": { "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false }, "description": "Called when selected value has changed", "type": { "name": "func" }, "required": false }, "onInputChange": { "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false }, "description": "Called when the dropdown's input changes.", "type": { "name": "func" }, "required": false }, "searchable": { "defaultValue": { "value": "true", "computed": false }, "description": "If true, search in options will be enabled", "type": { "name": "bool" }, "required": false }, "options": { "defaultValue": { "value": "[]", "computed": false }, "description": "The dropdown options", "type": { "name": "arrayOf", "value": { "name": "object" } }, "required": false }, "menuPlacement": { "defaultValue": { "value": "Dropdown.menuPlacements.BOTTOM", "computed": true }, "description": "Default placement of the Dropdown menu in relation to its control. Use \"auto\" to flip the menu when there isn't enough space below the control.", "type": { "name": "enum", "value": [ { "value": "\"top\"", "computed": false }, { "value": "\"bottom\"", "computed": false }, { "value": "\"auto\"", "computed": false } ] }, "required": false }, "menuPosition": { "defaultValue": { "value": "Dropdown.menuPositions.ABSOLUTE", "computed": true }, "description": "The CSS position value of the menu, when \"fixed\" extra layout management might be required\nFixed position can be used to solve the issue of positioning Dropdown inside overflow container like Modal or Dialog", "type": { "name": "enum", "value": [ { "value": "\"absolute\"", "computed": false }, { "value": "\"fixed\"", "computed": false } ] }, "required": false }, "noOptionsMessage": { "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false }, "description": "Text to display when there are no options", "type": { "name": "func" }, "required": false }, "clearable": { "defaultValue": { "value": "true", "computed": false }, "description": "If set to true, clear button will be added", "type": { "name": "bool" }, "required": false }, "size": { "defaultValue": { "value": "SIZES.MEDIUM", "computed": true }, "description": "Select menu size from `Dropdown.size` - Dropdown.sizes.LARGE | Dropdown.sizes.MEDIUM | Dropdown.sizes.SMALL", "type": { "name": "string" }, "required": false }, "extraStyles": { "defaultValue": { "value": "baseStyles => baseStyles", "computed": false }, "description": "Custom function to override existing styles (similar to `react-select`'s `style` prop), for example: `base => ({...base, color: 'red'})`, where `base` is the component's default styles", "type": { "name": "func" }, "required": false }, "tabIndex": { "defaultValue": { "value": "\"0\"", "computed": false }, "description": "Tab index for keyboard navigation purposes", "type": { "name": "union", "value": [ { "name": "string" }, { "name": "number" } ] }, "required": false }, "onOptionRemove": { "defaultValue": { "value": "undefined", "computed": true }, "description": "callback to be called when `multiline` is `true` and the option is removed", "type": { "name": "func" }, "required": false }, "id": { "defaultValue": { "value": "\"dropdown-menu-id\"", "computed": false }, "description": "ID for the select container", "type": { "name": "string" }, "required": false }, "autoFocus": { "defaultValue": { "value": "false", "computed": false }, "description": "focusAuto when component mount", "type": { "name": "bool" }, "required": false }, "closeMenuOnScroll": { "defaultValue": { "value": "false", "computed": false }, "description": "If menu should be closed on scroll - helpful for some tricky use cases\n@default false, but true when insideOverflowContainer or insideOverflowWithTransformContainer are true", "type": { "name": "bool" }, "required": false }, "ref": { "defaultValue": { "value": "undefined", "computed": true }, "description": "Pass Ref for reference of the actual dropdown component", "type": { "name": "func" }, "required": false }, "withMandatoryDefaultOptions": { "defaultValue": { "value": "false", "computed": false }, "description": "The options set by default will be set as mandatory and the user will not be able to cancel their selection", "type": { "name": "bool" }, "required": false }, "insideOverflowContainer": { "defaultValue": { "value": "false", "computed": false }, "description": "For display the drop down menu in overflow hidden/scroll container.", "type": { "name": "bool" }, "required": false }, "insideOverflowWithTransformContainer": { "defaultValue": { "value": "false", "computed": false }, "description": "For display the drop down menu in overflow hidden/scroll container which contains transform css function usage.", "type": { "name": "bool" }, "required": false }, "tooltipContent": { "defaultValue": { "value": "\"\"", "computed": false }, "description": "When content is passed, the dropdown will include a tooltip on the dropdown's value.", "type": { "name": "string" }, "required": false }, "disabled": { "defaultValue": { "value": "false", "computed": false }, "description": "If set to true, dropdown will be disabled", "type": { "name": "bool" }, "required": false }, "readOnly": { "defaultValue": { "value": "false", "computed": false }, "description": "If set to true, dropdown won't be editable", "type": { "name": "bool" }, "required": false }, "isLoading": { "defaultValue": { "value": "false", "computed": false }, "description": "Display the drop down with loading state.", "type": { "name": "bool" }, "required": false }, "loadingMessage": { "defaultValue": { "value": "undefined", "computed": true }, "description": "Overrides the built-in logic of loading message design", "type": { "name": "func" }, "required": false }, "ariaLabel": { "defaultValue": { "value": "undefined", "computed": true }, "description": "aria-label attribute for dropdown", "type": { "name": "string" }, "required": false }, "filterOption": { "defaultValue": { "value": "undefined", "computed": true }, "description": "Overrides the build-in search filter logic - https://react-select.com/advanced#custom-filter-logic\ncreateFilter function is available at Dropdown.createFilter", "type": { "name": "union", "value": [ { "name": "func" }, { "name": "object" } ] }, "required": false }, "openMenuOnFocus": { "description": "If set to true, the menu will open when focused", "type": { "name": "bool" }, "required": false }, "openMenuOnClick": { "description": "If set to true, the menu will open when clicked", "type": { "name": "bool" }, "required": false }, "optionRenderer": { "description": "custom option render function", "type": { "name": "union", "value": [ { "name": "func" }, { "name": "object" } ] }, "required": false }, "valueRenderer": { "description": "custom value render function", "type": { "name": "func" }, "required": false }, "menuRenderer": { "description": "custom menu render function", "type": { "name": "func" }, "required": false }, "rtl": { "description": "If set to true, the dropdown will be in Right to Left mode", "type": { "name": "bool" }, "required": false }, "defaultValue": { "description": "Set default selected value", "type": { "name": "union", "value": [ { "name": "arrayOf", "value": { "name": "shape", "value": { "label": { "name": "string", "required": true }, "value": { "name": "string", "required": true } } } }, { "name": "shape", "value": { "label": { "name": "string", "required": true }, "value": { "name": "string", "required": true } } } ] }, "required": false }, "value": { "description": "The component's value.\nWhen passed, makes this a [controlled](https://reactjs.org/docs/forms.html#controlled-components) component.", "type": { "name": "union", "value": [ { "name": "arrayOf", "value": { "name": "shape", "value": { "label": { "name": "string", "required": true }, "value": { "name": "string", "required": true } } } }, { "name": "shape", "value": { "label": { "name": "string", "required": true }, "value": { "name": "string", "required": true } } } ] }, "required": false }, "asyncOptions": { "description": "If provided Dropdown will work in async mode. Can be either promise or callback", "type": { "name": "union", "value": [ { "name": "func" }, { "name": "shape", "value": { "then": { "name": "func", "required": true }, "catch": { "name": "func", "required": true } } } ] }, "required": false }, "cacheOptions": { "description": "If set to true, fetched async options will be cached", "type": { "name": "bool" }, "required": false }, "defaultOptions": { "description": "If set, `asyncOptions` will be invoked with its value on mount and the resolved results will be loaded", "type": { "name": "union", "value": [ { "name": "bool" }, { "name": "arrayOf", "value": { "name": "object" } } ] }, "required": false }, "isVirtualized": { "description": "If set to true, the menu will use virtualization. Virtualized async works only with", "type": { "name": "bool" }, "required": false }, "menuPortalTarget": { "description": "Whether the menu should use a portal, and where it should attach", "type": { "name": "union", "value": [ { "name": "element" }, { "name": "object" } ] }, "required": false }, "maxMenuHeight": { "description": "Maximum height of the menu before scrolling", "type": { "name": "number" }, "required": false }, "isOptionSelected": { "description": "Override the built-in logic to detect whether an option is selected.", "type": { "name": "func" }, "required": false } } } ], "src/components/DialogContentContainer/DialogContentContainer.tsx": [ { "description": "", "methods": [], "displayName": "DialogContentContainer", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "getTestId(ComponentDefaultTestId.DIALOG_CONTENT_CONTAINER, id)", "computed": true } }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "children": { "required": false, "tsType": { "name": "ReactReactNode", "raw": "React.ReactNode" }, "description": "" }, "ariaLabelledby": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "ariaDescribedby": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "type": { "required": false, "tsType": { "name": "DialogType" }, "description": "", "defaultValue": { "value": "DialogType.POPOVER", "computed": true } }, "size": { "required": false, "tsType": { "name": "DialogSize" }, "description": "", "defaultValue": { "value": "DialogSize.MEDIUM", "computed": true } }, "style": { "required": false, "tsType": { "name": "ReactCSSProperties", "raw": "React.CSSProperties" }, "description": "" } } } ], "src/components/Clickable/Clickable.tsx": [ { "description": "", "methods": [], "displayName": "Clickable", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "elementType": { "required": false, "tsType": { "name": "union", "raw": "keyof JSX.IntrinsicElements | string", "elements": [ { "name": "JSX.IntrinsicElements" }, { "name": "string" } ] }, "description": "The type of the clickable element wrapper (for example div or span)", "defaultValue": { "value": "\"div\"", "computed": false } }, "children": { "required": false, "tsType": { "name": "ReactReactNode", "raw": "React.ReactNode" }, "description": "" }, "role": { "required": false, "tsType": { "name": "AriaRole" }, "description": "", "defaultValue": { "value": "\"button\"", "computed": false } }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent | React.KeyboardEvent) => void", "signature": { "arguments": [ { "type": { "name": "union", "raw": "React.MouseEvent | React.KeyboardEvent", "elements": [ { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "", "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false } }, "enableTextSelection": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "onMouseDown": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "", "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false } }, "onMouseEnter": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "", "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false } }, "onMouseLeave": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "", "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false } }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "" }, "ariaHidden": { "required": false, "tsType": { "name": "boolean" }, "description": "Is the element and its content should be hidden from screen readers and other assistive technologies" }, "ariaHasPopup": { "required": false, "tsType": { "name": "union", "raw": "boolean | string", "elements": [ { "name": "boolean" }, { "name": "string" } ] }, "description": "" }, "ariaExpanded": { "required": false, "tsType": { "name": "boolean" }, "description": "" }, "tabIndex": { "required": false, "tsType": { "name": "union", "raw": "string | number", "elements": [ { "name": "string" }, { "name": "number" } ] }, "description": "", "defaultValue": { "value": "\"0\"", "computed": false } }, "disabled": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "style": { "required": false, "tsType": { "name": "ReactCSSProperties", "raw": "React.CSSProperties" }, "description": "" }, "dataTestId": { "required": false, "tsType": { "name": "string" }, "description": "@deprecated - use \"data-testid\" instead" } } } ], "src/components/Divider/Divider.tsx": [ { "description": "", "methods": [], "displayName": "Divider", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "undefined", "computed": true } }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "direction": { "required": false, "tsType": { "name": "DirectionType" }, "description": "", "defaultValue": { "value": "DirectionType.HORIZONTAL", "computed": true } }, "classname": { "required": false, "tsType": { "name": "string" }, "description": "@deprecated - use className instead" }, "withoutMargin": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } } } } ], "src/components/EditableInput/EditableInput.tsx": [ { "description": "", "methods": [], "displayName": "EditableInput", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "value": { "required": false, "tsType": { "name": "string" }, "description": "" }, "placeholder": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "inputType": { "required": false, "tsType": { "name": "InputType" }, "description": "", "defaultValue": { "value": "InputType.INPUT", "computed": true } }, "autoSize": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "autoComplete": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "true", "computed": false } }, "disabled": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "maxLength": { "required": false, "tsType": { "name": "number" }, "description": "" }, "shouldFocusOnMount": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "true", "computed": false } }, "textareaSubmitOnEnter": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "" }, "customColor": { "required": false, "tsType": { "name": "string" }, "description": "" }, "tabIndex": { "required": false, "tsType": { "name": "number" }, "description": "" }, "isValidValue": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string) => boolean", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" } ], "return": { "name": "boolean" } } }, "description": "" }, "onFinishEditing": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string, event: React.KeyboardEvent | React.FocusEvent) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" }, { "type": { "name": "union", "raw": "React.KeyboardEvent | React.FocusEvent", "elements": [ { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, { "name": "ReactFocusEvent", "raw": "React.FocusEvent" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "" }, "onArrowKeyDown": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string, event: React.KeyboardEvent) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" }, { "type": { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "" }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent", "elements": [ { "name": "union", "raw": "HTMLInputElement | HTMLTextAreaElement", "elements": [ { "name": "HTMLInputElement" }, { "name": "HTMLTextAreaElement" } ] } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "" }, "onKeyPress": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "() => void", "signature": { "arguments": [], "return": { "name": "void" } } }, "description": "" }, "selectOnMount": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "() => void", "signature": { "arguments": [], "return": { "name": "void" } } }, "description": "" }, "ignoreBlurClass": { "required": false, "tsType": { "name": "string" }, "description": "" }, "onIgnoreBlurEvent": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" } ], "return": { "name": "void" } } }, "description": "" }, "onFocus": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.FocusEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactFocusEvent", "raw": "React.FocusEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "" }, "onBlur": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.FocusEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactFocusEvent", "raw": "React.FocusEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "" }, "onCancelEditing": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.KeyboardEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "" }, "onChange": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" } ], "return": { "name": "void" } } }, "description": "" }, "onError": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "() => void", "signature": { "arguments": [], "return": { "name": "void" } } }, "description": "" }, "onSuccess": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "() => void", "signature": { "arguments": [], "return": { "name": "void" } } }, "description": "" }, "onKeyDown": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.KeyboardEvent, value: string) => void", "signature": { "arguments": [ { "type": { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, "name": "event" }, { "type": { "name": "string" }, "name": "value" } ], "return": { "name": "void" } } }, "description": "" }, "onTabHandler": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string, event: React.KeyboardEvent) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" }, { "type": { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "" } } } ], "src/components/EditableText/EditableText.tsx": [ { "description": "", "methods": [], "displayName": "EditableText", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "value": { "required": true, "tsType": { "name": "string" }, "description": "Value of the text" }, "onChange": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" } ], "return": { "name": "void" } } }, "description": "Will be called whenever the current value changes to a non-empty value" }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.KeyboardEvent | React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "union", "raw": "React.KeyboardEvent | React.MouseEvent", "elements": [ { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, { "name": "ReactMouseEvent", "raw": "React.MouseEvent" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "Will be called whenever the component gets clicked" }, "readOnly": { "required": false, "tsType": { "name": "boolean" }, "description": "Disables editing mode - component will be just a typography element" }, "placeholder": { "required": false, "tsType": { "name": "string" }, "description": "Shown in edit mode when the text value is empty" }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "ARIA Label" }, "isEditMode": { "required": false, "tsType": { "name": "boolean" }, "description": "Controls the mode of the component (i.e. view/edit mode)" }, "onEditModeChange": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(isEditMode: boolean) => void", "signature": { "arguments": [ { "type": { "name": "boolean" }, "name": "isEditMode" } ], "return": { "name": "void" } } }, "description": "Will be called when the mode of the component changes" }, "tooltipProps": { "required": false, "tsType": { "name": "Partial", "elements": [ { "name": "intersection", "raw": "TooltipBaseProps & (TooltipWithChildrenProps | TooltipWithoutChildrenProps)", "elements": [ { "name": "TooltipBaseProps" }, { "name": "unknown" } ] } ], "raw": "Partial" }, "description": "Override Tooltip props when needed" }, "type": { "required": false, "tsType": { "name": "TextType" }, "description": "Sets the Text type\n@type {TextType}", "defaultValue": { "value": "Text.types.TEXT2", "computed": true } }, "weight": { "required": false, "tsType": { "name": "TextWeight" }, "description": "Sets the Text weight\n@type {TextWeight}", "defaultValue": { "value": "Text.weights.NORMAL", "computed": true } } } } ], "src/components/EditableTypography/EditableTypography.tsx": [ { "description": "", "methods": [], "displayName": "EditableTypography", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "value": { "required": true, "tsType": { "name": "string" }, "description": "Value of the text" }, "onChange": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" } ], "return": { "name": "void" } } }, "description": "Will be called whenever the current value changes to a non-empty value" }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.KeyboardEvent | React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "union", "raw": "React.KeyboardEvent | React.MouseEvent", "elements": [ { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, { "name": "ReactMouseEvent", "raw": "React.MouseEvent" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "Will be called whenever the component gets clicked" }, "readOnly": { "required": false, "tsType": { "name": "boolean" }, "description": "Disables editing mode - component will be just a typography element", "defaultValue": { "value": "false", "computed": false } }, "placeholder": { "required": false, "tsType": { "name": "string" }, "description": "Shown in edit mode when the text value is empty" }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "ARIA Label", "defaultValue": { "value": "\"\"", "computed": false } }, "isEditMode": { "required": false, "tsType": { "name": "boolean" }, "description": "Controls the mode of the component (i.e. view/edit mode)" }, "onEditModeChange": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(isEditMode: boolean) => void", "signature": { "arguments": [ { "type": { "name": "boolean" }, "name": "isEditMode" } ], "return": { "name": "void" } } }, "description": "Will be called when the mode of the component changes" }, "tooltipProps": { "required": false, "tsType": { "name": "Partial", "elements": [ { "name": "intersection", "raw": "TooltipBaseProps & (TooltipWithChildrenProps | TooltipWithoutChildrenProps)", "elements": [ { "name": "TooltipBaseProps" }, { "name": "unknown" } ] } ], "raw": "Partial" }, "description": "Override Tooltip props when needed" }, "component": { "required": true, "tsType": { "name": "ElementType" }, "description": "A typography component that is being rendered in view mode" }, "typographyClassName": { "required": true, "tsType": { "name": "string" }, "description": "Controls the style of the typography component in view mode" }, "clearable": { "required": false, "tsType": { "name": "boolean" }, "description": "Shows placeholder when empty, if provided" } } } ], "src/components/EditableHeading/EditableHeading.tsx": [ { "description": "", "methods": [], "displayName": "EditableHeading", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "value": { "required": true, "tsType": { "name": "string" }, "description": "Value of the text" }, "onChange": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(value: string) => void", "signature": { "arguments": [ { "type": { "name": "string" }, "name": "value" } ], "return": { "name": "void" } } }, "description": "Will be called whenever the current value changes to a non-empty value" }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.KeyboardEvent | React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "union", "raw": "React.KeyboardEvent | React.MouseEvent", "elements": [ { "name": "ReactKeyboardEvent", "raw": "React.KeyboardEvent" }, { "name": "ReactMouseEvent", "raw": "React.MouseEvent" } ] }, "name": "event" } ], "return": { "name": "void" } } }, "description": "Will be called whenever the component gets clicked" }, "readOnly": { "required": false, "tsType": { "name": "boolean" }, "description": "Disables editing mode - component will be just a typography element" }, "placeholder": { "required": false, "tsType": { "name": "string" }, "description": "Shown in edit mode when the text value is empty" }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "ARIA Label" }, "isEditMode": { "required": false, "tsType": { "name": "boolean" }, "description": "Controls the mode of the component (i.e. view/edit mode)" }, "onEditModeChange": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(isEditMode: boolean) => void", "signature": { "arguments": [ { "type": { "name": "boolean" }, "name": "isEditMode" } ], "return": { "name": "void" } } }, "description": "Will be called when the mode of the component changes" }, "tooltipProps": { "required": false, "tsType": { "name": "Partial", "elements": [ { "name": "intersection", "raw": "TooltipBaseProps & (TooltipWithChildrenProps | TooltipWithoutChildrenProps)", "elements": [ { "name": "TooltipBaseProps" }, { "name": "unknown" } ] } ], "raw": "Partial" }, "description": "Override Tooltip props when needed" }, "type": { "required": false, "tsType": { "name": "HeadingType" }, "description": "Sets the Heading type\n@type {HeadingType}", "defaultValue": { "value": "Heading.types.H1", "computed": true } }, "weight": { "required": false, "tsType": { "name": "HeadingWeight" }, "description": "Sets the Heading weight\n@type {HeadingWeight}", "defaultValue": { "value": "Heading.weights.NORMAL", "computed": true } } } } ], "src/components/FieldLabel/FieldLabel.tsx": [ { "description": "", "methods": [], "displayName": "FieldLabel", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "icon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FunctionComponent | null", "elements": [ { "name": "string" }, { "name": "ReactFunctionComponent", "raw": "React.FunctionComponent" }, { "name": "null" } ] }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "iconLabel": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "labelText": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "labelFor": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "iconClassName": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "labelClassName": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "requiredAsterisk": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } } } } ], "src/components/FormattedNumber/FormattedNumber.tsx": [ { "description": "", "methods": [], "displayName": "FormattedNumber", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "value": { "required": false, "tsType": { "name": "union", "raw": "number | string", "elements": [ { "name": "number" }, { "name": "string" } ] }, "description": "A numeric value to format." }, "prefix": { "required": false, "tsType": { "name": "string" }, "description": "If included, will be added as a prefix to the number." }, "suffix": { "required": false, "tsType": { "name": "string" }, "description": "If included, will be added as a suffix to the number." }, "emptyPlaceHolder": { "required": false, "tsType": { "name": "string" }, "description": "The text that will be shown if no value is provided.", "defaultValue": { "value": "\"N/A\"", "computed": false } }, "decimalPrecision": { "required": false, "tsType": { "name": "number" }, "description": "Determines the number of decimal numbers (0 ~ 20).", "defaultValue": { "value": "2", "computed": false } }, "compact": { "required": false, "tsType": { "name": "boolean" }, "description": "Format number into compact number and initial (if required).", "defaultValue": { "value": "true", "computed": false } }, "local": { "required": false, "tsType": { "name": "string" }, "description": "Determines the number's local (Unicode BCP 47 locale identifier).", "defaultValue": { "value": "FormattedNumber.localFallBack", "computed": true } }, "rtl": { "required": false, "tsType": { "name": "boolean" }, "description": "Determines suffix and prefix location" } } } ], "src/components/Icon/Icon.tsx": [ { "description": "", "methods": [], "displayName": "Icon", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "", "defaultValue": { "value": "(_event: React.MouseEvent) => {}", "computed": false } }, "icon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "We support three types of icons - SVG, FONT and SRC (classname) so this prop is either the name of the icon or the component", "defaultValue": { "value": "\"\"", "computed": false } }, "clickable": { "required": false, "tsType": { "name": "boolean" }, "description": "Is icon is a button", "defaultValue": { "value": "true", "computed": false } }, "iconLabel": { "required": false, "tsType": { "name": "string" }, "description": "mo * Icon aria label [aria label](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label)" }, "iconType": { "required": false, "tsType": { "name": "IconType" }, "description": "The type of the component - svg, font or custom svg (using [`react-inlinesvg`](https://github.com/gilbarbara/react-inlinesvg#readme))", "defaultValue": { "value": "IconType.SVG", "computed": true } }, "iconSize": { "required": false, "tsType": { "name": "union", "raw": "number | string", "elements": [ { "name": "number" }, { "name": "string" } ] }, "description": "Size for font icon", "defaultValue": { "value": "16", "computed": false } }, "ignoreFocusStyle": { "required": false, "tsType": { "name": "boolean" }, "description": "Remove focus style", "defaultValue": { "value": "false", "computed": false } }, "tabindex": { "required": false, "tsType": { "name": "union", "raw": "number | string", "elements": [ { "name": "number" }, { "name": "string" } ] }, "description": "" }, "ariaHidden": { "required": false, "tsType": { "name": "boolean" }, "description": "Hide icon asset from screen reader. No need to set value for this prop when `clickable` is false" }, "style": { "required": false, "tsType": { "name": "ReactCSSProperties", "raw": "React.CSSProperties" }, "description": "" }, "useCurrentColor": { "required": false, "tsType": { "name": "boolean" }, "description": "When using svg from src (Icon.type.SRC) this boolean will transform the \"fill\" property to \"currentColor\"", "defaultValue": { "value": "false", "computed": false } }, "customColor": { "required": false, "tsType": { "name": "string" }, "description": "Override the default color with a custom one" } } } ], "src/components/ExpandCollapse/ExpandCollapse.tsx": [ { "description": "", "methods": [], "displayName": "ExpandCollapse", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "", "defaultValue": { "value": "\"\"", "computed": false } }, "headerComponentRenderer": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "() => ReactElement", "signature": { "arguments": [], "return": { "name": "ReactElement" } } }, "description": "Component as parameter to be rendered as header", "defaultValue": { "value": "null", "computed": false } }, "headerClassName": { "required": false, "tsType": { "name": "string" }, "description": "Class name to add to the header of the expandable" }, "contentClassName": { "required": false, "tsType": { "name": "string" }, "description": "Class name to add to the content of the expandable" }, "componentClassName": { "required": false, "tsType": { "name": "string" }, "description": "Class name to add to the component" }, "title": { "required": false, "tsType": { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ] }, "description": "Header title", "defaultValue": { "value": "\"\"", "computed": false } }, "children": { "required": false, "tsType": { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ] }, "description": "The value of the expandable section" }, "iconSize": { "required": false, "tsType": { "name": "union", "raw": "number | string", "elements": [ { "name": "number" }, { "name": "string" } ] }, "description": "The expand icon font size", "defaultValue": { "value": "24", "computed": false } }, "defaultOpenState": { "required": false, "tsType": { "name": "boolean" }, "description": "Should be open or closed by default (when rendered)", "defaultValue": { "value": "false", "computed": false } }, "open": { "required": false, "tsType": { "name": "boolean" }, "description": "" }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "", "defaultValue": { "value": "null", "computed": false } }, "hideBorder": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } } } } ], "src/components/Flex/Flex.tsx": [ { "description": "", "methods": [], "displayName": "Flex", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "" }, "style": { "required": false, "tsType": { "name": "object" }, "description": "" }, "direction": { "required": false, "tsType": { "name": "FlexDirection" }, "description": "", "defaultValue": { "value": "Flex.directions.ROW", "computed": true } }, "elementType": { "required": false, "tsType": { "name": "ReactElementType", "raw": "React.ElementType" }, "description": "", "defaultValue": { "value": "\"div\"", "computed": false } }, "wrap": { "required": false, "tsType": { "name": "boolean" }, "description": "", "defaultValue": { "value": "false", "computed": false } }, "children": { "required": false, "tsType": { "name": "union", "raw": "ElementContent | ElementContent[]", "elements": [ { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ] }, { "name": "Array", "elements": [ { "name": "union", "raw": "ReactNode | ReactNode[]", "elements": [ { "name": "ReactNode" }, { "name": "Array", "elements": [ { "name": "ReactNode" } ], "raw": "ReactNode[]" } ] } ], "raw": "ElementContent[]" } ] }, "description": "" }, "justify": { "required": false, "tsType": { "name": "FlexJustify" }, "description": "", "defaultValue": { "value": "Flex.justify.START", "computed": true } }, "align": { "required": false, "tsType": { "name": "FlexAlign" }, "description": "", "defaultValue": { "value": "Flex.align.CENTER", "computed": true } }, "gap": { "required": false, "tsType": { "name": "union", "raw": "FlexGap | number", "elements": [ { "name": "FlexGap" }, { "name": "number" } ] }, "description": "", "defaultValue": { "value": "Flex.gaps.NONE", "computed": true } }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "" }, "tabIndex": { "required": false, "tsType": { "name": "number" }, "description": "" }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "onClick function - MouseEvent" }, "ariaLabelledby": { "required": false, "tsType": { "name": "string" }, "description": "element id to describe the counter accordingly" } } } ], "src/components/HiddenText/HiddenText.tsx": [ { "description": "", "methods": [], "displayName": "HiddenText", "props": { "className": { "defaultValue": { "value": "\"\"", "computed": false }, "required": false }, "id": { "defaultValue": { "value": "\"hiddenText\"", "computed": false }, "required": false } } } ], "src/components/IconButton/IconButton.tsx": [ { "description": "", "methods": [], "displayName": "IconButton", "props": { "className": { "required": false, "tsType": { "name": "string" }, "description": "" }, "data-testid": { "required": false, "tsType": { "name": "string" }, "description": "" }, "id": { "required": false, "tsType": { "name": "string" }, "description": "id to be added to the element" }, "onClick": { "required": false, "tsType": { "name": "signature", "type": "function", "raw": "(event: React.MouseEvent) => void", "signature": { "arguments": [ { "type": { "name": "ReactMouseEvent", "raw": "React.MouseEvent" }, "name": "event" } ], "return": { "name": "void" } } }, "description": "callback function when clicking the icon button", "defaultValue": { "value": "function noop() {\n // No operation performed.\n}", "computed": false } }, "wrapperClassName": { "required": false, "tsType": { "name": "string" }, "description": "the class name of the button wrapper" }, "iconClassName": { "required": false, "tsType": { "name": "string" }, "description": "the class name of the button icon" }, "icon": { "required": false, "tsType": { "name": "union", "raw": "string | React.FC | null", "elements": [ { "name": "string" }, { "name": "ReactFC", "raw": "React.FC", "elements": [ { "name": "IconSubComponentProps" } ] }, { "name": "null" } ] }, "description": "Icon to be rendered", "defaultValue": { "value": "({size, ...props}) => (\n \n \n \n)", "computed": false } }, "ariaLabel": { "required": false, "tsType": { "name": "string" }, "description": "a11y property to be added, used for screen reader to know what kind of button it is" }, "ariaExpanded": { "required": false, "tsType": { "name": "boolean" }, "description": "a11y property to be added, used for screen reader to know if the button is expanded" }, "aria-hidden": { "required": false, "tsType": { "name": "AriaAttributes[\"aria-hidden\"]", "raw": "AriaAttributes[\"aria-hidden\"]" }, "description": "a11y property to be added, used for screen reader to know if the button is hidden" }, "size": { "required": false, "tsType": { "name": "unknown[union]", "raw": "(typeof SIZES)[keyof typeof SIZES]" }, "description": "Size of the icon", "defaultValue": { "value": "IconButton.sizes.MEDIUM", "computed": true } }, "hideTooltip": { "required": false, "tsType": { "name": "boolean" }, "description": "Whether the tooltip should be displayed or not", "defaultValue": { "value": "false", "computed": false } }, "tooltipProps": { "required": false, "tsType": { "name": "Partial", "elements": [ { "name": "intersection", "raw": "TooltipBaseProps & (TooltipWithChildrenProps | TooltipWithoutChildrenProps)", "elements": [ { "name": "TooltipBaseProps" }, { "name": "unknown" } ] } ], "raw": "Partial" }, "description": "Props for Tooltip component", "defaultValue": { "value": "{}", "computed": false } }, "tooltipContent": { "required": false, "tsType": { "name": "string" }, "description": "Tooltip wraps the button icon, it will display in the tooltip, if not present the aria label will be shown" }, "kind": { "required": false, "tsType": { "name": "ButtonType" }, "description": "Kind of button - like