kilua-tabulator/dev.kilua.tabulator

Package-level declarations

Types

AddRowMode

enum AddRowMode : Enum<AddRowMode>

Add row modes.

Align

enum Align : Enum<Align>

Column align.

Calc

enum Calc : Enum<Calc>

Built-in calc functions.

ColumnDefinition

data class ColumnDefinition<T : Any>(val title: String, val field: String? = null, val columns: List<ColumnDefinition<T>>? = null, val visible: Boolean? = null, val align: Align? = null, val width: String? = null, val minWidth: Int? = null, val widthGrow: Int? = null, val widthShrink: Int? = null, val resizable: JsAny? = null, val resizableBool: Boolean? = null, val frozen: Boolean? = null, val responsive: Int? = null, val tooltip: JsAny? = null, val tooltipString: String? = null, val cssClass: String? = null, val rowHandle: Boolean? = null, val hideInHtml: Boolean? = null, val sorter: Sorter? = null, val sorterFunction: (a: JsAny, b: JsAny, aRow: RowComponent, bRow: RowComponent, column: ColumnComponent, dir: String, sorterParams: JsAny?) -> Double? = null, val sorterParams: JsAny? = null, val formatter: Formatter? = null, val formatterFunction: (cell: CellComponentBase, formatterParams: JsAny?, onRendered: (callback: () -> Unit) -> Unit) -> JsAny? = null, val formatterStringFunction: (cell: CellComponentBase, formatterParams: JsAny?, onRendered: (callback: () -> Unit) -> Unit) -> String? = null, val formatterComponentFunction: @Composable IComponent.(cell: CellComponentBase, onRendered: (callback: () -> Unit) -> Unit, data: T) -> Unit? = null, val formatterParams: JsAny? = null, val variableHeight: Boolean? = null, val editable: (cell: CellComponent) -> Boolean? = null, val editor: Editor? = null, val editorFunction: (cell: CellComponent, onRendered: (callback: () -> Unit) -> Unit, success: (value: JsAny?) -> Unit, cancel: (value: JsAny?) -> Unit, editorParams: JsAny?) -> JsAny? = null, val editorComponentFunction: @Composable IComponent.(cell: CellComponent, onRendered: (callback: () -> Unit) -> Unit, success: (value: JsAny?) -> Unit, cancel: (value: JsAny?) -> Unit, data: T) -> Unit? = null, val editorParams: JsAny? = null, val validator: Validator? = null, val validatorFunction: JsAny? = null, val validatorParams: String? = null, val download: (column: ColumnComponent) -> Boolean? = null, val titleDownload: String? = null, val topCalc: Calc? = null, val topCalcParams: JsAny? = null, val topCalcFormatter: Formatter? = null, val topCalcFormatterParams: JsAny? = null, val bottomCalc: Calc? = null, val bottomCalcParams: JsAny? = null, val bottomCalcFormatter: Formatter? = null, val bottomCalcFormatterParams: JsAny? = null, val headerSort: Boolean? = null, val headerSortStartingDir: SortingDir? = null, val headerSortTristate: Boolean? = null, val headerClick: (e: JsAny, column: ColumnComponent) -> Unit? = null, val headerDblClick: (e: JsAny, column: ColumnComponent) -> Unit? = null, val headerContext: (e: JsAny, column: ColumnComponent) -> Unit? = null, val headerTap: (e: JsAny, column: ColumnComponent) -> Unit? = null, val headerDblTap: (e: JsAny, column: ColumnComponent) -> Unit? = null, val headerTapHold: (e: JsAny, column: ColumnComponent) -> Unit? = null, val headerTooltip: JsAny? = null, val headerTooltipString: String? = null, val headerVertical: Boolean? = null, val editableTitle: Boolean? = null, val titleFormatter: Formatter? = null, val titleFormatterFunction: (cell: CellComponentBase, formatterParams: JsAny?, onRendered: (callback: () -> Unit) -> Unit) -> JsAny? = null, val titleFormatterStringFunction: (cell: CellComponentBase, formatterParams: JsAny?, onRendered: (callback: () -> Unit) -> Unit) -> String? = null, val titleFormatterComponentFunction: @Composable IComponent.(cell: CellComponentBase, onRendered: (callback: () -> Unit) -> Unit) -> Unit? = null, val titleFormatterParams: JsAny? = null, val headerFilter: Editor? = null, val headerFilterParams: JsAny? = null, val headerFilterCustom: (cell: CellComponent, onRendered: (callback: () -> Unit) -> Unit, success: (value: JsAny) -> Unit, cancel: (value: JsAny) -> Unit, editorParams: JsAny?) -> JsAny? = null, val headerFilterPlaceholder: String? = null, val headerFilterEmptyCheck: (value: JsAny) -> Boolean? = null, val headerFilterFunc: Filter? = null, val headerFilterFuncCustom: (headerValue: JsAny, rowValue: JsAny, rowData: JsAny, filterParams: JsAny) -> Boolean? = null, val headerFilterFuncParams: JsAny? = null, val headerFilterLiveFilter: Boolean? = null, val htmlOutput: JsAny? = null, val htmlOutputBool: Boolean? = null, val print: JsAny? = null, val printBool: Boolean? = null, val formatterPrint: (cell: CellComponentBase, formatterParams: JsAny?, onRendered: (callback: () -> Unit) -> Unit) -> JsAny? = null, val formatterPrintParams: JsAny? = null, val cellClick: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellDblClick: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellContext: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellTap: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellDblTap: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellTapHold: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellMouseEnter: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellMouseLeave: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellMouseOver: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellMouseOut: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellMouseMove: (e: JsAny, cell: CellComponent) -> Unit? = null, val cellEditing: (cell: CellComponent) -> Unit? = null, val cellEdited: (cell: CellComponent) -> Unit? = null, val cellEditCancelled: (cell: CellComponent) -> Unit? = null, val headerMenu: JsAny? = null, val headerContextMenu: JsAny? = null, val contextMenu: JsAny? = null, val hozAlign: Align? = null, val vertAlign: VAlign? = null, val clickMenu: JsAny? = null, val headerHozAlign: Align? = null, val accessor: JsAny? = null, val accessorParams: JsAny? = null, val maxWidth: Int? = null, val mutatorData: (value: JsAny, data: JsAny, type: String, params: JsAny, cell: CellComponent) -> JsAny? = null, val mutatorDataParams: JsAny? = null, val mutatorEdit: (value: JsAny, data: JsAny, type: String, params: JsAny, cell: CellComponent) -> JsAny? = null, val mutatorEditParams: JsAny? = null, val mutatorClipboard: (value: JsAny, data: JsAny, type: String, params: JsAny, cell: CellComponent) -> JsAny? = null, val mutatorClipboardParams: JsAny? = null, val mutator: (value: JsAny, data: JsAny, type: String, params: JsAny, cell: CellComponent) -> JsAny? = null, val mutatorParams: JsAny? = null, val maxInitialWidth: Int? = null, val cellPopup: JsAny? = null, val headerPopup: JsAny? = null, val headerPopupIcon: JsAny? = null, val headerContextPopup: JsAny? = null, val clickPopup: JsAny? = null, val contextPopup: JsAny? = null, val headerMenuIcon: JsAny? = null, val headerWordWrap: Boolean? = null, val dblClickPopup: JsAny? = null, val headerClickPopup: JsAny? = null, val headerDblClickPopup: JsAny? = null, val headerClickMenu: JsAny? = null, val headerDblClickMenu: JsAny? = null, val dblClickMenu: JsAny? = null, val headerColumnsMenu: Boolean? = null, val headerColumnsMenuTitle: String? = null, val headerColumnsMenuIcon: String? = null, val headerColumnsMenuResetTitle: String? = null, val headerColumnsMenuResetIconPrefix: String? = null, val headerColumnsMenuResetIcon: String? = null, val headerColumnsMenuListIconPrefix: String? = null, val headerColumnsMenuListIconChecked: String? = null, val headerColumnsMenuListIconUnchecked: String? = null, val responsiveCollapseAutoIcon: String? = null)

Column definition options.

ColumnPosition

enum ColumnPosition : Enum<ColumnPosition>

Column positions.

DownloadConfig

data class DownloadConfig(val columnGroups: Boolean? = null, val rowGroups: Boolean? = null, val columnCalcs: Boolean? = null, val rowHeaders: Boolean? = null)

Download config options.

Editor

enum Editor : Enum<Editor>

Built-in editors.

EditTriggerEvent

enum EditTriggerEvent : Enum<EditTriggerEvent>

Possible edit trigger events.

Filter

enum Filter : Enum<Filter>

Filters.

FilterMode

enum FilterMode : Enum<FilterMode>

Filter modes.

Formatter

enum Formatter : Enum<Formatter>

Built-in formatters.

HeaderSortClickElement

enum HeaderSortClickElement : Enum<HeaderSortClickElement>

Possible header sort click elements.

ImportFormat

enum ImportFormat : Enum<ImportFormat>

Import formats.

ImportReader

enum ImportReader : Enum<ImportReader>

Import readers.

ITabulator

interface ITabulator<T : Any> : ITag<HTMLDivElement>

Tabulator component.

Layout

enum Layout : Enum<Layout>

Table layouts.

PaginationMode

enum PaginationMode : Enum<PaginationMode>

Pagination modes.

PaginationState

data class PaginationState(val currentPage: Int, val maxPages: Int, val buttonCount: Int = 5)

Pagination state.

ProgressiveMode

enum ProgressiveMode : Enum<ProgressiveMode>

Progressive modes.

RangeMode

enum RangeMode : Enum<RangeMode>

Range select modes.

RenderType

enum RenderType : Enum<RenderType>

Virtual DOM options.

ResponsiveLayout

enum ResponsiveLayout : Enum<ResponsiveLayout>

Responsive layout modes.

RowPos

enum RowPos : Enum<RowPos>

Row positions.

RowPosition

enum RowPosition : Enum<RowPosition>

Row scroll positions .

Sorter

enum Sorter : Enum<Sorter>

Built-in sorters.

SortingDir

enum SortingDir : Enum<SortingDir>

Sorting directions.

SortMode

enum SortMode : Enum<SortMode>

Sort modes.

TableType

enum TableType : Enum<TableType>

Tabulator table types.

Tabulator

open class Tabulator<T : Any>(data: List<T>? = null, options: TabulatorOptions<T> = TabulatorOptions(), className: String? = null, id: String? = null, renderConfig: RenderConfig = RenderConfig.Default, kClass: KClass<T>? = null, serializer: KSerializer<T>? = null, module: SerializersModule? = null) : Tag<HTMLDivElement> , ITabulator<T>

Tabulator component.

TabulatorOptions

data class TabulatorOptions<T : Any>(val height: String? = null, val placeholder: String? = null, val placeholderFunc: () -> String?? = null, val placeholderHeaderFilter: String? = null, val footerElement: String? = null, val history: Boolean? = null, val keybindings: JsAny? = null, val downloadDataFormatter: JsAny? = null, val downloadConfig: DownloadConfig? = null, val reactiveData: Boolean? = null, val autoResize: Boolean? = null, val columns: List<ColumnDefinition<T>>? = null, val autoColumns: Boolean? = null, val autoColumnsFull: Boolean? = null, val layout: Layout? = null, val layoutColumnsOnNewData: Boolean? = null, val responsiveLayout: ResponsiveLayout? = null, val responsiveLayoutCollapseStartOpen: Boolean? = null, val responsiveLayoutCollapseUseFormatters: Boolean? = null, val movableColumns: Boolean? = null, val scrollToColumnPosition: ColumnPosition? = null, val scrollToColumnIfVisible: Boolean? = null, val rowFormatter: (row: RowComponent) -> Unit? = null, val addRowPos: RowPos? = null, val selectableRows: JsAny? = null, val selectableRowsBool: Boolean? = null, val selectableRowsRangeMode: RangeMode? = null, val selectableRowsRollingSelection: Boolean? = null, val selectableRowsPersistence: Boolean? = null, val selectableRowsCheck: (row: RowComponent) -> Boolean? = null, val movableRows: Boolean? = null, val movableRowsConnectedTables: JsAny? = null, val movableRowsSender: JsAny? = null, val movableRowsReceiver: JsAny? = null, val resizableRows: Boolean? = null, val scrollToRowPosition: RowPosition? = null, val scrollToRowIfVisible: Boolean? = null, val index: String? = null, val data: JsArray<JsAny>? = null, val ajaxURL: String? = null, val ajaxParams: JsAny? = null, val ajaxConfig: JsAny? = null, val ajaxContentType: JsAny? = null, val ajaxURLGenerator: (url: String, config: JsAny, params: JsAny) -> String? = null, val ajaxRequestFunc: (url: String, config: JsAny, params: JsAny) -> Promise<JsAny>? = null, val progressiveLoad: ProgressiveMode? = null, val progressiveLoadDelay: Int? = null, val progressiveLoadScrollMargin: Int? = null, val dataLoader: Boolean? = null, val dataLoaderLoading: String? = null, val dataLoaderError: String? = null, val initialSort: List<JsAny>? = null, val sortOrderReverse: Boolean? = null, val initialFilter: List<JsAny>? = null, val initialHeaderFilter: List<JsAny>? = null, val pagination: Boolean? = null, val paginationMode: PaginationMode? = null, val paginationSize: Int? = null, val paginationSizeSelector: JsAny? = null, val paginationElement: JsAny? = null, val dataReceiveParams: JsAny? = null, val dataSendParams: JsAny? = null, val paginationAddRow: AddRowMode? = null, val paginationButtonCount: Int? = null, val persistenceID: String? = null, val persistenceMode: Boolean? = null, val persistentLayout: Boolean? = null, val persistentSort: Boolean? = null, val persistentFilter: Boolean? = null, val locale: String? = null, val langs: JsAny? = null, val localized: (locale: String, lang: JsAny) -> Unit? = null, val headerVisible: Boolean? = null, val htmlOutputConfig: JsAny? = null, val printAsHtml: Boolean? = null, val printConfig: JsAny? = null, val printCopyStyle: Boolean? = null, val printVisibleRows: Boolean? = null, val printHeader: String? = null, val printFooter: String? = null, val printFormatter: (tableHolder: JsAny, table: JsAny) -> Unit? = null, val tabEndNewRow: JsAny? = null, val invalidOptionWarnings: Boolean? = null, val dataTree: Boolean? = null, val dataTreeChildField: String? = null, val dataTreeCollapseElement: JsAny? = null, val dataTreeExpandElement: JsAny? = null, val dataTreeElementColumn: String? = null, val dataTreeBranchElement: JsAny? = null, val dataTreeChildIndent: Number? = null, val dataTreeStartExpanded: (row: RowComponent, level: JsNumber) -> Boolean? = null, val ajaxRequesting: (url: String, params: JsAny) -> Boolean? = null, val ajaxResponse: (url: String, params: JsAny, response: JsAny) -> JsAny? = null, val persistence: JsAny? = null, val persistenceBool: Boolean? = null, val persistenceReaderFunc: JsAny? = null, val persistenceWriterFunc: JsAny? = null, val paginationInitialPage: Int? = null, val columnHeaderVertAlign: VAlign? = null, val maxHeight: String? = null, val minHeight: String? = null, val rowContextMenu: JsAny? = null, val dataTreeChildColumnCalcs: Boolean? = null, val dataTreeSelectPropagate: Boolean? = null, val headerFilterLiveFilterDelay: Int? = null, val textDirection: TextDirection? = null, val autoColumnsDefinitions: JsAny? = null, val rowClickMenu: JsAny? = null, val headerSortElement: JsAny? = null, val dataTreeFilter: Boolean? = null, val dataTreeSort: Boolean? = null, val renderVertical: RenderType? = null, val renderVerticalBuffer: Int? = null, val renderHorizontal: RenderType? = null, val columnDefaults: ColumnDefinition<T>? = null, val sortMode: SortMode? = null, val filterMode: FilterMode? = null, val importFormat: ImportFormat? = null, val importReader: ImportReader? = null, val dataLoaderErrorTimeout: Int? = null, val popupContainer: JsAny? = null, val paginationCounter: JsAny? = null, val paginationCounterElement: JsAny? = null, val rowClickPopup: JsAny? = null, val rowContextPopup: JsAny? = null, val resizableColumnFit: Boolean? = null, val rowHeight: Int? = null, val frozenRows: JsAny? = null, val frozenRowsField: String? = null, val headerSortClickElement: HeaderSortClickElement? = null, val rowDblClickPopup: JsAny? = null, val rowDblClickMenu: JsAny? = null, val responsiveLayoutCollapseFormatter: (data: JsArray<JsAny>) -> Element? = null, val selectableRange: JsAny? = null, val selectableRangeColumns: Boolean? = null, val selectableRangeRows: Boolean? = null, val selectableRangeClearCells: Boolean? = null, val selectableRangeClearCellsValue: String? = null, val editTriggerEvent: EditTriggerEvent? = null, val rowHeader: JsAny? = null, val spreadsheet: Boolean? = null, val spreadsheetColumns: Int? = null, val spreadsheetRows: Int? = null, val spreadsheetData: JsAny? = null, val spreadsheetColumnDefinition: JsAny? = null, val spreadsheetOutputFull: Boolean? = null, val spreadsheetSheets: JsAny? = null, val spreadsheetSheetTabs: Boolean? = null, val resizableColumnGuide: Boolean? = null, val resizableRowGuide: Boolean? = null, val editorEmptyValue: JsAny? = null, val editorEmptyValueFunc: (JsAny) -> Boolean? = null, val paginationIconFirst: String? = null, val paginationIconPrev: String? = null, val paginationIconNext: String? = null, val paginationIconLast: String? = null, val paginationIconPageSize: String? = null)

Tabulator options.

TextDirection

enum TextDirection : Enum<TextDirection>

Text direction.

Validator

enum Validator : Enum<Validator>

Built-in validators.

VAlign

enum VAlign : Enum<VAlign>

Column align.

Functions

getClass

inline fun <T : Any> getClass(): KClass<T>

tabulator

@Composable

fun IComponent.tabulator(data: List<JsAny>? = null, options: TabulatorOptions<JsAny> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, id: String? = null, content: @Composable ITabulator<JsAny>.() -> Unit = {})

Create Tabulator component with a dynamic data model.

@Composable

inline fun <T : Any> IComponent.tabulator(data: List<T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), serializer: KSerializer<T> = serializer(), serializersModule: SerializersModule? = null, className: String? = null, id: String? = null, noinline content: @Composable ITabulator<T>.() -> Unit = {})

Create Tabulator component with a Kotlin data model.

tabulatorPagination

@Composable

fun <T : Any> IComponent.tabulatorPagination(tabulatorGetter: () -> Tabulator<T>, iconFirst: String = "fas fa-angles-left", iconPrev: String = "fas fa-angle-left", iconNext: String = "fas fa-angle-right", iconLast: String = "fas fa-angles-right", className: String? = null, id: String? = null, init: @Composable IDiv.() -> Unit = {})

Tabulator pagination component.

tabulatorRef

@Composable

fun IComponent.tabulatorRef(data: List<JsAny>? = null, options: TabulatorOptions<JsAny> = TabulatorOptions(), types: Set<TableType> = setOf(), className: String? = null, id: String? = null, content: @Composable ITabulator<JsAny>.() -> Unit = {}): Tabulator<JsAny>

Create Tabulator component with a dynamic data model.

@Composable

inline fun <T : Any> IComponent.tabulatorRef(data: List<T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), serializer: KSerializer<T> = serializer(), serializersModule: SerializersModule? = null, className: String? = null, id: String? = null, noinline content: @Composable ITabulator<T>.() -> Unit = {}): Tabulator<T>

Create Tabulator component with a Kotlin data model, returning a reference.