@stonecrop/atable 0.4.32 → 0.4.34

package/README.md

@@ -19,6 +19,50 @@
 
 </details>
 
+## Tree View Configuration
+
+ATable supports tree views with configurable default expansion states for hierarchical data. Use the `defaultTreeExpansion` option in your table configuration to control initial expansion behavior:
+
+```js
+// Default behavior (no defaultTreeExpansion specified) - all nodes expanded
+const config = {
+  view: 'tree'
+}
+
+// Only show root nodes (fully collapsed)
+const config = {
+  view: 'tree',
+  defaultTreeExpansion: 'root'
+}
+
+// Show only nodes with gantt data and their paths (branch mode)
+const config = {
+  view: 'tree',
+  defaultTreeExpansion: 'branch'
+}
+
+// Show all nodes (fully expanded) - same as default
+const config = {
+  view: 'tree',
+  defaultTreeExpansion: 'leaf'
+}
+```
+
+**Expansion Modes:**
+- `root`: Only top-level nodes are visible (fully collapsed)
+- `branch`: Shows the minimal tree to display all nodes with gantt data. Only expands nodes that lead to gantt-enabled nodes, stops expanding at gantt nodes that have no gantt descendants
+- `leaf`: All nodes are visible (fully expanded)
+- `undefined` (default): All nodes start expanded (same as 'leaf' mode)
+
+**Example Usage:**
+```vue
+<ATable
+  v-model:rows="treeData"
+  v-model:columns="columns"
+  :config="{ view: 'tree', defaultTreeExpansion: 'branch' }"
+/>
+```
+
 ## Column API
 
 The primary API for ATable is the column object.

package/dist/atable.d.ts

@@ -34,6 +34,30 @@ export { ATableLoadingBar }
 
 export { ATableModal }
 
+/**
+ * Base table configuration properties shared across all view types.
+ * @public
+ */
+export declare interface BaseTableConfig {
+    /**
+     * Control whether the table should be allowed to use the full width of its container.
+     *
+     * @defaultValue false
+     */
+    fullWidth?: boolean;
+}
+
+/**
+ * Table configuration for basic view types (uncounted, list, list-expansion).
+ * @public
+ */
+export declare interface BasicTableConfig extends BaseTableConfig {
+    /**
+     * The type of view to display the table in.
+     */
+    view?: 'uncounted' | 'list' | 'list-expansion';
+}
+
 /**
  * Table cell context definition.
  * @public
@@ -191,13 +215,37 @@ colspan?: number | undefined;
 originalIndex?: number | undefined;
 }[]>;
 config: Ref<    {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }, TableConfig | {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }>;
 connectionHandles: Ref<    {
 id: string;
@@ -426,13 +474,37 @@ colspan?: number | undefined;
 originalIndex?: number | undefined;
 }[]>;
 config: Ref<    {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }, TableConfig | {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }>;
 connectionHandles: Ref<    {
 id: string;
@@ -661,13 +733,37 @@ colspan?: number | undefined;
 originalIndex?: number | undefined;
 }[]>;
 config: Ref<    {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }, TableConfig | {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }>;
 connectionHandles: Ref<    {
 id: string;
@@ -961,6 +1057,24 @@ export declare interface GanttOptions {
     colspan?: number;
 }
 
+/**
+ * Table configuration for gantt view types.
+ * @public
+ */
+export declare interface GanttTableConfig extends BaseTableConfig {
+    /**
+     * The type of view to display the table in.
+     */
+    view: 'gantt';
+    /**
+     * Control whether dependency graph connections should be enabled for Gantt views.
+     * When false, connection handles and dependency lines will be hidden.
+     *
+     * @defaultValue true
+     */
+    dependencyGraph?: boolean;
+}
+
 /**
  * Install all ATable components
  * @param app - Vue app instance
@@ -1103,34 +1217,10 @@ export declare interface TableColumn {
 }
 
 /**
- * Table configuration definition.
+ * Table configuration definition using discriminated unions for type safety.
  * @public
  */
-export declare interface TableConfig {
-    /**
-     * The type of view to display the table in. Possible values:
-     * - `uncounted` - row numbers are not displayed in the table
-     * - `list` - row numbers are displayed in the table
-     * - `list-expansion` - carets are displayed in the number column that expand/collapse the row inline
-     * - `tree` - carets are displayed in the number column that expand/collapse grouped rows
-     * - `gantt` - view that allows specific rows to be displayed with Gantt functionality
-     * - `tree-gantt` - similar to `gantt`, but allows for tree functionality as well
-     */
-    view?: 'uncounted' | 'list' | 'list-expansion' | 'tree' | 'gantt' | 'tree-gantt';
-    /**
-     * Control whether the table should be allowed to use the full width of its container.
-     *
-     * @defaultValue false
-     */
-    fullWidth?: boolean;
-    /**
-     * Control whether dependency graph connections should be enabled for Gantt views.
-     * When false, connection handles and dependency lines will be hidden.
-     *
-     * @defaultValue true
-     */
-    dependencyGraph?: boolean;
-}
+export declare type TableConfig = BasicTableConfig | TreeTableConfig | GanttTableConfig | TreeGanttTableConfig;
 
 /**
  * Table display definition.
@@ -1316,4 +1406,51 @@ export declare interface TableRow {
     gantt?: GanttOptions;
 }
 
+/**
+ * Table configuration for tree-gantt view types.
+ * @public
+ */
+export declare interface TreeGanttTableConfig extends BaseTableConfig {
+    /**
+     * The type of view to display the table in.
+     */
+    view: 'tree-gantt';
+    /**
+     * Default expansion state for tree views. Possible values:
+     * - `root` - Only top-level nodes are visible (fully collapsed)
+     * - `branch` - Shows minimal tree to display all gantt nodes. Expands only the necessary paths to gantt nodes, stops at gantt nodes with no gantt descendants
+     * - `leaf` - All nodes are visible (fully expanded)
+     *
+     * @defaultValue undefined (default behavior is 'leaf' mode)
+     */
+    defaultTreeExpansion?: 'root' | 'branch' | 'leaf';
+    /**
+     * Control whether dependency graph connections should be enabled for Gantt views.
+     * When false, connection handles and dependency lines will be hidden.
+     *
+     * @defaultValue true
+     */
+    dependencyGraph?: boolean;
+}
+
+/**
+ * Table configuration for tree view types.
+ * @public
+ */
+export declare interface TreeTableConfig extends BaseTableConfig {
+    /**
+     * The type of view to display the table in.
+     */
+    view: 'tree';
+    /**
+     * Default expansion state for tree views. Possible values:
+     * - `root` - Only top-level nodes are visible (fully collapsed)
+     * - `branch` - Shows minimal tree to display all gantt nodes. Expands only the necessary paths to gantt nodes, stops at gantt nodes with no gantt descendants
+     * - `leaf` - All nodes are visible (fully expanded)
+     *
+     * @defaultValue undefined (default behavior is 'leaf' mode)
+     */
+    defaultTreeExpansion?: 'root' | 'branch' | 'leaf';
+}
+
 export { }