EUI Docgen output demo

EuiButton

Extends AnchorHTMLAttributes, ButtonHTMLAttributes

Prop	Description and type	Default value
Prop href#	Description and type Type: string	Default value
Prop element#	Description and type Type: "a" | "button" | "span"	Default value
Prop size#	Description and type Use size s in confined spaces Type: "s" | "m"	Default value m
Prop isSelected#	Description and type Applies the boolean state as the aria-pressed property to create a toggle button. Only use when the readable text does not change between states. Type: boolean	Default value
Prop fullWidth#	Description and type Extends the button to 100% width Type: boolean	Default value
Prop minWidth#	Description and type Override the default minimum width Type: false | MinWidth<string | number>	Default value
Prop isLoading#	Description and type Force disables the button and changes the icon to a loading spinner Type: boolean	Default value
Prop contentProps#	Description and type Object of props passed to the wrapping the button's content Type: CommonProps & EuiButtonDisplayContentType	Default value
Prop style#	Description and type Type: CSSProperties	Default value
Prop type#	Description and type Type: "button" | "reset" | "submit"	Default value
Prop iconType#	Description and type Any type accepted by EuiIcon Type: IconType	Default value
Prop iconSide#	Description and type Can only be one side left or right Type: ButtonContentIconSide	Default value
Prop textProps#	Description and type Object of props passed to the <span> wrapping the content's text/children only (not icon) This span wrapper can be removed by passing textProps={false}. Type: false | (HTMLAttributes<HTMLSpanElement> & CommonProps & { ref?: Ref<HTMLSpanElement>; 'data-text'?: string; })	Default value
Prop iconSize#	Description and type Type: "s" | "m"	Default value
Prop isDisabled#	Description and type disabled is also allowed Type: boolean	Default value
Prop className#	Description and type Type: string	Default value
Prop aria-label#	Description and type Defines a string value that labels the current element. @see aria-labelledby. Type: string	Default value
Prop data-test-subj#	Description and type Type: string	Default value
Prop css#	Description and type Type: Interpolation<Theme>	Default value
Prop fill#	Description and type Make button a solid color for prominence Type: boolean	Default value
Prop color#	Description and type Any of the named color palette options. Type: "text" | "accent" | "primary" | "success" | "warning" | "danger"	Default value primary
Prop onClick#	Description and type Type: MouseEventHandler<HTMLAnchorElement> | MouseEventHandler<HTMLButtonElement>	Default value
Prop buttonRef#	Description and type Type: Ref<HTMLAnchorElement> | Ref<HTMLButtonElement>	Default value

EuiBasicTable

Extends HTMLAttributes

Prop	Description and type	Default value
Prop items#	Description and type A list of objects to appear in the table - an item per row Type: T[]	Default value Required
Prop columns#	Description and type An array of one of the objects: #EuiTableFieldDataColumnType, #EuiTableComputedColumnType or #EuiTableActionsColumnType. Type: EuiBasicTableColumn<T>[]	Default value Required
Prop className#	Description and type Type: string	Default value
Prop aria-label#	Description and type Defines a string value that labels the current element. @see aria-labelledby. Type: string	Default value
Prop data-test-subj#	Description and type Type: string	Default value
Prop css#	Description and type Type: Interpolation<Theme>	Default value
Prop itemId#	Description and type Describes how to extract a unique ID from each item, used for selections & expanded rows Type: ItemId<T>	Default value
Prop itemIdToExpandedRowMap#	Description and type Row expansion uses the itemId prop to identify each row Type: ItemIdToExpandedRowMap	Default value
Prop cellProps#	Description and type Applied to EuiTableRowCell Type: object | CellPropsCallback<T>	Default value
Prop error#	Description and type Error message to display Type: string	Default value
Prop tableCaption#	Description and type Describes the content of the table. If not specified, the caption will be "This table contains {itemCount} rows." Type: string	Default value
Prop rowHeader#	Description and type Indicates which column should be used as the identifying cell in each row. Should match a "field" prop in FieldDataColumn Type: string	Default value
Prop loading#	Description and type Provides an infinite loading indicator Type: boolean	Default value
Prop noItemsMessage#	Description and type Message to display if table is empty Type: ReactNode	Default value ( <EuiI18n token="euiBasicTable.noItemsMessage" default="No items found" /> )
Prop onChange#	Description and type Called whenever pagination or sorting changes (this property is required when either pagination or sorting is configured). See #Criteria or #CriteriaWithPagination Type: ((criteria: Criteria<T>) => void) | ((criteria: CriteriaWithPagination<T>) => void)	Default value
Prop pagination#	Description and type Configures #Pagination Type: Pagination	Default value
Prop rowProps#	Description and type Applied to EuiTableRow Type: object | RowPropsCallback<T>	Default value
Prop selection#	Description and type Configures #EuiTableSelectionType Type: EuiTableSelectionType<T>	Default value
Prop sorting#	Description and type Configures #EuiTableSortingType Type: EuiTableSortingType<T>	Default value
Prop tableLayout#	Description and type Sets the table-layout CSS property. Note that auto tableLayout prevents truncateText from working properly. Type: "auto" | "fixed"	Default value fixed
Prop compressed#	Description and type Type: boolean	Default value
Prop responsiveBreakpoint#	Description and type Named breakpoint. Below this size, the table will collapse into responsive cards. Pass false to never collapse to a mobile view, or inversely, true to always render mobile-friendly cards. Type: string | boolean	Default value m