@stonecrop/stonecrop 0.4.12 → 0.4.14

package/dist/src/index.d.ts

@@ -1,5 +1,5 @@
 export type { BaseSchema, FieldsetSchema, FormSchema, SchemaTypes, TableSchema } from '@stonecrop/aform';
-export type { CellContext, TableColumn, TableConfig, TableRow } from '@stonecrop/atable';
+export type { CellContext, GanttOptions, TableColumn, TableConfig, TableRow } from '@stonecrop/atable';
 import { type StonecropReturn, useStonecrop } from './composable';
 import DoctypeMeta from './doctype';
 import Registry from './registry';

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACxG,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAExF,OAAO,EAAE,KAAK,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AACjE,OAAO,WAAW,MAAM,WAAW,CAAA;AACnC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,SAAS,MAAM,WAAW,CAAA;AACjC,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAEvF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACxG,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAEtG,OAAO,EAAE,KAAK,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AACjE,OAAO,WAAW,MAAM,WAAW,CAAA;AACnC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,SAAS,MAAM,WAAW,CAAA;AACjC,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAEvF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,CAAA"}

package/dist/stonecrop.d.ts

@@ -39,13 +39,22 @@ export declare type BaseSchema = {
  * 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;
     };
-};
+}
 
 /**
  * Doctype Meta class
@@ -166,6 +175,31 @@ export declare type FormSchema = BaseSchema & {
     mask?: string;
 };
 
+/**
+ * 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;
+}
+
 /**
  * Immutable Doctype type for Stonecrop instances
  * @public
@@ -474,19 +508,67 @@ export declare type StonecropReturn = {
  * 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;
-    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.
@@ -503,16 +585,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
@@ -521,22 +650,43 @@ 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 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;
     /**
-     * When a table is being viewed as a Gantt chart, this colour would be applied to the row's gantt bar, if one exists.
+     * The options to use when rendering the row as a Gantt table.
      */
-    gantt_color?: string;
-};
+    gantt?: GanttOptions;
+}
 
 /**
  * Schema structure for defining tables inside AForm

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/stonecrop",
-  "version": "0.4.12",
+  "version": "0.4.14",
   "description": "schema helper",
   "license": "MIT",
   "type": "module",
@@ -52,9 +52,9 @@
     "eslint-plugin-vue": "^9.11.1",
     "typescript": "~5.6.3",
     "vite": "^6.1.1",
-    "@stonecrop/aform": "0.4.12",
-    "@stonecrop/atable": "0.4.12",
-    "stonecrop-rig": "0.2.22"
+    "@stonecrop/aform": "0.4.14",
+    "stonecrop-rig": "0.2.22",
+    "@stonecrop/atable": "0.4.14"
   },
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -1,5 +1,5 @@
 export type { BaseSchema, FieldsetSchema, FormSchema, SchemaTypes, TableSchema } from '@stonecrop/aform'
-export type { CellContext, TableColumn, TableConfig, TableRow } from '@stonecrop/atable'
+export type { CellContext, GanttOptions, TableColumn, TableConfig, TableRow } from '@stonecrop/atable'
 
 import { type StonecropReturn, useStonecrop } from './composable'
 import DoctypeMeta from './doctype'