Types
Types
Type glossary
"automatic" | "manual"
"static" | "dynamic"
"left" | "center" | "full-width"
"inline" | "list" | undefined
"polite" | "assertive"
"on" | "off" | "name" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "email" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "url" | "photo"
"on" | "off"
"left" | "center" | "right"
"default" | "icon"
"far" | "near" | "inline"
"dot" | "text" | "icon"
IcStatusVariants | "light" | "custom"
{ relatedTarget: IcRelatedTarget | null; }
{ mode: IcBrandForeground; color: IcColorRGB; }
"default" | "dark" | "light"
"top" | "right" | "bottom" | "left"
"reset" | "submit" | "button"
"primary" | "secondary" | "tertiary" | "destructive" | "icon" | "icon-primary" | "icon-secondary" | "icon-tertiary" | "icon-destructive"
"small" | "medium" | "large" | "extra-large"
{ value: string[]; checkedOptions: { checkbox: HTMLIcCheckboxElement; textFieldValue?: string; }[]; selectedOption: HTMLIcCheckboxElement; }
{ value: string; selectedOption: { radio: HTMLIcRadioOptionElement; textFieldValue?: string; }; }
{ value: number; }
{ checked: boolean[] | boolean; toggledOptions?: { toggleButton: HTMLIcToggleButtonElement; }[]; selectedOption: HTMLIcToggleButtonElement; }
RGB | RGBA | HEX
{ key: string; title: string; dataType: IcDataTableColumnDataTypes; columnAlignment?: { horizontal?: string; vertical?: string; }; rowOptions?: { textWrap: boolean; }; columnWidth?: string | IcDataTableColumnWidthTypes; textWrap?: boolean; cellAlignment?: string; emphasis?: string; colspan?: number; icon?: { icon: string; onAllCells?: boolean; hideOnHeader?: boolean; }; excludeColumnFromSort?: boolean; hidden?: boolean; disableAutoSort?: boolean; }
{ [key: string]: any }
"default" | "dense" | "spacious"
number | "auto"
"unsorted" | "ascending" | "descending"
"tooltip" | "show-hide" | undefined
"DD/MM/YYYY" | "MM/DD/YYYY" | "YYYY/MM/DD"
{ value: IcDataTableDensityOptions; }
0 | 576 | 768 | 992 | 1200
"left" | "center" | "right" | "top" | "bottom"
"solid" | "dashed"
"thin" | "medium" | "thick" | "very-thick"
"filled" | "outlined"
"left" | "center" | "right"
{ sideNavExpanded: boolean; sideNavMobile: boolean; }
"extra small" | "small" | "medium" | "large" | "extra large"
"left" | "center"
"left" | "right" | "top"
"warning" | "error" | "success" | ""
"medium" | "small" | "large" | "icon"
"circular" | "linear"
{ open: boolean; focusInput?: boolean; }
"toggle" | "destructive" | "default"
{ description?: string; disabled?: boolean; recommended?: boolean; children?: IcMenuOption[]; loading?: boolean; timedOut?: boolean; [key: string]: any; element?: { component: any; ariaLabel: string; }; icon?: any; }
{ optionId: string | undefined; }
{ value: string | string[] | null; keyPressed?: string; }
{ expanded: boolean; }
{ source: HTMLElement; }
{ value: string | undefined; label?: string; optionId?: string; }
"horizontal" | "vertical"
{ value: number; fromItemsPerPage?: boolean; }
"left" | "right" | "space-between"
{ alignment?: IcPaginationAlignmentOptions; hideAllFromItemsPerPage?: boolean; hideRangeLabel?: boolean; itemLabel?: string; itemsPerPageOptions?: { label: string; value: string }[]; monochrome?: boolean; pageLabel?: string; rangeLabelType?: IcPaginationLabelTypes; selectedItemsPerPage?: number; selectItemsPerPageOnEnter?: boolean; setToFirstPageOnPaginationChange?: boolean; showGoToPageControl?: boolean; showItemsPerPageControl?: boolean; theme?: IcThemeMode; type?: IcPaginationTypes; }
"page" | "ellipsis" | "simple-current"
"page" | "data"
"simple" | "complex"
"simple" | "complex"
"default" | "official" | "official-sensitive" | "secret" | "top-secret"
{ relatedTarget: IcRelatedTarget | null; }
"navigation" | "query"
"start" | "anywhere"
"auto" | "manual"
"single" | "multi"
"medium" | "large" | "small"
"medium" | "small"
"rectangle" | "text" | "circle"
{ columnName: string; sorted: IcDataTableSortOrderOptions; }
"neutral" | "success" | "warning" | "danger"
"neutral" | "info" | "warning" | "error" | "success"
"left" | "full-width"
"optional" | "required"
"active" | "current" | "completed" | "disabled"
"default" | "compact"
{ value: string | null; checked: boolean; }
{ tabId: string; contextId: string; position: number; }
{ tabIndex: number; tabLabel: string; }
"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"
"email" | "password" | "tel" | "text" | "url" | "number" | "search"
"dark" | "light" | "inherit"
any
"dark" | "light" | "system"
"top-start" | "top" | "top-end" | "right-start" | "right" | "right-end" | "bottom-end" | "bottom" | "bottom-start" | "left-end" | "left" | "left-start"
{ label: string; icon?: string; children?: IcTreeItemOptions[]; disabled?: boolean; expanded?: boolean; href?: string; selected?: boolean; treeItemId?: string; theme?: IcThemeMode; truncateTreeItem?: boolean; }
"h1" | "h2" | "h3" | "h4" | "subtitle-large" | "subtitle-small" | "body" | "label" | "label-uppercase" | "caption" | "caption-uppercase" | "code-large" | "code-small" | "code-extra-small" | "badge" | "badge-small"
{ value: string; keyPressed?: string; }
{ Sunday = 0, Monday = 1, Tuesday = 2, Wednesday = 3, Thursday = 4, Friday = 5, Saturday = 6, }