Members

Type: Action

# constant bookmarkAction

Properties:

Name	Type	Description
`name`	`string`	bookmark
`icon`	`ConstructorOfATypedSvelteComponent`	BookmarkOutline

View Source cells/Actions.ts, line 3

Type: Action

# constant deleteAction

Properties:

Name	Type	Description
`name`	`string`	delete
`icon`	`ConstructorOfATypedSvelteComponent`	TrashBinOutline

View Source cells/Actions.ts, line 13

Type: Action

# constant downAction

Properties:

Name	Type	Description
`name`	`string`	down
`icon`	`ConstructorOfATypedSvelteComponent`	ArrowDownSolid

View Source cells/Actions.ts, line 23

Type: Action

# constant editAction

Properties:

Name	Type	Description
`name`	`string`	edit
`icon`	`ConstructorOfATypedSvelteComponent`	EditOutline

View Source cells/Actions.ts, line 33

Type: Action

# constant favoriteAction

Properties:

Name	Type	Description
`name`	`string`	favorite
`icon`	`ConstructorOfATypedSvelteComponent`	HeartSolid

View Source cells/Actions.ts, line 43

Type: Action

# constant infoAction

Properties:

Name	Type	Description
`name`	`string`	info
`icon`	`ConstructorOfATypedSvelteComponent`	InfoCircleOutline

View Source cells/Actions.ts, line 53

Type: Action

# constant notificationAction

Properties:

Name	Type	Description
`name`	`string`	notification
`icon`	`ConstructorOfATypedSvelteComponent`	BellActiveOutline

View Source cells/Actions.ts, line 63

Type: Action

# constant settingsAction

Properties:

Name	Type	Description
`name`	`string`	settings
`icon`	`ConstructorOfATypedSvelteComponent`	CogOutline

View Source cells/Actions.ts, line 73

Type: Action

# constant shareAction

Properties:

Name	Type	Description
`name`	`string`	share
`icon`	`ConstructorOfATypedSvelteComponent`	ShareNodesOutline

View Source cells/Actions.ts, line 83

Type: Action

# constant upAction

Properties:

Name	Type	Description
`name`	`string`	up
`icon`	`ConstructorOfATypedSvelteComponent`	UpArrowSolid

View Source cells/Actions.ts, line 93

Methods

# joinClasses(…items) → {string}

Joins an array of classes into a string, removing any falsey values.

Parameters:

Name	Type	Attributes	Description
`items`	`string`	<repeatable>	Strings of CSS classes to join.

View Source common.ts, line 3

Returns:

Type: string

Type Definitions

# ActionDisablementFunction(item, column, action) → {boolean}

Returns true if the action should be disabled for the row.

Parameters:

Name	Type	Description
`item`	`any`	The row of data
`column`	`ColumnConfig`	The configuration for the ActionCell's column
`action`	`Action`	The action to disable or enable

View Source cells/ActionsCell.doc.ts, line 2

Returns:

Type: boolean

Type: object

# ActionsCell

Cell containing an array of Button (https://flowbite-svelte.com/docs/components/buttons) components which fire the action event on the grid when clicked.

Properties:

Name	Type	Attributes	Description
`Action[]`		<optional>	actions - The actions to be displayed inside the cell.
`buttonClass`	`string`	<optional>	Class for the cell's buttons. Defaults to 'border-0 p-1'.
`buttonColor`	`ButtonColor`	<optional>	See https://flowbite-svelte.com/docs/pages/typescript. Defaults to 'light'.
`iconClass`	`string`	<optional>	Class for the icon to be displayed in the button. Defaults to 'w-4 h-4'.

View Source cells/ActionsCell.doc.ts, line 21

Type: object

# ButtonCell

Cell containing a Button (https://flowbite-svelte.com/docs/components/buttons) component.

Properties:

Name	Type	Attributes	Description
`caption`	`string`	<optional>	Text to be displayed inside the button.
`icon`	`ConstructorOfATypedSvelteComponent`	<optional>	Icon to be displayed inside the button.
`iconClass`	`string`	<optional>	CSS class of the icon to be displayed inside the button.
`iconPosition`	`'left'` \| `'right'`	<optional>	Position of the icon, relative to the caption. Defaults to 'right'.

View Source cells/ButtonCell.doc.ts, line 2

# CellDropBoolean() → {boolean}

View Source common.ts, line 129

Returns:

Type: boolean

# CellRenderer(column, item) → {CellValue}

Returns the value for a given column/row combination.

Parameters:

Name	Type	Description
`column`	`ColumnConfig`	Configuration for the cell's column.
`item`	`any`	Data for the cell's row.

View Source common.ts, line 48

Returns:

Type: CellValue

Type: object

# CheckboxCell

Cell containing a Checkbox (https://flowbite-svelte.com/docs/forms/checkbox) component.

Properties:

Name	Type	Attributes	Description
`caption`	`string`	<optional>	Text to be displayed next to the checkbox.

View Source cells/CheckboxCell.doc.ts, line 2

# DataCellClassFunction(item, column, value, isFocused, calcClass, defaultClass, appendClass, overrideClass) → {string}

Returns the a class string for a data cell.

Parameters:

Name	Type	Description
`item`	`any`	Data for the cell's row.
`column`	`ColumnConfig`	Configuration for the cell's column.
`value`	`CellValue`	Value for the data cell, after Column.cellRenderer (if any) has been called.
`isFocused`	`boolean`	True if the cell is focused.
`calcClass`	`string`	Classes as determined by grid and column properties and focus state.
`defaultClass`	`string`	Default classes for a TableBodyCell component as defined by FlowBite.
`appendClass`	`string`	tdClassAppend from DataTable.
`overrideClass`	`string`	tdClassOveride from DataTable.

View Source common.ts, line 56

Returns:

Type: string

# EnterAction

Values for enterAction on DataTable.

View Source common.ts, line 119

Type: object

# InputCell

Cell containing an Input (https://flowbite-svelte.com/docs/forms/input-field) component.

Properties:

Name	Type	Attributes	Description
`inputType`	`string`	<optional>	See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types

View Source cells/InputCell.doc.ts, line 2

Type: object

# MultiSelectCell

Cell containing a MultiSelect (https://flowbite-svelte.com/docs/forms/select#MultiSelect) component.

Properties:

Name	Type	Attributes	Description
`displayProp`	`string`	<optional>	Property within items which displays in the list. Defaults to 'name'.
`valueProp`	`string`	<optional>	Property within tems used to populate the cell's value when picked. Defaults to 'id'.
`items`	`Array.<any>`		Array of objects the user can select from.

View Source cells/MultiSelectCell.doc.ts, line 2

Type: object

# NumberInputCell

Cell containing a NumberInput (https://flowbite-svelte.com/docs/forms/input-field#Number_input) component.

Properties:

Name	Type	Attributes	Description
`inputType`	`string`	<optional>	See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types

View Source cells/NumberInputCell.doc.ts, line 2

Type: object

# RangeCell

Cell containing a range (https://flowbite-svelte.com/docs/forms/range) component.

Properties:

Name	Type	Description
`min`	`number`	Passed through.
`max`	`number`	Passed through.

View Source cells/RangeCell.doc.ts, line 2

Type: object

# RatingCell

Cell containing a rating (https://flowbite-svelte.com/docs/components/rating) component.

Properties:

Name	Type	Attributes	Description
`icon`	`number`	<optional>	Passed through.
`total`	`number`	<optional>	Passed through.

View Source cells/RatingCell.doc.ts, line 2

# RowBoolean() → {boolean}

View Source common.ts, line 135

Returns:

Type: boolean

# RowClassFunction(item, isFocused, calcClass, defaultClass, appendClass, overrideClass) → {string}

Returns the a class string for a data row.

Parameters:

Name	Type	Description
`item`	`any`	Data for the cell's row.
`isFocused`	`boolean`	True if a cell on this row is focused.
`calcClass`	`string`	Classes as termined by grid properties.
`defaultClass`	`string`	Default classes for a TableBodyRow component as defined by FlowBite.
`appendClass`	`string`	trClassAppend from DataTable.
`overrideClass`	`string`	trClassOveride from DataTable.

View Source common.ts, line 106

Returns:

Type: string

# RowDropBoolean() → {boolean}

View Source common.ts, line 141

Returns:

Type: boolean

Type: object

# SelectCell

Cell containing a Select (https://flowbite-svelte.com/docs/forms/select) component.

Properties:

Name	Type	Attributes	Description
`displayProp`	`string`	<optional>	Property within items which displays in the list. Defaults to 'name'.
`valueProp`	`string`	<optional>	Property within tems used to populate the cell's value when picked. Defaults to 'id'.
`items`	`Array.<any>`		Array of objects the user can select from.

View Source cells/SelectCell.doc.ts, line 2

# SortFunction(a, b) → {number}

Returns a comparison between two values, used for sorting.

Parameters:

Name	Type	Description
`a`	`any`	First value to compare.
`b`	`any`	Second value to compare.

View Source common.ts, line 70

Returns:

Type: number

Type: object

# SpinCell

Cell containing a numeric value and plus and minus buttons. The value is decremented or incremented when the buttons are clicked.

Properties:

Name	Type	Attributes	Description
`decValue`	`number`	<optional>	Amount to decrement the value by when the minus button is clicked. Defaults to 1.
`incValue`	`number`	<optional>	Amount to increment the value by when the plus button is clicked. Defaults to 1.
`minValue`	`number`	<optional>	If specified, the minus button cannot make the value go lower than this.
`maxValue`	`number`	<optional>	If specified, the plus button cannot make the value go higher than this.
`minusIcon`	`ConstructorOfATypedSvelteComponent`	<optional>	Svelte component class for the minus icon. Defaults to MinusSolid from https://flowbite.com/icons/
`minusIconClass`	`string`	<optional>	CSS class of the minus icon, defaults to 'pr-1 w-3 h-3'
`plusIcon`	`ConstructorOfATypedSvelteComponent`	<optional>	Svelte component class for the plus icon. Defaults to PlusSolid from https://flowbite.com/icons/
`plusIconClass`	`string`	<optional>	CSS class of the plus icon, defaults to 'pr-1 w-3 h-3'

View Source cells/SpinCell.doc.ts, line 2

Type: object

# TabWrapper

Utility component to make tabbing between focused cells work. See InputCell.svelte as an example.

View Source cells/TabWrapper.doc.ts, line 2

Type: object

# ToggleCell

Cell containing a Toggle (https://flowbite-svelte.com/docs/forms/toggle) component.

Properties:

Name	Type	Attributes	Description
`caption`	`string`	<optional>	Text to be displayed inside the button.

View Source cells/ToggleCell.doc.ts, line 2

Events

Type: object

# action

Properties:

Name	Type	Description
`detail.action`	`string`	The name property of the action whose button was clicked.
`detail.item`	`any`	Data for the action cell's row.
`detail.column`	`ColumnConfig`	Configuration for the action cell's column.

View Source DataTable.doc.ts, line 23

Type: object

# cellChanged

Properties:

Name	Type	Description
`detail.item`	`any`	Data for the cell's row, prior to the change.
`detail.column`	`ColumnConfig`	Configuration for the cell's column.
`detail.oldValue`	`any`	The data value of the cell before the change.
`detail.newValue`	`any`	The new value that needs to be applied to the cell.

View Source DataTable.doc.ts, line 30

Type: object

# cellClicked

Properties:

Name	Type	Description
`detail.item`	`any`	Data for the cell's row.
`detail.column`	`ColumnConfig`	Configuration for the cell's column.

View Source DataTable.doc.ts, line 3

Type: object

# headerClicked

Properties:

Name	Type	Description
`detail.column`	`ColumnConfig`	Configuration for the header's column.
`detail.sortColumnID`	`string`	The current sortColumnID.
`detail.sortKey`	`string`	The current sortKey.
`detail.sortFunction`	`SortFunction`	The current sortFunction.
`detail.reverseSort`	`boolean`	True if the grid is currently sorting in reverse.

View Source DataTable.doc.ts, line 9

Type: object

# rowClicked

Properties:

Name	Type	Description
`detail.item`	`any`	Data for the row.

View Source DataTable.doc.ts, line 18