@stonecrop/atable 0.4.11 → 0.4.13

package/dist/atable.d.ts

@@ -36,13 +36,22 @@ export { ATableModal }
  * Table cell context definition.
  * @public
  */
-export declare type CellContext = {
+export declare interface CellContext {
+    /**
+     * The row object for the current cell.
+     */
     row: TableRow;
+    /**
+     * The column object for the current cell.
+     */
     column: TableColumn;
+    /**
+     * The table object for the current cell.
+     */
     table: {
         [key: string]: any;
     };
-};
+}
 
 /**
  * Create a table store
@@ -69,17 +78,16 @@ label?: string | undefined;
 type?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
-color?: string | undefined;
-colspan?: number | undefined;
-ganttComponent?: string | undefined;
-isGantt?: boolean | undefined;
-originalIndex?: number | undefined;
 cellComponent?: string | undefined;
 cellComponentProps?: Record<string, any> | undefined;
 modalComponent?: (string | ((context: CellContext) => string)) | undefined;
 modalComponentExtraProps?: Record<string, any> | undefined;
 format?: (string | ((value: any, context: CellContext) => string)) | undefined;
 mask?: ((value: any) => any) | undefined;
+isGantt?: boolean | undefined;
+ganttComponent?: string | undefined;
+colspan?: number | undefined;
+originalIndex?: number | undefined;
 }[], TableColumn[] | {
 name: string;
 align?: CanvasTextAlign | undefined;
@@ -88,17 +96,16 @@ label?: string | undefined;
 type?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
-color?: string | undefined;
-colspan?: number | undefined;
-ganttComponent?: string | undefined;
-isGantt?: boolean | undefined;
-originalIndex?: number | undefined;
 cellComponent?: string | undefined;
 cellComponentProps?: Record<string, any> | undefined;
 modalComponent?: (string | ((context: CellContext) => string)) | undefined;
 modalComponentExtraProps?: Record<string, any> | undefined;
 format?: (string | ((value: any, context: CellContext) => string)) | undefined;
 mask?: ((value: any) => any) | undefined;
+isGantt?: boolean | undefined;
+ganttComponent?: string | undefined;
+colspan?: number | undefined;
+originalIndex?: number | undefined;
 }[]>;
 config: Ref<    {
 view?: ("uncounted" | "list" | "list-expansion" | "tree" | "gantt") | undefined;
@@ -108,59 +115,69 @@ view?: ("uncounted" | "list" | "list-expansion" | "tree" | "gantt") | undefined;
 fullWidth?: boolean | undefined;
 }>;
 display: Ref<    {
-childrenOpen?: boolean | undefined;
 expanded?: boolean | undefined;
-indent?: number | undefined;
+childrenOpen?: boolean | undefined;
 isParent?: boolean | undefined;
 isRoot?: boolean | undefined;
 open?: boolean | undefined;
+indent?: number | undefined;
 parent?: number | undefined;
 rowModified?: boolean | undefined;
 }[], TableDisplay[] | {
-childrenOpen?: boolean | undefined;
 expanded?: boolean | undefined;
-indent?: number | undefined;
+childrenOpen?: boolean | undefined;
 isParent?: boolean | undefined;
 isRoot?: boolean | undefined;
 open?: boolean | undefined;
+indent?: number | undefined;
 parent?: number | undefined;
 rowModified?: boolean | undefined;
 }[]>;
 modal: Ref<    {
-bottom?: number | undefined;
+visible?: boolean | undefined;
 cell?: (HTMLTableCellElement | null) | undefined;
-colIndex?: number | undefined;
-event?: string | undefined;
-height?: number | undefined;
-left?: number | undefined;
 parent?: HTMLElement | undefined;
+colIndex?: number | undefined;
 rowIndex?: number | undefined;
-visible?: boolean | undefined;
-width?: number | undefined;
 component?: string | undefined;
 componentProps?: Record<string, any> | undefined;
-}, TableModal | {
 bottom?: number | undefined;
-cell?: (HTMLTableCellElement | null) | undefined;
-colIndex?: number | undefined;
-event?: string | undefined;
 height?: number | undefined;
 left?: number | undefined;
+width?: number | undefined;
+}, TableModal | {
+visible?: boolean | undefined;
+cell?: (HTMLTableCellElement | null) | undefined;
 parent?: HTMLElement | undefined;
+colIndex?: number | undefined;
 rowIndex?: number | undefined;
-visible?: boolean | undefined;
-width?: number | undefined;
 component?: string | undefined;
 componentProps?: Record<string, any> | undefined;
+bottom?: number | undefined;
+height?: number | undefined;
+left?: number | undefined;
+width?: number | undefined;
 }>;
 rows: Ref<    {
 [x: string]: any;
 indent?: number | undefined;
 parent?: number | undefined;
+gantt?: {
+color?: string | undefined;
+startIndex?: number | undefined;
+endIndex?: number | undefined;
+colspan?: number | undefined;
+} | undefined;
 }[], TableRow[] | {
 [x: string]: any;
 indent?: number | undefined;
 parent?: number | undefined;
+gantt?: {
+color?: string | undefined;
+startIndex?: number | undefined;
+endIndex?: number | undefined;
+colspan?: number | undefined;
+} | undefined;
 }[]>;
 table: Ref<    {}, {}>;
 updates: Ref<Record<string, string>, Record<string, string>>;
@@ -174,10 +191,12 @@ getFormattedValue: (colIndex: number, rowIndex: number, value: any) => any;
 getHeaderCellStyle: (column: TableColumn) => CSSProperties;
 getIndent: (colIndex: number, indentLevel?: number) => string;
 getRowExpandSymbol: (rowIndex: number) => "" | "-" | "+";
+isRowGantt: (rowIndex: number) => boolean;
 isRowVisible: (rowIndex: number) => boolean | undefined;
 setCellData: (colIndex: number, rowIndex: number, value: any) => void;
 setCellText: (colIndex: number, rowIndex: number, value: string) => void;
 toggleRowExpand: (rowIndex: number) => void;
+updateGanttBar: (event: GanttDragEvent) => void;
 }, "columns" | "config" | "display" | "modal" | "rows" | "table" | "updates">, Pick<{
 columns: Ref<    {
 name: string;
@@ -187,17 +206,16 @@ label?: string | undefined;
 type?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
-color?: string | undefined;
-colspan?: number | undefined;
-ganttComponent?: string | undefined;
-isGantt?: boolean | undefined;
-originalIndex?: number | undefined;
 cellComponent?: string | undefined;
 cellComponentProps?: Record<string, any> | undefined;
 modalComponent?: (string | ((context: CellContext) => string)) | undefined;
 modalComponentExtraProps?: Record<string, any> | undefined;
 format?: (string | ((value: any, context: CellContext) => string)) | undefined;
 mask?: ((value: any) => any) | undefined;
+isGantt?: boolean | undefined;
+ganttComponent?: string | undefined;
+colspan?: number | undefined;
+originalIndex?: number | undefined;
 }[], TableColumn[] | {
 name: string;
 align?: CanvasTextAlign | undefined;
@@ -206,17 +224,16 @@ label?: string | undefined;
 type?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
-color?: string | undefined;
-colspan?: number | undefined;
-ganttComponent?: string | undefined;
-isGantt?: boolean | undefined;
-originalIndex?: number | undefined;
 cellComponent?: string | undefined;
 cellComponentProps?: Record<string, any> | undefined;
 modalComponent?: (string | ((context: CellContext) => string)) | undefined;
 modalComponentExtraProps?: Record<string, any> | undefined;
 format?: (string | ((value: any, context: CellContext) => string)) | undefined;
 mask?: ((value: any) => any) | undefined;
+isGantt?: boolean | undefined;
+ganttComponent?: string | undefined;
+colspan?: number | undefined;
+originalIndex?: number | undefined;
 }[]>;
 config: Ref<    {
 view?: ("uncounted" | "list" | "list-expansion" | "tree" | "gantt") | undefined;
@@ -226,59 +243,69 @@ view?: ("uncounted" | "list" | "list-expansion" | "tree" | "gantt") | undefined;
 fullWidth?: boolean | undefined;
 }>;
 display: Ref<    {
-childrenOpen?: boolean | undefined;
 expanded?: boolean | undefined;
-indent?: number | undefined;
+childrenOpen?: boolean | undefined;
 isParent?: boolean | undefined;
 isRoot?: boolean | undefined;
 open?: boolean | undefined;
+indent?: number | undefined;
 parent?: number | undefined;
 rowModified?: boolean | undefined;
 }[], TableDisplay[] | {
-childrenOpen?: boolean | undefined;
 expanded?: boolean | undefined;
-indent?: number | undefined;
+childrenOpen?: boolean | undefined;
 isParent?: boolean | undefined;
 isRoot?: boolean | undefined;
 open?: boolean | undefined;
+indent?: number | undefined;
 parent?: number | undefined;
 rowModified?: boolean | undefined;
 }[]>;
 modal: Ref<    {
-bottom?: number | undefined;
+visible?: boolean | undefined;
 cell?: (HTMLTableCellElement | null) | undefined;
-colIndex?: number | undefined;
-event?: string | undefined;
-height?: number | undefined;
-left?: number | undefined;
 parent?: HTMLElement | undefined;
+colIndex?: number | undefined;
 rowIndex?: number | undefined;
-visible?: boolean | undefined;
-width?: number | undefined;
 component?: string | undefined;
 componentProps?: Record<string, any> | undefined;
-}, TableModal | {
 bottom?: number | undefined;
-cell?: (HTMLTableCellElement | null) | undefined;
-colIndex?: number | undefined;
-event?: string | undefined;
 height?: number | undefined;
 left?: number | undefined;
+width?: number | undefined;
+}, TableModal | {
+visible?: boolean | undefined;
+cell?: (HTMLTableCellElement | null) | undefined;
 parent?: HTMLElement | undefined;
+colIndex?: number | undefined;
 rowIndex?: number | undefined;
-visible?: boolean | undefined;
-width?: number | undefined;
 component?: string | undefined;
 componentProps?: Record<string, any> | undefined;
+bottom?: number | undefined;
+height?: number | undefined;
+left?: number | undefined;
+width?: number | undefined;
 }>;
 rows: Ref<    {
 [x: string]: any;
 indent?: number | undefined;
 parent?: number | undefined;
+gantt?: {
+color?: string | undefined;
+startIndex?: number | undefined;
+endIndex?: number | undefined;
+colspan?: number | undefined;
+} | undefined;
 }[], TableRow[] | {
 [x: string]: any;
 indent?: number | undefined;
 parent?: number | undefined;
+gantt?: {
+color?: string | undefined;
+startIndex?: number | undefined;
+endIndex?: number | undefined;
+colspan?: number | undefined;
+} | undefined;
 }[]>;
 table: Ref<    {}, {}>;
 updates: Ref<Record<string, string>, Record<string, string>>;
@@ -292,10 +319,12 @@ getFormattedValue: (colIndex: number, rowIndex: number, value: any) => any;
 getHeaderCellStyle: (column: TableColumn) => CSSProperties;
 getIndent: (colIndex: number, indentLevel?: number) => string;
 getRowExpandSymbol: (rowIndex: number) => "" | "-" | "+";
+isRowGantt: (rowIndex: number) => boolean;
 isRowVisible: (rowIndex: number) => boolean | undefined;
 setCellData: (colIndex: number, rowIndex: number, value: any) => void;
 setCellText: (colIndex: number, rowIndex: number, value: string) => void;
 toggleRowExpand: (rowIndex: number) => void;
+updateGanttBar: (event: GanttDragEvent) => void;
 }, "hasPinnedColumns" | "numberedRowWidth" | "zeroColumn">, Pick<{
 columns: Ref<    {
 name: string;
@@ -305,17 +334,16 @@ label?: string | undefined;
 type?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
-color?: string | undefined;
-colspan?: number | undefined;
-ganttComponent?: string | undefined;
-isGantt?: boolean | undefined;
-originalIndex?: number | undefined;
 cellComponent?: string | undefined;
 cellComponentProps?: Record<string, any> | undefined;
 modalComponent?: (string | ((context: CellContext) => string)) | undefined;
 modalComponentExtraProps?: Record<string, any> | undefined;
 format?: (string | ((value: any, context: CellContext) => string)) | undefined;
 mask?: ((value: any) => any) | undefined;
+isGantt?: boolean | undefined;
+ganttComponent?: string | undefined;
+colspan?: number | undefined;
+originalIndex?: number | undefined;
 }[], TableColumn[] | {
 name: string;
 align?: CanvasTextAlign | undefined;
@@ -324,17 +352,16 @@ label?: string | undefined;
 type?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
-color?: string | undefined;
-colspan?: number | undefined;
-ganttComponent?: string | undefined;
-isGantt?: boolean | undefined;
-originalIndex?: number | undefined;
 cellComponent?: string | undefined;
 cellComponentProps?: Record<string, any> | undefined;
 modalComponent?: (string | ((context: CellContext) => string)) | undefined;
 modalComponentExtraProps?: Record<string, any> | undefined;
 format?: (string | ((value: any, context: CellContext) => string)) | undefined;
 mask?: ((value: any) => any) | undefined;
+isGantt?: boolean | undefined;
+ganttComponent?: string | undefined;
+colspan?: number | undefined;
+originalIndex?: number | undefined;
 }[]>;
 config: Ref<    {
 view?: ("uncounted" | "list" | "list-expansion" | "tree" | "gantt") | undefined;
@@ -344,59 +371,69 @@ view?: ("uncounted" | "list" | "list-expansion" | "tree" | "gantt") | undefined;
 fullWidth?: boolean | undefined;
 }>;
 display: Ref<    {
-childrenOpen?: boolean | undefined;
 expanded?: boolean | undefined;
-indent?: number | undefined;
+childrenOpen?: boolean | undefined;
 isParent?: boolean | undefined;
 isRoot?: boolean | undefined;
 open?: boolean | undefined;
+indent?: number | undefined;
 parent?: number | undefined;
 rowModified?: boolean | undefined;
 }[], TableDisplay[] | {
-childrenOpen?: boolean | undefined;
 expanded?: boolean | undefined;
-indent?: number | undefined;
+childrenOpen?: boolean | undefined;
 isParent?: boolean | undefined;
 isRoot?: boolean | undefined;
 open?: boolean | undefined;
+indent?: number | undefined;
 parent?: number | undefined;
 rowModified?: boolean | undefined;
 }[]>;
 modal: Ref<    {
-bottom?: number | undefined;
+visible?: boolean | undefined;
 cell?: (HTMLTableCellElement | null) | undefined;
-colIndex?: number | undefined;
-event?: string | undefined;
-height?: number | undefined;
-left?: number | undefined;
 parent?: HTMLElement | undefined;
+colIndex?: number | undefined;
 rowIndex?: number | undefined;
-visible?: boolean | undefined;
-width?: number | undefined;
 component?: string | undefined;
 componentProps?: Record<string, any> | undefined;
-}, TableModal | {
 bottom?: number | undefined;
-cell?: (HTMLTableCellElement | null) | undefined;
-colIndex?: number | undefined;
-event?: string | undefined;
 height?: number | undefined;
 left?: number | undefined;
+width?: number | undefined;
+}, TableModal | {
+visible?: boolean | undefined;
+cell?: (HTMLTableCellElement | null) | undefined;
 parent?: HTMLElement | undefined;
+colIndex?: number | undefined;
 rowIndex?: number | undefined;
-visible?: boolean | undefined;
-width?: number | undefined;
 component?: string | undefined;
 componentProps?: Record<string, any> | undefined;
+bottom?: number | undefined;
+height?: number | undefined;
+left?: number | undefined;
+width?: number | undefined;
 }>;
 rows: Ref<    {
 [x: string]: any;
 indent?: number | undefined;
 parent?: number | undefined;
+gantt?: {
+color?: string | undefined;
+startIndex?: number | undefined;
+endIndex?: number | undefined;
+colspan?: number | undefined;
+} | undefined;
 }[], TableRow[] | {
 [x: string]: any;
 indent?: number | undefined;
 parent?: number | undefined;
+gantt?: {
+color?: string | undefined;
+startIndex?: number | undefined;
+endIndex?: number | undefined;
+colspan?: number | undefined;
+} | undefined;
 }[]>;
 table: Ref<    {}, {}>;
 updates: Ref<Record<string, string>, Record<string, string>>;
@@ -410,11 +447,56 @@ getFormattedValue: (colIndex: number, rowIndex: number, value: any) => any;
 getHeaderCellStyle: (column: TableColumn) => CSSProperties;
 getIndent: (colIndex: number, indentLevel?: number) => string;
 getRowExpandSymbol: (rowIndex: number) => "" | "-" | "+";
+isRowGantt: (rowIndex: number) => boolean;
 isRowVisible: (rowIndex: number) => boolean | undefined;
 setCellData: (colIndex: number, rowIndex: number, value: any) => void;
 setCellText: (colIndex: number, rowIndex: number, value: string) => void;
 toggleRowExpand: (rowIndex: number) => void;
-}, "closeModal" | "getCellData" | "getCellDisplayValue" | "getFormattedValue" | "getHeaderCellStyle" | "getIndent" | "getRowExpandSymbol" | "isRowVisible" | "setCellData" | "setCellText" | "toggleRowExpand">>;
+updateGanttBar: (event: GanttDragEvent) => void;
+}, "closeModal" | "getCellData" | "getCellDisplayValue" | "getFormattedValue" | "getHeaderCellStyle" | "getIndent" | "getRowExpandSymbol" | "isRowGantt" | "isRowVisible" | "setCellData" | "setCellText" | "toggleRowExpand" | "updateGanttBar">>;
+
+/**
+ * Gantt table drag event definition.
+ * @public
+ */
+export declare type GanttDragEvent = {
+    rowIndex: number;
+    colIndex: number;
+    type: 'bar';
+    start: number;
+    end: number;
+} | {
+    rowIndex: number;
+    colIndex: number;
+    type: 'resize';
+    edge: 'start' | 'end';
+    value: number;
+};
+
+/**
+ * This interface defines the options for a row when it is being viewed as a Gantt chart.
+ * @public
+ */
+export declare interface GanttOptions {
+    /**
+     * The colour to be applied to the row's gantt bar.
+     */
+    color?: string;
+    /**
+     * The starting column index for the gantt bar.
+     */
+    startIndex?: number;
+    /**
+     * The ending column index for the gantt bar. If the endIndex and colspan are not provided,
+     * the bar will stretch to the end of the table.
+     */
+    endIndex?: number;
+    /**
+     * The length of the gantt bar. Useful when only the start index is provided. If the
+     * colspan and endIndex are not provided, the bar will stretch to the end of the table.
+     */
+    colspan?: number;
+}
 
 /**
  * Install all ATable components
@@ -427,20 +509,67 @@ export declare function install(app: App): void;
  * Table column definition.
  * @public
  */
-export declare type TableColumn = {
+export declare interface TableColumn {
+    /**
+     * The key of the column. This is used to identify the column in the table.
+     */
     name: string;
+    /**
+     * The alignment of the column. Possible values:
+     * - `left` - left aligned
+     * - `center` - center aligned
+     * - `right` - right aligned
+     * - `start` - aligned to the start of the column
+     * - `end` - aligned to the end of the column
+     *
+     * @defaultValue 'center'
+     */
     align?: CanvasTextAlign;
+    /**
+     * Control whether cells for the column is editable.
+     *
+     * @defaultValue false
+     */
     edit?: boolean;
+    /**
+     * The label of the column. This is displayed in the table header.
+     *
+     * @defaultValue If no label is provided, a character will be assigned alphabetically,
+     * starting from 'A' for the first column, 'B' for the second column, and so on.
+     */
     label?: string;
+    /**
+     * The data-type of the column. Possible values:
+     * - `Data` - the column contains text data
+     * - `Select` - the column contains a select input
+     * - `Date` - the column contains a date input
+     * - `component` - the column contains a custom component
+     *
+     * @beta
+     */
     type?: string;
+    /**
+     * The width of the column. This can be a number (in pixels) or a string (in CSS units).
+     *
+     * @defaultValue '40ch'
+     */
     width?: string;
+    /**
+     * Control whether the column should be pinned to the table.
+     *
+     * @defaultValue false
+     */
     pinned?: boolean;
-    color?: string;
-    colspan?: number;
-    ganttComponent?: string;
-    isGantt?: boolean;
-    originalIndex?: number;
+    /**
+     * The component to use to render the cell for the column. If not provided, the table will
+     * render the default `<td>` element.
+     */
     cellComponent?: string;
+    /**
+     * Additional properties to pass to the table's cell component.
+     *
+     * Only applicable if the `cellComponent` property is set for the column.
+     */
     cellComponentProps?: Record<string, any>;
     /**
      * The component to use for the modal. If a function is provided, it will be called with the cell context.
@@ -457,16 +586,63 @@ export declare type TableColumn = {
      * - `store` - the table data store
      */
     modalComponent?: string | ((context: CellContext) => string);
+    /**
+     * Additional properties to pass to the modal component.
+     *
+     * Only applicable if the `modalComponent` property is set for the column.
+     */
     modalComponentExtraProps?: Record<string, any>;
+    /**
+     * The format function to use to format the value of the cell. This can either be a normal or stringified
+     * function that takes the value and the cell context and returns a string.
+     */
     format?: string | ((value: any, context: CellContext) => string);
+    /**
+     * The masking function to use to apply an input mask to the cell. This will accept an input value and
+     * return the masked value.
+     */
     mask?: (value: any) => any;
-};
+    /**
+     * Whether the column is a Gantt column.
+     *
+     * Only applicable for Gantt tables.
+     *
+     * @defaultValue false
+     */
+    isGantt?: boolean;
+    /**
+     * The component to use to render the Gantt bar for the column.
+     *
+     * Only applicable for Gantt tables.
+     *
+     * @defaultValue 'AGanttCell'
+     */
+    ganttComponent?: string;
+    /**
+     * The colspan of the Gantt-bar for the column. This is used to determine how many columns
+     * the Gantt-bar should span.
+     *
+     * Only applicable for Gantt tables.
+     *
+     * @defaultValue The number of columns in the table, excluding any pinned columns.
+     */
+    colspan?: number;
+    /**
+     * The starting column index for the Gantt-bar, excluding any pinned columns. This is
+     * evaluated automatically while rendering the table.
+     *
+     * Only applicable for Gantt tables.
+     *
+     * @defaultValue 0
+     */
+    originalIndex?: number;
+}
 
 /**
  * Table configuration definition.
  * @public
  */
-export declare type TableConfig = {
+export declare interface TableConfig {
     /**
      * The type of view to display the table in. Possible values:
      * - `uncounted` - row numbers are not displayed in the table
@@ -475,62 +651,196 @@ export declare type TableConfig = {
      * - `tree` - carets are displayed in the number column that expand/collapse grouped rows
      */
     view?: 'uncounted' | 'list' | 'list-expansion' | 'tree' | 'gantt';
+    /**
+     * Control whether the table should be allowed to use the full width of its container.
+     *
+     * @defaultValue false
+     */
     fullWidth?: boolean;
-};
+}
 
 /**
  * Table display definition.
  * @public
  */
-export declare type TableDisplay = {
-    childrenOpen?: boolean;
+export declare interface TableDisplay {
+    /**
+     * Indicates whether a row node is expanded or collapsed.
+     *
+     * Only applicable for list-expansion views.
+     *
+     * @defaultValue false
+     */
     expanded?: boolean;
-    indent?: number;
+    /**
+     * Indicates whether a row node's child nodes are open or closed.
+     *
+     * Only applicable for tree views.
+     *
+     * @defaultValue false
+     */
+    childrenOpen?: boolean;
+    /**
+     * Indicates whether a row node is a parent node. This is evaluated automatically
+     * while rendering the table.
+     *
+     * Only applicable for tree views.
+     */
     isParent?: boolean;
+    /**
+     * Indicates whether a row node is a root node. This is evaluated automatically
+     * while rendering the table.
+     *
+     * Only applicable for tree views.
+     */
     isRoot?: boolean;
+    /**
+     * Indicates whether a row node is visible. This is evaluated automatically
+     * while rendering the table.
+     *
+     * Only applicable for tree views.
+     */
     open?: boolean;
+    /**
+     * The indentation level of the row node.
+     *
+     * Only applicable for tree and gantt views.
+     *
+     * @defaultValue 0
+     */
+    indent?: number;
+    /**
+     * The HTML parent element for the row node. This is evaluated automatically while rendering
+     * the table.
+     *
+     * Only applicable for tree and gantt views.
+     */
     parent?: number;
+    /**
+     * Indicates whether a row node has been modified. This is evaluated automatically when a cell
+     * is edited.
+     *
+     * @defaultValue false
+     */
     rowModified?: boolean;
-};
+}
 
 /**
  * Table modal definition.
  * @public
  */
-export declare type TableModal = {
-    bottom?: ReturnType<typeof useElementBounding>['bottom'];
+export declare interface TableModal {
+    /**
+     * Indicates whether the table modal is currently visible.
+     *
+     * @defaultValue false
+     */
+    visible?: boolean;
+    /**
+     * The HTML cell element that the modal is currently being displayed for. The field is unset
+     * when the modal is not being displayed.
+     */
     cell?: HTMLTableCellElement | null;
-    colIndex?: number;
-    event?: string;
-    height?: ReturnType<typeof useElementBounding>['height'];
-    left?: ReturnType<typeof useElementBounding>['left'];
+    /**
+     * The HTML parent element that the modal is currently being displayed for. The field is unset
+     * when the modal is not being displayed.
+     */
     parent?: HTMLElement;
+    /**
+     * The index of the column that the modal is currently being displayed for. The field is
+     * unset when the modal is not being displayed.
+     */
+    colIndex?: number;
+    /**
+     * The index of the row that the modal is currently being displayed for. The field is
+     * unset when the modal is not being displayed.
+     */
     rowIndex?: number;
-    visible?: boolean;
-    width?: ReturnType<typeof useElementBounding>['width'];
+    /**
+     * The component to use to render the modal. If not provided, the table will
+     * try to use the column's `modalComponent` property, if set. If that is not set,
+     * the table will not display a modal.
+     *
+     * @see {@link TableColumn.modalComponent}
+     */
     component?: string;
+    /**
+     * Additional properties to pass to the table's modal component.
+     */
     componentProps?: Record<string, any>;
-};
+    /**
+     * Reactive bottom value for the modal's bounding box. The field is unset when the modal
+     * is not being displayed.
+     */
+    bottom?: ReturnType<typeof useElementBounding>['bottom'];
+    /**
+     * Reactive height value for the modal's bounding box. The field is unset when the modal
+     * is not being displayed.
+     */
+    height?: ReturnType<typeof useElementBounding>['height'];
+    /**
+     * Reactive left value for the modal's bounding box. The field is unset when the modal
+     * is not being displayed.
+     */
+    left?: ReturnType<typeof useElementBounding>['left'];
+    /**
+     * Reactive width value for the modal's bounding box. The field is unset when the modal
+     * is not being displayed.
+     */
+    width?: ReturnType<typeof useElementBounding>['width'];
+}
 
 /**
  * Table modal component props definition.
  * @public
  */
-export declare type TableModalProps = {
+export declare interface TableModalProps {
+    /**
+     * Additional arbitrary properties that can be passed to the modal component.
+     */
     [key: string]: any;
+    /**
+     * The index of the column that the modal is currently being displayed for.
+     */
     colIndex: number;
+    /**
+     * The index of the row that the modal is currently being displayed for.
+     */
     rowIndex: number;
+    /**
+     * The store for managing the current table's state.
+     */
     store: ReturnType<typeof createTableStore>;
-};
+}
 
 /**
  * Table row definition.
  * @public
  */
-export declare type TableRow = {
+export declare interface TableRow {
+    /**
+     * Additional arbitrary properties that can be passed to the row object.
+     */
     [key: string]: any;
+    /**
+     * The indentation level of the row node.
+     *
+     * Only applicable for tree and gantt views.
+     *
+     * @defaultValue 0
+     */
     indent?: number;
+    /**
+     * The HTML parent element for the row node. This is evaluated automatically while rendering
+     * the table.
+     *
+     * Only applicable for tree and gantt views.
+     */
     parent?: number;
-};
+    /**
+     * The options to use when rendering the row as a Gantt table.
+     */
+    gantt?: GanttOptions;
+}
 
 export { }