UNPKG

@3mo/data-grid

Version:
1,676 lines 182 kB
{ "version": "experimental", "tags": [ { "name": "mo-data-grid", "path": ".\\packages\\DataGrid\\DataGrid.ts", "attributes": [ { "name": "data", "description": "The data to be displayed in the DataGrid. It is an array of objects, where each object represents a row.", "type": "TData[]", "default": "\"new Array<TData>()\"" }, { "name": "columns", "description": "The columns to be displayed in the DataGrid. It is an array of objects, where each object represents a column.", "type": "DataGridColumn<TData, unknown>[]", "default": "\"new Array<DataGridColumn<TData>>()\"" }, { "name": "headerHidden", "description": "Whether the header should be hidden.", "type": "boolean", "default": "false" }, { "name": "preventVerticalContentScroll", "description": "Whether the content should be prevented from scrolling vertically.", "type": "boolean", "default": "false" }, { "name": "page", "description": "The current page.", "type": "number", "default": "1" }, { "name": "pagination", "description": "The pagination mode. It can be either `auto` or a number.", "type": "DataGridPagination | undefined" }, { "name": "sorting", "description": "The sorting mode. It is an object with `selector` and `strategy` properties.", "type": "DataGridSorting<TData> | undefined" }, { "name": "selectability", "description": "The selection mode. Default to 'single' if context menus available, 'undefined' otherwise.", "type": "DataGridSelectability | undefined" }, { "name": "isDataSelectable", "description": "Whether data of a given row is selectable.", "type": "((data: TData) => boolean) | undefined" }, { "name": "selectedData", "description": "The selected data.", "type": "TData[]", "default": "\"new Array<TData>()\"" }, { "name": "selectOnClick", "description": "Whether the row should be selected on click.", "type": "boolean", "default": "false" }, { "name": "selectionBehaviorOnDataChange", "description": "The behavior of the selection when the data changes.", "type": "DataGridSelectionBehaviorOnDataChange", "default": "\"reset\"" }, { "name": "multipleDetails", "description": "Whether multiple details can be opened at the same time.", "type": "boolean", "default": "false" }, { "name": "subDataGridDataSelector", "description": "The key path of the sub data grid data.", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | undefined" }, { "name": "hasDataDetail", "description": "Whether the data has a detail.", "type": "((data: TData) => boolean) | undefined" }, { "name": "detailsOnClick", "description": "Whether the details should be opened on click.", "type": "boolean", "default": "false" }, { "name": "primaryContextMenuItemOnDoubleClick", "description": "The primary context menu item on double click.", "type": "boolean", "default": "false" }, { "name": "editability", "description": "The editability mode.", "type": "DataGridEditability", "default": "\"never\"" }, { "name": "getRowDetailsTemplate", "description": "A function which returns a template for the details of a given row.", "type": "((data: TData) => HTMLTemplateResult) | undefined" }, { "name": "getRowContextMenuTemplate", "description": "A function which returns a template for the context menu of a given row.", "type": "((data: TData[]) => HTMLTemplateResult) | undefined" }, { "name": "sidePanelTab", "description": "The side panel tab.", "type": "DataGridSidePanelTab | undefined" }, { "name": "sidePanelHidden", "description": "Whether the side panel should be hidden.", "type": "boolean", "default": "false" }, { "name": "hasAlternatingBackground", "description": "Whether the rows should have alternating background.", "type": "LocalStorage<boolean>", "default": "\"new LocalStorage('DataGrid.HasAlternatingBackground', true)\"" }, { "name": "preventFabCollapse", "description": "Whether the FAB should be prevented from collapsing.", "type": "boolean", "default": "false" }, { "name": "cellFontSize", "description": "The font size of the cells relative to the default font size. Defaults", "type": "number", "default": "\"value\"" }, { "name": "rowHeight", "description": "The height of the rows in pixels. Defaults to", "type": "LocalStorage<number>", "default": "\"new LocalStorage<number>('DataGrid.RowHeight', 35)\"" }, { "name": "exportable", "description": "Whether the DataGrid is exportable. This will show an export button in the footer.", "type": "boolean", "default": "false" } ], "properties": [ { "name": "cellRelativeFontSize", "type": "LocalStorage<number>", "default": "\"new LocalStorage<number>('DataGrid.CellRelativeFontSize', 0.8)\"" }, { "name": "dataChange", "type": "EventDispatcher<TData[]>" }, { "name": "selectionChange", "type": "EventDispatcher<TData[]>" }, { "name": "pageChange", "type": "EventDispatcher<number>" }, { "name": "paginationChange", "type": "EventDispatcher<DataGridPagination | undefined>" }, { "name": "columnsChange", "type": "EventDispatcher<DataGridColumn<TData, unknown>[]>" }, { "name": "sidePanelOpen", "type": "EventDispatcher<DataGridSidePanelTab>" }, { "name": "sidePanelClose", "type": "EventDispatcher<void>" }, { "name": "sortingChange", "type": "EventDispatcher<DataGridRankedSortDefinition<TData>[]>" }, { "name": "rowDetailsOpen", "type": "EventDispatcher<DataGridRow<TData, TDetailsElement>>" }, { "name": "rowDetailsClose", "type": "EventDispatcher<DataGridRow<TData, TDetailsElement>>" }, { "name": "rowClick", "type": "EventDispatcher<DataGridRow<TData, TDetailsElement>>" }, { "name": "rowDoubleClick", "type": "EventDispatcher<DataGridRow<TData, TDetailsElement>>" }, { "name": "rowMiddleClick", "type": "EventDispatcher<DataGridRow<TData, TDetailsElement>>" }, { "name": "cellEdit", "type": "EventDispatcher<DataGridCell<any, TData, TDetailsElement>>" }, { "name": "rows", "type": "DataGridRow<TData, TDetailsElement>[]" }, { "name": "hasSelection", "type": "boolean" }, { "name": "hasDetails", "type": "boolean" }, { "name": "allRowDetailsOpen", "type": "boolean" }, { "name": "extractedColumns", "type": "DataGridColumn<TData, unknown>[]" }, { "name": "visibleColumns", "type": "DataGridColumn<TData, unknown>[]" }, { "name": "hasContextMenu", "type": "boolean" }, { "name": "toolbarElements", "type": "Element[]" }, { "name": "hasToolbar", "type": "boolean" }, { "name": "filterElements", "type": "Element[]" }, { "name": "hasFilters", "type": "boolean" }, { "name": "hasSums", "type": "boolean" }, { "name": "hasFabs", "type": "boolean" }, { "name": "hasPagination", "type": "boolean" }, { "name": "supportsDynamicPageSize", "type": "boolean" }, { "name": "pageSize", "type": "LocalStorage<number>", "default": "\"new LocalStorage<Exclude<DataGridPagination, 'auto'>>('DataGrid.PageSize', 25)\"" }, { "name": "hasFooter", "type": "boolean" }, { "name": "dataLength", "type": "number | undefined" }, { "name": "maxPage", "type": "number | undefined" }, { "name": "hasNextPage", "type": "boolean" }, { "name": "columnsController", "type": "DataGridColumnsController<TData>", "default": "\"new DataGridColumnsController(this)\"" }, { "name": "selectionController", "type": "DataGridSelectionController<TData>", "default": "\"new DataGridSelectionController(this)\"" }, { "name": "sortingController", "type": "DataGridSortingController<TData>", "default": "\"new DataGridSortingController(this)\"" }, { "name": "contextMenuController", "type": "DataGridContextMenuController<TData>", "default": "\"new DataGridContextMenuController(this)\"" }, { "name": "detailsController", "type": "DataGridDetailsController<TData>", "default": "\"new DataGridDetailsController(this)\"" }, { "name": "csvController", "type": "DataGridCsvController<TData>", "default": "\"new DataGridCsvController<TData>(this)\"" }, { "name": "rowIntersectionObserver", "type": "IntersectionObserver | undefined" }, { "name": "hasDefaultRowElements", "type": "boolean" }, { "name": "sumsTemplate", "type": "HTMLTemplateResult" }, { "name": "dataRecords", "type": "DataRecord<TData>[]" }, { "name": "renderDataRecords", "type": "DataRecord<TData>[]" }, { "name": "data", "attribute": "data", "description": "The data to be displayed in the DataGrid. It is an array of objects, where each object represents a row.", "type": "TData[]", "default": "\"new Array<TData>()\"" }, { "name": "columns", "attribute": "columns", "description": "The columns to be displayed in the DataGrid. It is an array of objects, where each object represents a column.", "type": "DataGridColumn<TData, unknown>[]", "default": "\"new Array<DataGridColumn<TData>>()\"" }, { "name": "headerHidden", "attribute": "headerHidden", "description": "Whether the header should be hidden.", "type": "boolean", "default": "false" }, { "name": "preventVerticalContentScroll", "attribute": "preventVerticalContentScroll", "description": "Whether the content should be prevented from scrolling vertically.", "type": "boolean", "default": "false" }, { "name": "page", "attribute": "page", "description": "The current page.", "type": "number", "default": "1" }, { "name": "pagination", "attribute": "pagination", "description": "The pagination mode. It can be either `auto` or a number.", "type": "DataGridPagination | undefined" }, { "name": "sorting", "attribute": "sorting", "description": "The sorting mode. It is an object with `selector` and `strategy` properties.", "type": "DataGridSorting<TData> | undefined" }, { "name": "selectability", "attribute": "selectability", "description": "The selection mode. Default to 'single' if context menus available, 'undefined' otherwise.", "type": "DataGridSelectability | undefined" }, { "name": "isDataSelectable", "attribute": "isDataSelectable", "description": "Whether data of a given row is selectable.", "type": "((data: TData) => boolean) | undefined" }, { "name": "selectedData", "attribute": "selectedData", "description": "The selected data.", "type": "TData[]", "default": "\"new Array<TData>()\"" }, { "name": "selectOnClick", "attribute": "selectOnClick", "description": "Whether the row should be selected on click.", "type": "boolean", "default": "false" }, { "name": "selectionBehaviorOnDataChange", "attribute": "selectionBehaviorOnDataChange", "description": "The behavior of the selection when the data changes.", "type": "DataGridSelectionBehaviorOnDataChange", "default": "\"reset\"" }, { "name": "multipleDetails", "attribute": "multipleDetails", "description": "Whether multiple details can be opened at the same time.", "type": "boolean", "default": "false" }, { "name": "subDataGridDataSelector", "attribute": "subDataGridDataSelector", "description": "The key path of the sub data grid data.", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | undefined" }, { "name": "hasDataDetail", "attribute": "hasDataDetail", "description": "Whether the data has a detail.", "type": "((data: TData) => boolean) | undefined" }, { "name": "detailsOnClick", "attribute": "detailsOnClick", "description": "Whether the details should be opened on click.", "type": "boolean", "default": "false" }, { "name": "primaryContextMenuItemOnDoubleClick", "attribute": "primaryContextMenuItemOnDoubleClick", "description": "The primary context menu item on double click.", "type": "boolean", "default": "false" }, { "name": "editability", "attribute": "editability", "description": "The editability mode.", "type": "DataGridEditability", "default": "\"never\"" }, { "name": "getRowDetailsTemplate", "attribute": "getRowDetailsTemplate", "description": "A function which returns a template for the details of a given row.", "type": "((data: TData) => HTMLTemplateResult) | undefined" }, { "name": "getRowContextMenuTemplate", "attribute": "getRowContextMenuTemplate", "description": "A function which returns a template for the context menu of a given row.", "type": "((data: TData[]) => HTMLTemplateResult) | undefined" }, { "name": "sidePanelTab", "attribute": "sidePanelTab", "description": "The side panel tab.", "type": "DataGridSidePanelTab | undefined" }, { "name": "sidePanelHidden", "attribute": "sidePanelHidden", "description": "Whether the side panel should be hidden.", "type": "boolean", "default": "false" }, { "name": "hasAlternatingBackground", "attribute": "hasAlternatingBackground", "description": "Whether the rows should have alternating background.", "type": "LocalStorage<boolean>", "default": "\"new LocalStorage('DataGrid.HasAlternatingBackground', true)\"" }, { "name": "preventFabCollapse", "attribute": "preventFabCollapse", "description": "Whether the FAB should be prevented from collapsing.", "type": "boolean", "default": "false" }, { "name": "cellFontSize", "attribute": "cellFontSize", "description": "The font size of the cells relative to the default font size. Defaults", "type": "number", "default": "\"value\"" }, { "name": "rowHeight", "attribute": "rowHeight", "description": "The height of the rows in pixels. Defaults to", "type": "LocalStorage<number>", "default": "\"new LocalStorage<number>('DataGrid.RowHeight', 35)\"" }, { "name": "exportable", "attribute": "exportable", "description": "Whether the DataGrid is exportable. This will show an export button in the footer.", "type": "boolean", "default": "false" } ], "events": [ { "name": "dataChange", "type": "CustomEvent<TData[]>" }, { "name": "selectionChange", "type": "CustomEvent<TData[]>" }, { "name": "pageChange", "type": "CustomEvent<number>" }, { "name": "paginationChange", "type": "CustomEvent<DataGridPagination | undefined>" }, { "name": "columnsChange", "type": "CustomEvent<DataGridColumn<TData, unknown>[]>" }, { "name": "sidePanelOpen", "type": "CustomEvent<DataGridSidePanelTab>" }, { "name": "sidePanelClose", "type": "CustomEvent<void>" }, { "name": "sortingChange", "type": "CustomEvent<DataGridRankedSortDefinition<TData>[]>" }, { "name": "rowDetailsOpen", "type": "CustomEvent<DataGridRow<TData, TDetailsElement>>" }, { "name": "rowDetailsClose", "type": "CustomEvent<DataGridRow<TData, TDetailsElement>>" }, { "name": "rowClick", "type": "CustomEvent<DataGridRow<TData, TDetailsElement>>" }, { "name": "rowDoubleClick", "type": "CustomEvent<DataGridRow<TData, TDetailsElement>>" }, { "name": "rowMiddleClick", "type": "CustomEvent<DataGridRow<TData, TDetailsElement>>" }, { "name": "cellEdit", "type": "CustomEvent<DataGridCell<any, TData, TDetailsElement>>" }, { "name": "scroll", "type": "CustomEvent" } ], "slots": [ { "name": "", "description": "Use this slot only for declarative DataGrid APIs e.g. setting ColumnDefinitions via `mo-data-grid-columns` tag." }, { "name": "toolbar", "description": "The horizontal bar above DataGrid's contents." }, { "name": "toolbar-action", "description": "A slot for action icon-buttons in the toolbar which are displayed on the end." }, { "name": "filter", "description": "A vertical bar for elements which filter DataGrid's data. It is opened through an icon-button in the toolbar." }, { "name": "sum", "description": "A horizontal bar in the DataGrid's footer for showing sums. Calculated sums are also placed here by default." }, { "name": "settings", "description": "A vertical bar for elements which change DataGrid's settings. It is pre-filled with columns' settings and can be opened through an icon-button in the toolbar." }, { "name": "fab", "description": "A wrapper at the bottom right edge, floating right above the footer, expecting Floating Action Button to be placed in." }, { "name": "error-no-content", "description": "A slot for displaying an error message when no data is available." } ], "cssProperties": [ { "name": "--mo-data-grid-min-visible-rows", "description": "The minimum number of visible rows. Default to 2.5." }, { "name": "--mo-data-grid-footer-background", "description": "The background of the footer." }, { "name": "--mo-data-grid-cell-padding", "description": "The inline padding of the cells. Default to 10px." }, { "name": "--mo-data-grid-column-sub-row-indentation", "description": "The indentation of the first column in the sub row. Default to 20px." } ] }, { "name": "mo-data-grid-cell", "path": ".\\packages\\DataGrid\\DataGridCell.ts", "attributes": [ { "name": "value", "type": "TValue" }, { "name": "column", "type": "DataGridColumn<TData, TValue>" }, { "name": "row", "type": "DataGridRow<TData, TDetailsElement>" } ], "properties": [ { "name": "dataGrid", "type": "DataGrid<TData, any>" }, { "name": "data", "type": "TData" }, { "name": "dataSelector", "type": "object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never" }, { "name": "isEditing", "type": "boolean" }, { "name": "value", "attribute": "value", "type": "TValue" }, { "name": "column", "attribute": "column", "type": "DataGridColumn<TData, TValue>" }, { "name": "row", "attribute": "row", "type": "DataGridRow<TData, TDetailsElement>" } ] }, { "name": "mo-data-grid-column-header", "path": ".\\packages\\DataGrid\\DataGridColumnHeader.ts", "attributes": [ { "name": "column", "type": "DataGridColumn<unknown, unknown>" }, { "name": "menuOpen", "type": "boolean", "default": "false" } ], "properties": [ { "name": "column", "attribute": "column", "type": "DataGridColumn<unknown, unknown>" }, { "name": "menuOpen", "attribute": "menuOpen", "type": "boolean", "default": "false" }, { "name": "resizeController", "type": "ResizeController<Promise<void>>", "default": "\"new ResizeController(this, {\\n\\t\\tcallback: async ([entry]) => {\\n\\t\\t\\t// It is necessary to defer the callback to avoid\\n\\t\\t\\t// this resize-observer triggering other resize-observers in a loop\\n\\t\\t\\tawait new Promise(r => requestIdleCallback(r))\\n\\t\\t\\tthis.column.widthInPixels = entry?.contentRect.width ?? 0\\n\\t\\t}\\n\\t})\"" }, { "name": "template", "description": "The template rendered into renderRoot. Invoked on each update to perform rendering tasks.", "type": "HTMLTemplateResult" } ] }, { "name": "mo-data-grid-footer", "path": ".\\packages\\DataGrid\\DataGridFooter.ts", "attributes": [ { "name": "dataGrid", "type": "DataGrid<TData, any>" }, { "name": "page", "type": "number", "default": "1" } ], "properties": [ { "name": "dataGrid", "attribute": "dataGrid", "type": "DataGrid<TData, any>" }, { "name": "page", "attribute": "page", "type": "number", "default": "1" } ] }, { "name": "mo-data-grid-header", "path": ".\\packages\\DataGrid\\DataGridHeader.ts", "attributes": [ { "name": "dataGrid", "type": "DataGrid<TData, any>" }, { "name": "overlayOpen", "type": "boolean", "default": "false" } ], "properties": [ { "name": "pageChange", "type": "EventDispatcher<number>" }, { "name": "modeSelectionChange", "type": "EventDispatcher<string>" }, { "name": "dataGrid", "attribute": "dataGrid", "type": "DataGrid<TData, any>" }, { "name": "overlayOpen", "attribute": "overlayOpen", "type": "boolean", "default": "false" } ] }, { "name": "mo-data-grid-header-separator", "path": ".\\packages\\DataGrid\\DataGridHeaderSeparator.ts", "attributes": [ { "name": "dataGrid", "type": "DataGrid<unknown, undefined>" }, { "name": "column", "type": "DataGridColumn<unknown, unknown>" } ], "properties": [ { "name": "dataGrid", "attribute": "dataGrid", "type": "DataGrid<unknown, undefined>" }, { "name": "column", "attribute": "column", "type": "DataGridColumn<unknown, unknown>" } ] }, { "name": "mo-data-grid-primary-context-menu-item", "path": ".\\packages\\DataGrid\\DataGridPrimaryContextMenuItem.ts", "attributes": [ { "name": "open", "type": "boolean", "default": "false" }, { "name": "disabled", "description": "Whether the list item is disabled", "type": "boolean", "default": "false" }, { "name": "icon", "description": "Icon to be displayed in the list item", "type": "MaterialIcon | undefined" }, { "name": "preventClickOnSpace", "description": "Whether the list item should prevent click on space", "type": "boolean", "default": "false" } ], "properties": [ { "name": "open", "attribute": "open", "type": "boolean", "default": "false" }, { "name": "subMenu", "type": "Menu" }, { "name": "slotController", "type": "SlotController", "default": "\"new SlotController(this)\"" }, { "name": "role", "type": "\"menuitem\"", "default": "\"menuitem\"" }, { "name": "tabIndex", "type": "number", "default": "0" }, { "name": "disabled", "attribute": "disabled", "description": "Whether the list item is disabled", "type": "boolean", "default": "false" }, { "name": "icon", "attribute": "icon", "description": "Icon to be displayed in the list item", "type": "MaterialIcon | undefined" }, { "name": "preventClickOnSpace", "attribute": "preventClickOnSpace", "description": "Whether the list item should prevent click on space", "type": "boolean", "default": "false" } ], "slots": [ { "name": "submenu" }, { "name": "", "description": "Default slot for content" } ] }, { "name": "mo-data-grid-side-panel", "path": ".\\packages\\DataGrid\\DataGridSidePanel.ts", "attributes": [ { "name": "dataGrid", "type": "DataGrid<TData, any>" }, { "name": "tab", "type": "DataGridSidePanelTab | undefined" } ], "properties": [ { "name": "dataGrid", "attribute": "dataGrid", "type": "DataGrid<TData, any>" }, { "name": "tab", "attribute": "tab", "type": "DataGridSidePanelTab | undefined" } ] }, { "name": "mo-data-grid-column-boolean", "path": ".\\packages\\DataGrid\\columns\\DataGridColumnBoolean.ts", "attributes": [ { "name": "trueIcon", "description": "Icon to show for true values", "type": "MaterialIcon", "default": "\"done\"" }, { "name": "falseIcon", "description": "Icon to show for false values", "type": "MaterialIcon", "default": "\"clear\"" }, { "name": "trueIconColor", "description": "Color of the true icon", "type": "string", "default": "\"var(--mo-color-accent)\"" }, { "name": "falseIconColor", "description": "Color of the false icon", "type": "string", "default": "\"var(--mo-color-gray)\"" }, { "name": "dataGrid", "type": "DataGrid<TData, any> | undefined" }, { "name": "width", "description": "The width of the column", "type": "string", "default": "\"max-content\"" }, { "name": "hidden", "description": "Whether the column is hidden. The column can be made visible by the user in the settings panel if available.", "type": "boolean", "default": "false" }, { "name": "heading", "description": "The heading of the column", "type": "string", "default": "\"\"" }, { "name": "textAlign", "description": "The text alignment of the column", "type": "DataGridColumnAlignment", "default": "\"start\"" }, { "name": "description", "description": "The description of the column. It will be displayed as a tooltip on the heading.", "type": "string | undefined" }, { "name": "dataSelector", "description": "The data selector of the column", "type": "object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never" }, { "name": "sortDataSelector", "description": "The data selector of the column", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | undefined" }, { "name": "nonSortable", "description": "Whether the column is sortable", "type": "boolean", "default": "false" }, { "name": "nonEditable", "description": "Whether the column is editable", "type": "boolean | Predicate<TData>", "default": "false" }, { "name": "sticky", "description": "The sticky position of the column, either 'start', 'end', or 'both'", "type": "DataGridColumnSticky | undefined" } ], "properties": [ { "name": "trueIcon", "attribute": "trueIcon", "description": "Icon to show for true values", "type": "MaterialIcon", "default": "\"done\"" }, { "name": "falseIcon", "attribute": "falseIcon", "description": "Icon to show for false values", "type": "MaterialIcon", "default": "\"clear\"" }, { "name": "trueIconColor", "attribute": "trueIconColor", "description": "Color of the true icon", "type": "string", "default": "\"var(--mo-color-accent)\"" }, { "name": "falseIconColor", "attribute": "falseIconColor", "description": "Color of the false icon", "type": "string", "default": "\"var(--mo-color-gray)\"" }, { "name": "dataGrid", "attribute": "dataGrid", "type": "DataGrid<TData, any> | undefined" }, { "name": "column", "type": "DataGridColumn<TData, TValue>" }, { "name": "width", "attribute": "width", "description": "The width of the column", "type": "string", "default": "\"max-content\"" }, { "name": "hidden", "attribute": "hidden", "description": "Whether the column is hidden. The column can be made visible by the user in the settings panel if available.", "type": "boolean", "default": "false" }, { "name": "heading", "attribute": "heading", "description": "The heading of the column", "type": "string", "default": "\"\"" }, { "name": "textAlign", "attribute": "textAlign", "description": "The text alignment of the column", "type": "DataGridColumnAlignment", "default": "\"start\"" }, { "name": "description", "attribute": "description", "description": "The description of the column. It will be displayed as a tooltip on the heading.", "type": "string | undefined" }, { "name": "dataSelector", "attribute": "dataSelector", "description": "The data selector of the column", "type": "object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never" }, { "name": "sortDataSelector", "attribute": "sortDataSelector", "description": "The data selector of the column", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | undefined" }, { "name": "nonSortable", "attribute": "nonSortable", "description": "Whether the column is sortable", "type": "boolean", "default": "false" }, { "name": "nonEditable", "attribute": "nonEditable", "description": "Whether the column is editable", "type": "boolean | Predicate<TData>", "default": "false" }, { "name": "sticky", "attribute": "sticky", "description": "The sticky position of the column, either 'start', 'end', or 'both'", "type": "DataGridColumnSticky | undefined" } ] }, { "name": "mo-data-grid-column-deletion", "path": ".\\packages\\DataGrid\\columns\\DataGridColumnDeletion.ts", "attributes": [ { "name": "prevent", "description": "Prevents the deletion button from being displayed", "type": "boolean", "default": "false" }, { "name": "icon", "description": "The icon to display. Defaults to 'delete'", "type": "MaterialIcon", "default": "\"delete\"" }, { "name": "tooltip", "description": "The tooltip to display. Defaults to 'Delete position'", "type": "string | undefined" }, { "name": "dataGrid", "type": "DataGrid<TData, any> | undefined" }, { "name": "width", "description": "The width of the column", "type": "string", "default": "\"max-content\"" }, { "name": "hidden", "description": "Whether the column is hidden. The column can be made visible by the user in the settings panel if available.", "type": "boolean", "default": "false" }, { "name": "heading", "description": "The heading of the column", "type": "string", "default": "\"\"" }, { "name": "textAlign", "description": "The text alignment of the column", "type": "DataGridColumnAlignment", "default": "\"start\"" }, { "name": "description", "description": "The description of the column. It will be displayed as a tooltip on the heading.", "type": "string | undefined" }, { "name": "dataSelector", "description": "The data selector of the column", "type": "object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never" }, { "name": "sortDataSelector", "description": "The data selector of the column", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | undefined" }, { "name": "nonSortable", "description": "Whether the column is sortable", "type": "boolean", "default": "true" }, { "name": "nonEditable", "description": "Whether the column is editable", "type": "boolean", "default": "true" }, { "name": "sticky", "description": "The sticky position of the column, either 'start', 'end', or 'both'", "type": "DataGridColumnSticky | undefined" } ], "properties": [ { "name": "delete", "type": "EventDispatcher<TData>" }, { "name": "getContentTemplate", "type": "(_: never, data?: TData | undefined) => HTMLTemplateResult", "default": "\"(_: never, data?: TData) => this.prevent ? html.nothing : html`\\r\\n\\t\\t<mo-icon-button icon=${this.icon}\\r\\n\\t\\t\\t${tooltip(this.tooltip ?? t('Delete position'))}\\r\\n\\t\\t\\t${style({ color: 'var(--mo-color-gray)', height: '40px', display: 'flex' })}\\r\\n\\t\\t\\t@click=${() => !data ? void 0 : this.delete.dispatch(data)}\\r\\n\\t\\t></mo-icon-button>\\r\\n\\t`\"" }, { "name": "getEditContentTemplate", "type": "undefined", "default": "\"undefined\"" }, { "name": "prevent", "attribute": "prevent", "description": "Prevents the deletion button from being displayed", "type": "boolean", "default": "false" }, { "name": "icon", "attribute": "icon", "description": "The icon to display. Defaults to 'delete'", "type": "MaterialIcon", "default": "\"delete\"" }, { "name": "tooltip", "attribute": "tooltip", "description": "The tooltip to display. Defaults to 'Delete position'", "type": "string | undefined" }, { "name": "dataGrid", "attribute": "dataGrid", "type": "DataGrid<TData, any> | undefined" }, { "name": "column", "type": "DataGridColumn<TData, TValue>" }, { "name": "width", "attribute": "width", "description": "The width of the column", "type": "string", "default": "\"max-content\"" }, { "name": "hidden", "attribute": "hidden", "description": "Whether the column is hidden. The column can be made visible by the user in the settings panel if available.", "type": "boolean", "default": "false" }, { "name": "heading", "attribute": "heading", "description": "The heading of the column", "type": "string", "default": "\"\"" }, { "name": "textAlign", "attribute": "textAlign", "description": "The text alignment of the column", "type": "DataGridColumnAlignment", "default": "\"start\"" }, { "name": "description", "attribute": "description", "description": "The description of the column. It will be displayed as a tooltip on the heading.", "type": "string | undefined" }, { "name": "dataSelector", "attribute": "dataSelector", "description": "The data selector of the column", "type": "object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never" }, { "name": "sortDataSelector", "attribute": "sortDataSelector", "description": "The data selector of the column", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | undefined" }, { "name": "nonSortable", "attribute": "nonSortable", "description": "Whether the column is sortable", "type": "boolean", "default": "true" }, { "name": "nonEditable", "attribute": "nonEditable", "description": "Whether the column is editable", "type": "boolean", "default": "true" }, { "name": "sticky", "attribute": "sticky", "description": "The sticky position of the column, either 'start', 'end', or 'both'", "type": "DataGridColumnSticky | undefined" } ], "events": [ { "name": "delete", "type": "CustomEvent<TData>" } ] }, { "name": "mo-data-grid-column-image", "path": ".\\packages\\DataGrid\\columns\\DataGridColumnImage.ts", "attributes": [ { "name": "tooltipSelector", "description": "The data selector of the column to use as a tooltip. If a function is provided, it will be called with the data as an argument.", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | ((data: TData) => string | undefined) | undefined" }, { "name": "dataGrid", "type": "DataGrid<TData, any> | undefined" }, { "name": "width", "description": "The width of the column", "type": "string", "default": "\"max-content\"" }, { "name": "hidden", "description": "Whether the column is hidden. The column can be made visible by the user in the settings panel if available.", "type": "boolean", "default": "false" }, { "name": "heading", "description": "The heading of the column", "type": "string", "default": "\"\"" }, { "name": "textAlign", "description": "The text alignment of the column", "type": "DataGridColumnAlignment", "default": "\"start\"" }, { "name": "description", "description": "The description of the column. It will be displayed as a tooltip on the heading.", "type": "string | undefined" }, { "name": "dataSelector", "description": "The data selector of the column", "type": "object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never" }, { "name": "sortDataSelector", "description": "The data selector of the column", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | undefined" }, { "name": "nonSortable", "description": "Whether the column is sortable", "type": "boolean", "default": "true" }, { "name": "nonEditable", "description": "Whether the column is editable", "type": "boolean", "default": "true" }, { "name": "sticky", "description": "The sticky position of the column, either 'start', 'end', or 'both'", "type": "DataGridColumnSticky | undefined" } ], "properties": [ { "name": "getEditContentTemplate", "type": "undefined", "default": "\"undefined\"" }, { "name": "tooltipSelector", "attribute": "tooltipSelector", "description": "The data selector of the column to use as a tooltip. If a function is provided, it will be called with the data as an argument.", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | ((data: TData) => string | undefined) | undefined" }, { "name": "dataGrid", "attribute": "dataGrid", "type": "DataGrid<TData, any> | undefined" }, { "name": "column", "type": "DataGridColumn<TData, TValue>" }, { "name": "width", "attribute": "width", "description": "The width of the column", "type": "string", "default": "\"max-content\"" }, { "name": "hidden", "attribute": "hidden", "description": "Whether the column is hidden. The column can be made visible by the user in the settings panel if available.", "type": "boolean", "default": "false" }, { "name": "heading", "attribute": "heading", "description": "The heading of the column", "type": "string", "default": "\"\"" }, { "name": "textAlign", "attribute": "textAlign", "description": "The text alignment of the column", "type": "DataGridColumnAlignment", "default": "\"start\"" }, { "name": "description", "attribute": "description", "description": "The description of the column. It will be displayed as a tooltip on the heading.", "type": "string | undefined" }, { "name": "dataSelector", "attribute": "dataSelector", "description": "The data selector of the column", "type": "object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never" }, { "name": "sortDataSelector", "attribute": "sortDataSelector", "description": "The data selector of the column", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | undefined" }, { "name": "nonSortable", "attribute": "nonSortable", "description": "Whether the column is sortable", "type": "boolean", "default": "true" }, { "name": "nonEditable", "attribute": "nonEditable", "description": "Whether the column is editable", "type": "boolean", "default": "true" }, { "name": "sticky", "attribute": "sticky", "description": "The sticky position of the column, either 'start', 'end', or 'both'", "type": "DataGridColumnSticky | undefined" } ] }, { "name": "mo-data-grid-column-text", "path": ".\\packages\\DataGrid\\columns\\DataGridColumnText.ts", "attributes": [ { "name": "dataGrid", "type": "DataGrid<TData, any> | undefined" }, { "name": "width", "description": "The width of the column", "type": "string", "default": "\"max-content\"" }, { "name": "hidden", "description": "Whether the column is hidden. The column can be made visible by the user in the settings panel if available.", "type": "boolean", "default": "false" }, { "name": "heading", "description": "The heading of the column", "type": "string", "default": "\"\"" }, { "name": "textAlign", "description": "The text alignment of the column", "type": "DataGridColumnAlignment", "default": "\"start\"" }, { "name": "description", "description": "The description of the column. It will be displayed as a tooltip on the heading.", "type": "string | undefined" }, { "name": "dataSelector", "description": "The data selector of the column", "type": "object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never" }, { "name": "sortDataSelector", "description": "The data selector of the column", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | undefined" }, { "name": "nonSortable", "description": "Whether the column is sortable", "type": "boolean", "default": "false" }, { "name": "nonEditable", "description": "Whether the column is editable", "type": "boolean | Predicate<TData>", "default": "false" }, { "name": "sticky", "description": "The sticky position of the column, either 'start', 'end', or 'both'", "type": "DataGridColumnSticky | undefined" } ], "properties": [ { "name": "dataGrid", "attribute": "dataGrid", "type": "DataGrid<TData, any> | undefined" }, { "name": "column", "type": "DataGridColumn<TData, TValue>" }, { "name": "width", "attribute": "width", "description": "The width of the column", "type": "string", "default": "\"max-content\"" }, { "name": "hidden", "attribute": "hidden", "description": "Whether the column is hidden. The column can be made visible by the user in the settings panel if available.", "type": "boolean", "default": "false" }, { "name": "heading", "attribute": "heading", "description": "The heading of the column", "type": "string", "default": "\"\"" }, { "name": "textAlign", "attribute": "textAlign", "description": "The text alignment of the column", "type": "DataGridColumnAlignment", "default": "\"start\"" }, { "name": "description", "attribute": "description", "description": "The description of the column. It will be displayed as a tooltip on the heading.", "type": "string | undefined" }, { "name": "dataSelector", "attribute": "dataSelector", "description": "The data selector of the column", "type": "object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never" }, { "name": "sortDataSelector", "attribute": "sortDataSelector", "description": "The data selector of the column", "type": "(object extends Required<TData> ? string : TData extends readonly any[] ? Extract<keyof TData, `${number}`> | Extract<keyof TData, string> | SubKeyPathOf<...> : TData extends object ? Extract<...> | SubKeyPathOf<...> : never) | undefined" }, { "name": "nonSortable", "attribute": "nonSortable", "description": "Whether the column is sortable", "type": "boolean", "default": "false" }, { "name": "nonEditable", "attribute": "nonEditable", "description": "Whether the column is editable", "type": "boolean | Predicate<TData>", "default": "false" }, { "name": "sticky", "attribute": "sticky", "description": "The sticky position of the column, either 'start', 'end', or 'both'", "type": "DataGridColumnSticky | undefined" } ] }, { "name": "mo-data-grid-column-date", "path": ".\\packages\\DataGrid\\columns\\date-time\\DataGridColumnDate.ts", "attributes": [ { "name": "formatOptions", "description": "Options to pass to Date.prototype.format()", "type": "DateTimeFormatOptions | undefined" }, { "name": "pickerHidden", "description": "Hides the date/time picker", "type": "boolean", "default": "false" }, { "name": "dataGrid", "type": "DataGrid<TData, any> | undefined" }, { "name": "width", "description": "The width of the column", "type": "string", "default": "\"max-content\"" }, { "name": "hidden", "description": "Whether the column is hidden. The column can be made visible by the user in the settings panel if available.", "type": "boolean", "default": "false" }, { "name": "heading", "description": "The heading of the column", "type": "string", "default": "\"\"" }, { "name": "textAlign", "description":