@xh/hoist 83.1.0 → 84.0.1

package/build/types/core/persist/provider/ViewManagerProvider.d.ts

@@ -1,5 +1,12 @@
 import { PersistenceProvider, PersistenceProviderConfig } from '../PersistenceProvider';
 import type { ViewManagerModel } from '@xh/hoist/cmp/viewmanager/ViewManagerModel';
+/**
+ * PersistenceProvider that delegates state storage to a ViewManagerModel, enabling components
+ * to persist their state as part of user-managed named views.
+ *
+ * @see ViewManagerModel
+ * @see PersistenceProvider
+ */
 export declare class ViewManagerProvider<S> extends PersistenceProvider<S> {
     readonly viewManagerModel: ViewManagerModel;
     constructor(cfg: PersistenceProviderConfig<S>);

package/build/types/data/Store.d.ts

@@ -3,6 +3,20 @@ import { HoistBase, PlainObject, Some } from '@xh/hoist/core';
 import { Field, FieldSpec, Filter, FilterBindTarget, FilterLike, FilterValueSource, StoreRecord, StoreRecordId, StoreRecordOrId, StoreValidationMessagesMap, StoreValidationResultsMap, ValidationResult } from '@xh/hoist/data';
 import { StoreValidator } from '@xh/hoist/data/impl/StoreValidator';
 import { RecordSet } from './impl/RecordSet';
+/**
+ * Configuration for a {@link Store}. At minimum, provide `fields` (or let them be inferred
+ * from GridModel columns). Data can be supplied at construction via `data`, or loaded later
+ * via `Store.loadData()`.
+ *
+ * Can also be passed inline as the `store` config on {@link GridConfig}, where it will be
+ * used to construct a Store automatically.
+ *
+ * See the data package README (`data/README.md`) for tree data, filtering, validation, and
+ * performance tuning guidance.
+ *
+ * @see Store
+ * @see FieldSpec
+ */
 export interface StoreConfig {
     /** Field names, configs, or instances. */
     fields?: Array<string | FieldSpec | Field>;
@@ -135,7 +149,27 @@ export interface ChildRawData {
 }
 export type StoreRecordIdSpec = string | ((data: PlainObject) => StoreRecordId);
 /**
- * A managed and observable set of local, in-memory Records.
+ * A managed, observable collection of in-memory {@link StoreRecord}s - the core data container
+ * in Hoist. Used directly by applications and as the data source for {@link GridModel},
+ * {@link DataViewModel}, and other data-bound components.
+ *
+ * Stores provide:
+ * - Observable record collections with filtering via composable {@link Filter} objects
+ * - Hierarchical/tree data with parent-child navigation
+ * - Local modification tracking (add/modify/remove) with commit/revert
+ * - Record reuse across data reloads to preserve grid row state
+ * - Pluggable validation via {@link Field} rules
+ *
+ * Data is loaded via `loadData()` (full replacement) or `updateData()` (transactional). Fields
+ * can be defined explicitly or inferred from GridModel columns. `Store.defaults` provides
+ * app-wide configuration.
+ *
+ * See the data package README (`data/README.md`) for full documentation including tree data,
+ * filtering patterns, validation, and common pitfalls.
+ *
+ * @see StoreConfig
+ * @see StoreRecord
+ * @see Field
  */
 export declare class Store extends HoistBase implements FilterBindTarget, FilterValueSource, GridFilterBindTarget {
     /** App-level defaults for Store. Instance config takes precedence. */

package/build/types/data/StoreSelectionModel.d.ts

@@ -1,14 +1,30 @@
 import { HoistModel } from '@xh/hoist/core';
 import { Store } from './Store';
 import { StoreRecord, StoreRecordId, StoreRecordOrId } from './StoreRecord';
+/**
+ * Configuration for a {@link StoreSelectionModel}. Typically passed via the `selModel` config
+ * on {@link GridConfig} rather than constructed directly.
+ *
+ * @see StoreSelectionModel
+ */
 export interface StoreSelectionConfig {
     store?: Store;
     mode?: 'single' | 'multiple' | 'disabled';
+    /** @internal */
     xhImpl?: boolean;
 }
 /**
- * Model for managing store selections.
- * Typically accessed from a GridModel to observe/control Grid selection.
+ * Model for managing record selection within a {@link Store}. Supports `single`, `multiple`,
+ * and `disabled` modes.
+ *
+ * Typically accessed via `gridModel.selModel` rather than created directly - configure via
+ * the `selModel` property on {@link GridConfig}.
+ *
+ * Key observables for reacting to selection state: `selectedRecord` / `selectedRecords`
+ * (reactive to both identity and data changes), `selectedId` / `selectedIds` (identity only),
+ * `isEmpty`, `count`. Use `select()` and `clear()` for programmatic control.
+ *
+ * @see StoreSelectionConfig
  */
 export declare class StoreSelectionModel extends HoistModel {
     readonly store: Store;

package/build/types/data/cube/Cube.d.ts

@@ -9,6 +9,16 @@ import { BaseRow } from './row/BaseRow';
 import { BucketRow } from './row/BucketRow';
 import { View } from './View';
 import { ViewRowData } from './ViewRowData';
+/**
+ * Configuration for a {@link Cube}. Provide `fields` (including at least one dimension
+ * and one or more measures with aggregators) and load data via `data` or
+ * `Cube.loadDataAsync()`.
+ *
+ * See the Cube package README (`data/cube/README.md`) for aggregator options and usage patterns.
+ *
+ * @see Cube
+ * @see CubeFieldSpec
+ */
 export interface CubeConfig {
     fields: CubeField[] | CubeFieldSpec[];
     /** Default configs applied to all `CubeField`s constructed internally by this Cube. */
@@ -64,13 +74,23 @@ export type OmitFn = (row: AggregateRow | BucketRow) => boolean;
  */
 export type BucketSpecFn = (rows: BaseRow[]) => BucketSpec;
 /**
- * A data store that supports grouping, aggregating, and filtering data on multiple dimensions.
+ * Client-side OLAP-style data structure for multi-dimensional grouping and aggregation.
+ *
+ * A Cube wraps a flat {@link Store} of leaf-level records and supports creating {@link View}s
+ * via structured {@link Query} objects. Each View filters, groups, and aggregates the source
+ * data into a hierarchical result for use in tree grids, treemaps, and other visualizations.
+ *
+ * Fields are defined as {@link CubeField}s - each marked as either a dimension (groupable)
+ * or a measure with an {@link Aggregator} (e.g. SUM, AVG, MIN, MAX). Views can be transient
+ * (run a query once) or connected for efficient, auto-updating results as source data changes.
+ *
+ * See the Cube package README (`data/cube/README.md`) for full documentation including
+ * aggregator options, querying patterns, and View integration with Store/GridModel.
  *
- * This object is a wrapper around a "flat" Store containing leaf-level facts. It supports creating
- * Views on that data via structured Queries that can filter, group, and aggregate the flat source
- * data and produce a hierarchical result ready for use in (e.g.) tree grids and maps. Views can
- * be transiently created to run a Query once, on demand, or can be retained to provide efficient,
- * auto-updating results in response to updates to the underlying data.
+ * @see CubeConfig
+ * @see CubeField
+ * @see View
+ * @see Query
  */
 export declare class Cube extends HoistBase {
     static RECORD_ID_DELIMITER: string;

package/build/types/data/cube/Query.d.ts

@@ -3,6 +3,16 @@ import { Cube } from './Cube';
 import { CubeField } from './CubeField';
 /**
  * Queries determine what data is extracted, grouped, and aggregated from a {@link Cube}.
+ * Passed via the `query` property of {@link ViewConfig} when creating a View.
+ *
+ * Key options beyond `dimensions` and `filter`: `includeRoot` adds a grand-total row,
+ * `includeLeaves` exposes source records as tree children, and `provideLeaves` makes them
+ * accessible programmatically without rendering in the tree.
+ *
+ * See the Cube package README (`data/cube/README.md#querying-with-views`) for query patterns.
+ *
+ * @see Cube
+ * @see View
  */
 export interface QueryConfig {
     /**

package/build/types/data/cube/View.d.ts

@@ -5,6 +5,15 @@ import { ViewRowData } from '@xh/hoist/data/cube/ViewRowData';
 import { AggregationContext } from './aggregate/AggregationContext';
 import { BaseRow } from './row/BaseRow';
 import { LeafRow } from './row/LeafRow';
+/**
+ * Configuration for a {@link View} - a query result from a {@link Cube} that can optionally
+ * stay connected for live updates. Create via {@link Cube.createView}.
+ *
+ * See the Cube package README (`data/cube/README.md`) for query patterns.
+ *
+ * @see View
+ * @see QueryConfig
+ */
 export interface ViewConfig {
     /** Query to be used to construct this view. */
     query: Query;
@@ -31,8 +40,18 @@ export interface DimensionValue {
     values: Set<any>;
 }
 /**
- * Primary interface for consuming grouped and aggregated data from the cube.
- * Applications should create via the {@link Cube.createView} factory.
+ * Primary interface for consuming grouped and aggregated data from a {@link Cube}.
+ * Created via {@link Cube.createView} with a {@link QueryConfig} and optional connected
+ * stores. Views can be transient (run once) or connected for auto-updating results.
+ *
+ * Use `updateQuery()` to change dimensions, filters, or options dynamically.
+ *
+ * See the Cube package README (`data/cube/README.md`) for query patterns and examples
+ * of grand totals, leaf drill-down, and store integration.
+ *
+ * @see ViewConfig
+ * @see QueryConfig
+ * @see Cube
  */
 export declare class View extends HoistBase implements FilterBindTarget, FilterValueSource, GridFilterBindTarget {
     static isView(obj: unknown): obj is View;

package/build/types/data/cube/aggregate/Aggregator.d.ts

@@ -2,6 +2,19 @@ import { AggregationContext } from './AggregationContext';
 import { BaseRow } from '../row/BaseRow';
 import { LeafRow } from '../row/LeafRow';
 import { RowUpdate } from '../row/RowUpdate';
+/**
+ * Abstract base class for Cube field aggregation functions.
+ *
+ * Subclasses implement {@link aggregate} to compute a summary value for a set of rows, and
+ * may optionally override {@link replace} to efficiently update the aggregation when a single
+ * child row changes (the default re-aggregates from scratch).
+ *
+ * Standard implementations are provided for common operations: sum, average, min, max,
+ * unique, count, and null. Custom aggregators can extend this class for application-specific
+ * aggregation logic.
+ *
+ * @see CubeField.aggregator
+ */
 export declare abstract class Aggregator {
     /**
      * Does this aggregator depend only on leaf nodes contained by the node being aggregated?

package/build/types/data/cube/aggregate/AverageAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Averages numeric values across all leaf rows, skipping nulls. */
 export declare class AverageAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): number;
 }

package/build/types/data/cube/aggregate/AverageStrictAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Averages numeric values, returning null if any leaf value is null. */
 export declare class AverageStrictAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): number;
     replace(rows: any, currAgg: any, update: any, context: any): any;

package/build/types/data/cube/aggregate/ChildCountAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Returns the count of direct child rows. */
 export declare class ChildCountAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): any;
     replace(rows: any, currAgg: any, update: any, context: any): any;

package/build/types/data/cube/aggregate/LeafCountAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Returns the count of all leaf (non-aggregate) descendant rows. */
 export declare class LeafCountAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): number;
     replace(rows: any, currAgg: any, update: any, context: any): any;

package/build/types/data/cube/aggregate/MaxAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Returns the maximum value across rows, skipping nulls. */
 export declare class MaxAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): any;
     replace(rows: any, currAgg: any, update: any, context: any): any;

package/build/types/data/cube/aggregate/MinAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Returns the minimum value across rows, skipping nulls. */
 export declare class MinAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): any;
     replace(rows: any, currAgg: any, update: any, context: any): any;

package/build/types/data/cube/aggregate/NullAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Always returns null. Useful for fields that should not be aggregated. */
 export declare class NullAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): any;
 }

package/build/types/data/cube/aggregate/SingleAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Returns the value if there is exactly one row, otherwise null. */
 export declare class SingleAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): any;
 }

package/build/types/data/cube/aggregate/SumAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Sums numeric values, skipping nulls. */
 export declare class SumAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): any;
     replace(rows: any, currAgg: any, update: any, context: any): any;

package/build/types/data/cube/aggregate/SumStrictAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Sums numeric values, returning null if any value is null. */
 export declare class SumStrictAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): any;
     replace(rows: any, currAgg: any, update: any, context: any): any;

package/build/types/data/cube/aggregate/UniqueAggregator.d.ts

@@ -1,4 +1,5 @@
 import { Aggregator } from './Aggregator';
+/** Returns the value if all rows share the same value, otherwise null. */
 export declare class UniqueAggregator extends Aggregator {
     aggregate(rows: any, fieldName: any): any;
     replace(rows: any, currAgg: any, update: any, context: any): any;

package/build/types/data/filter/BaseFilterFieldSpec.d.ts

@@ -1,6 +1,15 @@
 import { HoistBase } from '@xh/hoist/core';
 import { Field, FieldType, FilterValueSource } from '@xh/hoist/data';
 import { FieldFilterOperator } from './Types';
+/**
+ * Base configuration for field-level filtering options - defines available operators, value
+ * enumeration, and display metadata. Not used directly by applications; extended by
+ * {@link GridFilterFieldSpecConfig} (for column-header filters via {@link GridFilterModelConfig})
+ * and {@link FilterChooserFieldSpecConfig} (for {@link FilterChooserModel}).
+ *
+ * @see GridFilterFieldSpec
+ * @see FilterChooserFieldSpec
+ */
 export interface BaseFilterFieldSpecConfig {
     /** Identifying field name to filter on. */
     field: string;

package/build/types/data/filter/Types.d.ts

@@ -3,6 +3,10 @@ import type { Filter } from './Filter';
 import type { StoreRecord, Field, FieldType } from '../';
 export type FilterLike = Filter | FilterSpec | FilterTestFn | FilterLike[];
 export type FilterSpec = FieldFilterSpec | FunctionFilterSpec | CompoundFilterSpec;
+/**
+ * Plain-object form of a {@link FieldFilter} - a single field/operator/value condition.
+ * Can be passed anywhere a {@link FilterLike} is accepted.
+ */
 export interface FieldFilterSpec {
     /** Name of Field to filter or Field instance. */
     field: string | Field;
@@ -13,6 +17,10 @@ export interface FieldFilterSpec {
     valueType?: FieldType;
 }
 export type FieldFilterOperator = '=' | '!=' | '>' | '>=' | '<' | '<=' | 'like' | 'not like' | 'begins' | 'not begins' | 'ends' | 'not ends' | 'includes' | 'excludes';
+/**
+ * Plain-object form of a {@link CompoundFilter} - a group of filters joined by AND/OR.
+ * Can be passed anywhere a {@link FilterLike} is accepted.
+ */
 export interface CompoundFilterSpec {
     /** Collection of Filters or configs to create. */
     filters: FilterLike[];
@@ -20,6 +28,10 @@ export interface CompoundFilterSpec {
     op?: CompoundFilterOperator;
 }
 export type CompoundFilterOperator = 'AND' | 'OR' | 'and' | 'or';
+/**
+ * Plain-object form of a {@link FunctionFilter} - a custom function-based filter.
+ * Can be passed anywhere a {@link FilterLike} is accepted.
+ */
 export interface FunctionFilterSpec {
     /** Key used to identify this FunctionFilter.*/
     key: string;

package/build/types/desktop/cmp/button/AppMenuButton.d.ts

@@ -40,5 +40,10 @@ export interface AppMenuButtonProps extends ButtonProps {
     renderWithUserProfile?: boolean | RenderWithUserProfileCustomFn;
 }
 type RenderWithUserProfileCustomFn = (user: HoistUser) => ReactNode;
+/**
+ * Application-level menu button rendered in the AppBar. Provides a dropdown menu with standard
+ * items for About, Admin, Feedback, Options, Theme, Impersonation, Changelog, and Logout.
+ * Individual items can be hidden via props, and custom items added via `extraItems`.
+ */
 export declare const AppMenuButton: import("react").FC<AppMenuButtonProps>, appMenuButton: import("@xh/hoist/core").ElementFactory<AppMenuButtonProps>;
 export {};

package/build/types/desktop/cmp/button/Button.d.ts

@@ -19,10 +19,14 @@ export interface ButtonProps<M extends HoistModel = null> extends HoistProps<M>,
     /** Alias for title. */
     tooltip?: string;
 }
+export interface ButtonDefaults {
+    minimal?: boolean;
+    outlined?: boolean;
+}
 /**
  * Wrapper around Blueprint's Button component. Defaults to the `minimal` style for reduced chrome
  * and adds layout support for top-level sizing and margin/padding props.
  *
  * Relays all other props supported by Blueprint's button.
  */
-export declare const Button: import("react").FC<ButtonProps<null>>, button: import("@xh/hoist/core").ElementFactory<ButtonProps<null>>;
+export declare const Button: any, button: import("@xh/hoist/core").ElementFactory<ButtonProps<null>>;

package/build/types/desktop/cmp/dash/canvas/DashCanvasModel.d.ts

@@ -2,6 +2,15 @@ import type { LayoutItem } from 'react-grid-layout';
 import { Persistable, PersistableState } from '@xh/hoist/core';
 import { DashCanvasViewModel, DashCanvasViewSpec, DashConfig, DashViewState, DashModel } from '../';
 import '@xh/hoist/desktop/register';
+/**
+ * Configuration for a {@link DashCanvasModel} - a grid-based dashboard layout with
+ * drag-and-drop positioning and resizing of views.
+ *
+ * See the dash package README (`desktop/cmp/dash/README.md`) for architecture and usage.
+ *
+ * @see DashCanvasModel
+ * @see DashCanvasViewSpec
+ */
 export interface DashCanvasConfig extends DashConfig<DashCanvasViewSpec, DashCanvasItemState> {
     /**
      * Total number of columns (x coordinates for views correspond with column numbers).
@@ -14,7 +23,7 @@ export interface DashCanvasConfig extends DashConfig<DashCanvasViewSpec, DashCan
      */
     rowHeight?: number;
     /**
-     * Compaction strategy for condensing empty space. Use `'wrap'` with caution — it only
+     * Compaction strategy for condensing empty space. Use `'wrap'` with caution - it only
      * works well if all items are 1 row high. Default `'vertical'`.
      */
     compact?: boolean | 'vertical' | 'horizontal' | 'wrap';
@@ -113,7 +122,7 @@ export declare class DashCanvasModel extends DashModel<DashCanvasViewSpec, DashC
      * Add a view to the canvas.
      * @param specId - ID of the DashCanvasViewSpec to add.
      * @param opts - optional title, state, dimensions, and position. `position` accepts a view
-     *      ID in addition to the enumerated values — the new view will take that view's position.
+     *      ID in addition to the enumerated values - the new view will take that view's position.
      */
     addView(specId: string, opts?: {
         title?: string;
@@ -139,7 +148,7 @@ export declare class DashCanvasModel extends DashModel<DashCanvasViewSpec, DashC
     ensureViewVisible(id: string): void;
     /**
      * Handle a completed drop from react-grid-layout. Creates the new view from `draggedInView`
-     * and places it at the drop location. Called by the DashCanvas component — not typically
+     * and places it at the drop location. Called by the DashCanvas component - not typically
      * called directly by application code.
      */
     onDrop(rglLayout: LayoutItem[], layoutItem: LayoutItem, evt: Event): void;

package/build/types/desktop/cmp/dash/container/DashContainerModel.d.ts

@@ -3,6 +3,15 @@ import { DashContainerViewModel } from '@xh/hoist/desktop/cmp/dash/container/Das
 import { GoldenLayout } from '@xh/hoist/kit/golden-layout';
 import { DashConfig, DashModel } from '../';
 import { DashContainerViewSpec } from './DashContainerViewSpec';
+/**
+ * Configuration for a {@link DashContainerModel} - a tab-and-stack based dashboard layout
+ * with draggable, resizable views powered by GoldenLayout.
+ *
+ * See the dash package README (`desktop/cmp/dash/README.md`) for architecture and usage.
+ *
+ * @see DashContainerModel
+ * @see DashViewSpec
+ */
 export interface DashContainerConfig extends DashConfig<DashContainerViewSpec, DashContainerViewState> {
     /** Strategy for rendering DashContainerViews. Can also be set per-view in `viewSpecs`*/
     renderMode?: RenderMode;

package/build/types/desktop/cmp/dock/DockViewModel.d.ts

@@ -3,6 +3,13 @@ import { ModalSupportModel } from '@xh/hoist/desktop/cmp/modalsupport/ModalSuppo
 import '@xh/hoist/desktop/register';
 import { ReactElement } from 'react';
 import { DockContainerModel } from './DockContainerModel';
+/**
+ * Configuration for a {@link DockViewModel} - a dockable view within a
+ * {@link DockContainerModel}.
+ *
+ * @see DockViewModel
+ * @see DockContainerModel
+ */
 export interface DockViewConfig {
     /** Unique identifier for this DockViewModel. */
     id: string;

package/build/types/desktop/cmp/filechooser/FileChooserModel.d.ts

@@ -1,6 +1,14 @@
 import { GridModel } from '@xh/hoist/cmp/grid';
 import { HoistModel } from '@xh/hoist/core';
 import '@xh/hoist/desktop/register';
+/**
+ * Model managing file selection state for a FileChooser component.
+ *
+ * Tracks selected files, supports add/remove/clear operations, and de-duplicates by filename.
+ * Includes a managed GridModel to display selected files with name and size columns.
+ *
+ * @see FileChooser
+ */
 export declare class FileChooserModel extends HoistModel {
     files: File[];
     lastRejectedCount: number;

package/build/types/desktop/cmp/grid/editors/BooleanEditor.d.ts

@@ -12,4 +12,5 @@ export interface BooleanEditorProps extends EditorProps<CheckboxProps> {
      */
     quickToggle?: boolean;
 }
+/** Checkbox-based inline cell editor for boolean values in a Grid. */
 export declare const BooleanEditor: import("react").FC<BooleanEditorProps>, booleanEditor: import("@xh/hoist/core").ElementFactory<BooleanEditorProps>;

package/build/types/desktop/cmp/grid/editors/DateEditor.d.ts

@@ -3,4 +3,5 @@ import '@xh/hoist/desktop/register';
 import { EditorProps } from './EditorProps';
 import './Editors.scss';
 export type DateEditorProps = EditorProps<DateInputProps>;
+/** Date picker inline cell editor with calendar popover rendered within the grid viewport. */
 export declare const DateEditor: import("react").FC<DateEditorProps>, dateEditor: import("@xh/hoist/core").ElementFactory<DateEditorProps>;

package/build/types/desktop/cmp/grid/editors/NumberEditor.d.ts

@@ -3,4 +3,5 @@ import '@xh/hoist/desktop/register';
 import { EditorProps } from './EditorProps';
 import './Editors.scss';
 export type NumberEditorProps = EditorProps<NumberInputProps>;
+/** Numeric input inline cell editor with guards to reject non-numeric key presses. */
 export declare const NumberEditor: import("react").FC<NumberEditorProps>, numberEditor: import("@xh/hoist/core").ElementFactory<NumberEditorProps>;

package/build/types/desktop/cmp/grid/editors/SelectEditor.d.ts

@@ -3,4 +3,5 @@ import '@xh/hoist/desktop/register';
 import { EditorProps } from './EditorProps';
 import './Editors.scss';
 export type SelectEditorProps = EditorProps<SelectProps>;
+/** Dropdown select inline cell editor for choice fields in a Grid. */
 export declare const SelectEditor: import("react").FC<SelectEditorProps>, selectEditor: import("@xh/hoist/core").ElementFactory<SelectEditorProps>;

package/build/types/desktop/cmp/grid/editors/TextAreaEditor.d.ts

@@ -3,4 +3,5 @@ import { TextAreaProps } from '../../input';
 import { EditorProps } from './EditorProps';
 import './Editors.scss';
 export type TextAreaEditorProps = EditorProps<TextAreaProps>;
+/** Multi-line text input inline cell editor for long-form string values in a Grid. */
 export declare const TextAreaEditor: import("react").FC<TextAreaEditorProps>, textAreaEditor: import("@xh/hoist/core").ElementFactory<TextAreaEditorProps>;

package/build/types/desktop/cmp/grid/editors/TextEditor.d.ts

@@ -3,4 +3,5 @@ import '@xh/hoist/desktop/register';
 import { EditorProps } from './EditorProps';
 import './Editors.scss';
 export type TextEditorProps = EditorProps<TextInputProps>;
+/** Text input inline cell editor for string values in a Grid. */
 export declare const TextEditor: import("react").FC<TextEditorProps>, textEditor: import("@xh/hoist/core").ElementFactory<TextEditorProps>;

package/build/types/desktop/cmp/input/Picker.d.ts

@@ -101,7 +101,7 @@ export interface PickerProps extends HoistProps, HoistInputProps, LayoutProps, S
      * Receives an array of selected option objects, the full list of option objects, and the
      * configured `displayNoun` (if any). Return a ReactNode for display. Overrides the default
      * button text, including any `displayNoun`-based summary. Does not replace the button
-     * itself — use `buttonProps` to customize the button's icon, intent, or other properties.
+     * itself - use `buttonProps` to customize the button's icon, intent, or other properties.
      */
     buttonTextRenderer?: (selectedOpts: SelectOption[], allOpts: SelectOption[], displayNoun: string) => ReactNode;
     /**

package/build/types/desktop/cmp/input/SegmentedControl.d.ts

@@ -23,9 +23,9 @@ export interface SegmentedControlProps extends HoistProps, HoistInputProps {
      * with value/label/icon/disabled properties, or a primitive value used as both
      * the value and the display label.
      */
-    options: (SegmentedControlOption | OptionPrimitive)[];
+    options: Array<SegmentedControlOption | SegmentedControlNullOption | OptionPrimitive>;
     /**
-     * True to render with an outlined style — a border around the control tray
+     * True to render with an outlined style - a border around the control tray
      * with no inner background fill. Border color follows the current intent.
      */
     outlined?: boolean;
@@ -40,6 +40,20 @@ export interface SegmentedControlOption {
     /** True to disable this individual option. */
     disabled?: boolean;
 }
+/**
+ * Variant of SegmentedControlOption for representing a null/"no value" selection.
+ * Label is required to force use case to override default js 'null' toString rendering.
+ */
+export interface SegmentedControlNullOption {
+    /** Null value for this option. */
+    value: null;
+    /** Display label - required for null options. */
+    label: string;
+    /** Icon element, displayed before the label. */
+    icon?: ReactElement;
+    /** True to disable this individual option. */
+    disabled?: boolean;
+}
 /**
  * An input for selecting a single value from a small set of mutually exclusive options,
  * rendered as a group of toggle buttons with clear visual indication of the active

package/build/types/desktop/cmp/leftrightchooser/LeftRightChooserModel.d.ts

@@ -2,6 +2,12 @@ import { GridModel, GridSorterLike } from '@xh/hoist/cmp/grid';
 import { HoistModel, HSide, Some } from '@xh/hoist/core';
 import '@xh/hoist/desktop/register';
 import { FilterTestFn, StoreRecord } from '@xh/hoist/data';
+/**
+ * Configuration for a {@link LeftRightChooserModel} - a dual-list control for moving items
+ * between "available" (left) and "selected" (right) collections.
+ *
+ * @see LeftRightChooserModel
+ */
 export interface LeftRightChooserConfig {
     data?: LeftRightChooserItem[];
     /** True to globally prevent the user from moving items between sides. */
@@ -24,6 +30,7 @@ export interface LeftRightChooserConfig {
     rightGroupingEnabled?: boolean;
     rightGroupingExpanded?: boolean;
     rightEmptyText?: string;
+    /** @internal */
     xhImpl?: boolean;
 }
 /** Data record object for a LeftRightChooser value item. */

package/build/types/desktop/cmp/modalsupport/ModalSupportModel.d.ts

@@ -1,14 +1,40 @@
 import { HoistModel } from '@xh/hoist/core';
 import '@xh/hoist/desktop/register';
+/**
+ * Configuration for a {@link ModalSupportModel}. Passed via the `modalSupport` config on
+ * {@link PanelConfig} - set to `true` for defaults or provide a config object to customize
+ * the dialog dimensions and behavior.
+ *
+ * @see ModalSupportModel
+ * @see PanelModel
+ */
 export interface ModalSupportConfig {
+    /** Width of the modal dialog. Default `'90vw'`. */
     width?: string | number;
+    /** Height of the modal dialog. Default `'90vh'`. */
     height?: string | number;
+    /** True to start in modal (popped-out) state. Default `false`. */
     defaultModal?: boolean;
+    /** True to allow closing the modal by clicking outside it. Default `true`. */
     canOutsideClickClose?: boolean;
 }
 /**
- * Core Model for a ModalSupport component.
- * This model will place its component's child in 1 of 2 managed DOM nodes (either modal or inline)
+ * Model enabling a {@link Panel}'s content to toggle between inline and modal (floating
+ * dialog) display while preserving all component state.
+ *
+ * Uses a React portal to move a single persistent DOM host node between an inline container
+ * and a Blueprint Dialog. Because the child component is rendered into the host node once
+ * and the node is physically relocated (not re-mounted), all React component state, MobX
+ * subscriptions, and DOM state (scroll position, focus, ag-Grid state, etc.) are preserved
+ * across toggles.
+ *
+ * This is the key advantage over the alternative of mounting a second copy of a component
+ * inside a separate dialog - ModalSupport guarantees zero state loss on toggle.
+ *
+ * Not created directly by applications - enable via `modalSupport` on {@link PanelConfig}.
+ *
+ * @see ModalSupportConfig
+ * @see PanelModel
  */
 export declare class ModalSupportModel extends HoistModel {
     xhImpl: boolean;