@xh/hoist 57.0.0 → 57.0.2

package/build/types/desktop/cmp/dash/container/impl/DashContainerUtils.d.ts

@@ -0,0 +1,14 @@
+import { DashContainerViewSpec } from '../DashContainerViewSpec';
+/**
+ * Lookup the DashViewModel id of a rendered view
+ */
+export declare function getViewModelId(view: any): any;
+/**
+ * Convert the output from Golden Layouts into our serializable state
+ */
+export declare function convertGLToState(goldenLayout: any, dashContainerModel: any): any[];
+/**
+ * Convert our serializable state into GoldenLayout config
+ */
+export declare function convertStateToGL(state: any[], dashContainerModel: any): any;
+export declare function goldenLayoutConfig(spec: DashContainerViewSpec): any;

package/build/types/desktop/cmp/dash/container/impl/DashContainerView.d.ts

@@ -0,0 +1,12 @@
+import { DashViewModel } from '../../DashViewModel';
+/**
+ * Implementation component to show an item within a DashContainer.  This component
+ * is used by DashContainer's internal implementation to:
+ *
+ *   - Mount/unmount its contents according to `DashViewSpec.renderMode`.
+ *   - Track and trigger refreshes according to `DashViewSpec.refreshMode`.
+ *   - Stretch its contents using a flex layout.
+ *
+ * @internal
+ */
+export declare const dashContainerView: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<DashViewModel<any>>>;

package/build/types/desktop/cmp/dash/index.d.ts

@@ -0,0 +1,11 @@
+export * from './DashConfig';
+export * from './DashModel';
+export * from './DashViewModel';
+export * from './DashViewSpec';
+export * from './container/DashContainer';
+export * from './container/DashContainerModel';
+export * from './container/DashContainerViewSpec';
+export * from './canvas/DashCanvas';
+export * from './canvas/DashCanvasModel';
+export * from './canvas/DashCanvasViewModel';
+export * from './canvas/DashCanvasViewSpec';

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

@@ -0,0 +1,26 @@
+/// <reference types="react" />
+import { HoistProps } from '@xh/hoist/core';
+import '@xh/hoist/desktop/register';
+import { DockContainerModel } from './DockContainerModel';
+export interface DockContainerProps extends HoistProps<DockContainerModel> {
+    /** True to style docked headers with reduced padding and font-size. */
+    compactHeaders?: boolean;
+}
+/**
+ * DockContainer provides a user-friendly way to render multiple child components "docked" to its
+ * bottom edge. Each view is rendered with a configurable header and controls to allow the user to
+ * expand it, collapse it, or optionally "pop it out" into a modal dialog.
+ *
+ * This mirrors the behavior of the familiar Gmail "compose" window and is intended for similar
+ * use-cases such as detail panels and forms, where the user might wish to open multiple children
+ * in a non-modal and unobtrusive manner.
+ *
+ * Docked views are sized according to their content. It is recommended to provide the docked
+ * content with a fixed size.
+ *
+ * DockContainerModel configures all aspects of this container, including its views. See that class
+ * for more details.
+ *
+ * @see DockContainerModel
+ */
+export declare const DockContainer: import("react").FC<DockContainerProps>, dockContainer: import("@xh/hoist/core").ElementFactory<DockContainerProps>;

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

@@ -0,0 +1,33 @@
+import { HoistModel, RefreshMode, RenderMode } from '@xh/hoist/core';
+import '@xh/hoist/desktop/register';
+import { DockViewModel, DockViewConfig } from './DockViewModel';
+interface DockContainerConfig {
+    /** DockViewModel configs to be displayed. */
+    views?: DockViewConfig[];
+    /** Direction in which docked views build up as they are added to the container. */
+    direction?: DockViewDirection;
+    /** Strategy for rendering DockViews. Can also be set per-view via `DockViewModelConfig.renderMode` */
+    renderMode?: RenderMode;
+    /** Strategy for refreshing DockViews. Can also be set per-view via `DockViewModelConfig.refreshMode` */
+    refreshMode?: RefreshMode;
+}
+/**
+ * Model for a DockContainer, representing its contents.
+ *
+ * This object provides support for managing docked views, adding new views on the fly,
+ * and expanding / collapsing views programmatically.
+ */
+export declare class DockContainerModel extends HoistModel {
+    views: DockViewModel[];
+    direction: DockViewDirection;
+    renderMode: RenderMode;
+    refreshMode: RefreshMode;
+    constructor({ views, direction, renderMode, refreshMode }?: DockContainerConfig);
+    getView(id: string): DockViewModel;
+    addView(cfg: DockViewConfig): void;
+    removeView(id: string): void;
+    expandView(id: string): void;
+    collapseView(id: string): void;
+}
+type DockViewDirection = 'ltr' | 'rtl';
+export {};

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

@@ -0,0 +1,75 @@
+import { Content, Thunkable, HoistModel, RefreshContextModel, RefreshMode, RenderMode } from '@xh/hoist/core';
+import { ModalSupportModel } from '@xh/hoist/desktop/cmp/modalsupport/ModalSupportModel';
+import '@xh/hoist/desktop/register';
+import { ReactElement } from 'react';
+import { DockContainerModel } from './DockContainerModel';
+export interface DockViewConfig {
+    /** Unique identifier for this DockViewModel. */
+    id: string;
+    /** Parent DockContainerModel. Provided by the container when constructing the model - no need to specify manually. */
+    containerModel?: DockContainerModel;
+    /** Title text added to the header. */
+    title?: string;
+    /** An icon placed at the left-side of the header. */
+    icon?: ReactElement;
+    /** Content to be rendered by this DockView. */
+    content: Content;
+    /** Width in pixels. If not set, width will be determined by the content. */
+    width?: number;
+    /** Height in pixels. If not set, height will be determined by the content. */
+    height?: number;
+    /** Width of collapsed header in pixels. If not set, width will be determined by the length of the title. */
+    collapsedWidth?: number;
+    /** Strategy for rendering this DockView. If null, will default to its container's mode. */
+    renderMode?: RenderMode;
+    /** Strategy for refreshing this DockView. If null, will default to its container's mode. */
+    refreshMode?: RefreshMode;
+    /** true to exclude this DockView.  */
+    omit?: Thunkable<boolean>;
+    /** true (default) to initialise in dock, false to use Dialog. Respects allowDialog. */
+    docked?: boolean;
+    /** true to initialise collapsed, false (default) for expanded. */
+    collapsed?: boolean;
+    /** true (default) to allow removing from the dock entirely. */
+    allowClose?: boolean;
+    /** true (default) to allow popping out of the dock and displaying in a modal Dialog. */
+    allowDialog?: boolean;
+}
+/**
+ * Model for a DockView within a DockContainer. Specifies the actual content (child component)
+ * to be rendered within the view and manages that content's collapsed and docked state.
+ *
+ * This model is not typically created directly within applications. Instead, specify a
+ * configuration for it via the `DockContainerModel.views` constructor config or via
+ * the `DockContainerModel.addView()` method.
+ */
+export declare class DockViewModel extends HoistModel {
+    id: string;
+    title: string;
+    icon: ReactElement;
+    docked: boolean;
+    collapsed: boolean;
+    content: Content;
+    width: number;
+    height: number;
+    collapsedWidth: number;
+    allowClose: boolean;
+    allowDialog: boolean;
+    containerModel: DockContainerModel;
+    refreshContextModel: RefreshContextModel;
+    modalSupportModel: ModalSupportModel;
+    private _renderMode;
+    private _refreshMode;
+    get isActive(): boolean;
+    get renderMode(): RenderMode;
+    get refreshMode(): RefreshMode;
+    constructor({ id, containerModel, title, icon, content, width, height, collapsedWidth, refreshMode, renderMode, docked, collapsed, allowClose, allowDialog }: DockViewConfig);
+    toggleDocked(): void;
+    showInDialog(): void;
+    showInDock(): void;
+    toggleCollapsed(): void;
+    expand(): void;
+    collapse(): void;
+    close(): void;
+    destroy(): void;
+}

package/build/types/desktop/cmp/dock/impl/DockContainer.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import '@xh/hoist/desktop/register';
+import './Dock.scss';
+import { DockContainerProps } from '../DockContainer';
+/**
+ * Desktop implementation of DockContainer.
+ *
+ * @internal
+ */
+export declare function dockContainerImpl({ model, className, compactHeaders, ...props }: DockContainerProps, ref: any): import("react").ReactElement<import("@xh/hoist/cmp/layout").BoxComponentProps, any>;

package/build/types/desktop/cmp/dock/impl/DockView.d.ts

@@ -0,0 +1,15 @@
+import { DockViewModel } from '@xh/hoist/desktop/cmp/dock';
+import { HoistProps } from '@xh/hoist/core';
+import '@xh/hoist/desktop/register';
+import './Dock.scss';
+interface DockViewProps extends HoistProps<DockViewModel> {
+    /** True to style docked headers with reduced padding and font-size. */
+    compactHeaders?: boolean;
+}
+/**
+ * Wrapper for contents to be shown within a DockContainer.
+ *
+ * @internal
+ */
+export declare const dockView: import("@xh/hoist/core").ElementFactory<DockViewProps>;
+export {};

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

@@ -0,0 +1,3 @@
+export * from './DockContainer';
+export * from './DockContainerModel';
+export * from './DockViewModel';

package/build/types/desktop/cmp/error/ErrorMessage.d.ts

@@ -0,0 +1,33 @@
+import { HoistProps, PlainObject } from '@xh/hoist/core';
+import { ButtonProps } from '@xh/hoist/desktop/cmp/button';
+import '@xh/hoist/desktop/register';
+import { ReactNode, MouseEvent } from 'react';
+import './ErrorMessage.scss';
+export interface ErrorMessageProps extends HoistProps {
+    /**
+     * If provided, will render a "Retry" button that calls this function.
+     * Use `actionButtonProps` for further control over this button.
+     */
+    actionFn?: (e: MouseEvent) => void;
+    /**
+     * If provided, component will render an inline action button - prompting to user to take some
+     * action that might resolve the error, such as retrying a failed data load.
+     */
+    actionButtonProps?: ButtonProps;
+    /**
+     * Error to display. If undefined, this component will look for an error property on its model.
+     * If no error is found, this component will not be displayed.
+     */
+    error?: Error | string | PlainObject;
+    /**
+     * Message to display for the error.
+     * Defaults to the error, or any 'message' property contained within it.
+     */
+    message?: ReactNode;
+    /** Optional title to display above the message. */
+    title?: ReactNode;
+}
+/**
+ * Component for displaying an error with standardized styling.
+ */
+export declare const ErrorMessage: import("react").FC<ErrorMessageProps>, errorMessage: import("@xh/hoist/core").ElementFactory<ErrorMessageProps>;

package/build/types/desktop/cmp/error/index.d.ts

@@ -0,0 +1 @@
+export * from './ErrorMessage';

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

@@ -0,0 +1,42 @@
+import { BoxProps, HoistProps, Some } from '@xh/hoist/core';
+import '@xh/hoist/desktop/register';
+import { ReactNode } from 'react';
+import './FileChooser.scss';
+import { FileChooserModel } from './FileChooserModel';
+export interface FileChooserProps extends HoistProps<FileChooserModel>, BoxProps {
+    /** File type(s) to accept (e.g. `['.doc', '.docx', '.pdf']`). */
+    accept?: Some<string>;
+    /** True (default) to allow multiple files in a single upload. */
+    enableMulti?: boolean;
+    /**
+     * True to allow user to drop multiple files into the dropzone at once.  True also allows
+     * for selection of multiple files within the OS pop-up window.  Defaults to enableMulti.
+     */
+    enableAddMulti?: boolean;
+    /** Maximum accepted file size in bytes. */
+    maxSize?: number;
+    /** Minimum accepted file size in bytes. */
+    minSize?: number;
+    /**
+     * True (default) to display the selected file(s) in a grid alongside the dropzone. Note
+     * that, if false, the component will not provide any built-in indication of its selection.
+     */
+    showFileGrid: boolean;
+    /** Intro/help text to display within the dropzone target. */
+    targetText?: ReactNode;
+}
+/**
+ * A component to select one or more files from the local filesystem. Wraps the third-party
+ * react-dropzone component to provide both drag-and-drop and click-to-browse file selection.
+ * Expands upon this core functionality with an optional grid (enabled by default) displaying
+ * the list of selected files and allowing the user to remove files from the selection.
+ *
+ * This component should be provided with a FileChooserModel instance, as the model holds an
+ * observable collection of File objects and provides a public API to manipulate the selection.
+ *
+ * The application is responsible for processing the selected files (e.g. by uploading them to a
+ * server) and clearing the selection when complete.
+ *
+ * @see FileChooserModel
+ */
+export declare const FileChooser: import("react").FC<FileChooserProps>, fileChooser: import("@xh/hoist/core").ElementFactory<FileChooserProps>;

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

@@ -0,0 +1,25 @@
+import { GridModel } from '@xh/hoist/cmp/grid';
+import { HoistModel } from '@xh/hoist/core';
+import '@xh/hoist/desktop/register';
+export declare class FileChooserModel extends HoistModel {
+    files: File[];
+    lastRejectedCount: number;
+    gridModel: GridModel;
+    constructor();
+    /**
+     * Add Files to the selection. Typically called by the component's embedded react-dropzone.
+     * Files will be de-duplicated by name, with a newly added file taking precedence over any
+     * existing file with the same name.
+     */
+    addFiles(filesToAdd: File[]): void;
+    setSingleFile(file: File): void;
+    /**
+     * Remove a single file from the current selection.
+     */
+    removeFileByName(name: string): void;
+    /** Clear the current selection. */
+    removeAllFiles(): void;
+    private createGridModel;
+    onDrop(accepted: any, rejected: any, enableMulti: any): void;
+    onFilesChange(files: any): void;
+}

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

@@ -0,0 +1,2 @@
+export * from './FileChooser';
+export * from './FileChooserModel';

package/build/types/desktop/cmp/filter/FilterChooser.d.ts

@@ -0,0 +1,28 @@
+import { FilterChooserModel } from '@xh/hoist/cmp/filter';
+import { HoistProps, LayoutProps } from '@xh/hoist/core';
+import '@xh/hoist/desktop/register';
+import { ReactElement } from 'react';
+import './FilterChooser.scss';
+export interface FilterChooserProps extends HoistProps<FilterChooserModel>, LayoutProps {
+    /** True to focus the control on render. */
+    autoFocus?: boolean;
+    /** True to disable user interaction. */
+    disabled?: boolean;
+    /** True to show a "clear" button at the right of the control.  Defaults to true. */
+    enableClear?: boolean;
+    /** Icon to display inline on the left side of the input. */
+    leftIcon?: ReactElement;
+    /** Max-height of dropdown. Either a number in pixels or a valid CSS string, such as '80vh'. */
+    maxMenuHeight?: number | string;
+    /** Placement of the dropdown menu relative to the input control. */
+    menuPlacement?: 'auto' | 'top' | 'bottom';
+    /** Width in pixels for the dropdown menu - if unspecified, defaults to control width. */
+    menuWidth?: number;
+    /** Text to display when control is empty. */
+    placeholder?: string;
+}
+/**
+ * A Select based control for searching and choosing filters.
+ * @see FilterChooserModel
+ */
+export declare const FilterChooser: import("react").FC<FilterChooserProps>, filterChooser: import("@xh/hoist/core").ElementFactory<FilterChooserProps>;

package/build/types/desktop/cmp/filter/index.d.ts

@@ -0,0 +1,2 @@
+export * from './FilterChooser';
+export * from '@xh/hoist/cmp/filter';

package/build/types/desktop/cmp/form/FormField.d.ts

@@ -0,0 +1,63 @@
+/// <reference types="react" />
+import { BaseFormFieldProps } from '@xh/hoist/cmp/form';
+import { HSide } from '@xh/hoist/core';
+import '@xh/hoist/desktop/register';
+import './FormField.scss';
+import { PopoverPosition, PopperBoundary } from '@blueprintjs/core';
+export interface FormFieldProps extends BaseFormFieldProps {
+    /**
+     * Focus or toggle input when label is clicked.
+     * Defaulted from containing Form, or true.
+     */
+    clickableLabel?: boolean;
+    /**
+     * Layout field inline with label to the left.
+     * Defaulted from containing Form, or false.
+     */
+    inline?: boolean;
+    /** Alignment of label text, default 'left'. */
+    labelTextAlign?: HSide;
+    /** Width of the label in pixels. */
+    labelWidth?: number;
+    /**
+     * Signal a validation error by inserting a warning glyph in the far left side of the
+     * Input, if supported. (Currently TextField and NumberInput only.)
+     * Defaulted from containing Form, or false.
+     */
+    leftErrorIcon?: boolean;
+    /**
+     * Display validation messages in a tooltip, as opposed to inline within the component.
+     * Defaulted from containing Form, or false.
+     */
+    minimal?: boolean;
+    /**
+     * Minimal validation tooltip will try to fit within the corresponding boundary.
+     * @see https://blueprintjs.com/docs/#core/components/popover
+     */
+    tooltipBoundary?: PopperBoundary;
+    /**
+     * Position for minimal validation tooltip.
+     * @see https://blueprintjs.com/docs/#core/components/popover
+     */
+    tooltipPosition?: PopoverPosition;
+}
+/**
+ * Standardised wrapper around a HoistInput component for use in a form. FormField provides
+ * consistent layout, labelling, and optional display of validation messages for the field.
+ * FormField also supports an alternative read-only display of the bound data.
+ *
+ * This component is intended to be used within a `Form` component and bound to a 'FieldModel'
+ * within that Form's backing `FormModel`. FormField will set up the binding between its input and the
+ * FieldModel instance and can display validation messages, switch between read-only and disabled
+ * variants of its child, and source default props via the parent Form's `fieldDefaults` prop.
+ *
+ * This component is designed to work with an instance of `HoistInput` as its input, and makes use
+ * of many of HoistInput's props. For best results with a customized input, consider wrapping a
+ * HoistInput and passing all props along to it.   At the very least, all custom inputs
+ * must accept 'model' and 'bind' props in order to show and edit data.
+ *
+ * FormFields can be sized and otherwise customized via standard layout props. They will
+ * adjust their child inputs to fill their available space (if appropriate given the input type),
+ * so the recommended approach is to specify any sizing on the FormField (as opposed to the input).
+ */
+export declare const FormField: import("react").FC<FormFieldProps>, formField: import("@xh/hoist/core").ElementFactory<FormFieldProps>;

package/build/types/desktop/cmp/form/index.d.ts

@@ -0,0 +1 @@
+export * from './FormField';

package/build/types/desktop/cmp/grid/columns/Actions.d.ts

@@ -0,0 +1,29 @@
+import { ColumnSpec } from '@xh/hoist/cmp/grid/columns';
+import '@xh/hoist/desktop/register';
+import './Actions.scss';
+/**
+ * A column definition partial for adding an "action column" to a grid. An action column displays
+ * one or more record-aware buttons within a button group, providing the user with an easy
+ * way to perform push-button operations on a given record.
+ *
+ * Another useful pattern is to create re-usable `RecordAction` configs and pass those both to this
+ * column config as well as the grid's contextMenu. This offers the user two ways of accessing actions
+ * without duplicating the action definitions.
+ *
+ * See the `calcActionColWidth` helper function exported below - this returns a pixel width
+ * for your column given a number of actions (accounting for button sizing and padding).
+ *
+ * Note that action columns will be empty for group rows.
+ *
+ * @see RecordAction
+ */
+export declare const actionCol: ColumnSpec;
+/**
+ * Calculates the width for an action column
+ * @param count - number of actions
+ * @param cellPadding - desired left and right padding (in pixels) for the action cell.
+ * @param buttonWidth - width (in pixels) of the action buttons.
+ *      Default small minimal buttons with an icon will be 24px
+ * @returns the width in pixels
+ */
+export declare function calcActionColWidth(count: number, cellPadding?: number, buttonWidth?: number): number;

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

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import { CheckboxProps } from '@xh/hoist/desktop/cmp/input';
+import '@xh/hoist/desktop/register';
+import { EditorProps } from './EditorProps';
+import './Editors.scss';
+export interface BooleanEditorProps extends EditorProps<CheckboxProps> {
+    /**
+     * True to change underlying record state immediately upon user editing gesture (i.e. clicking,
+     * hitting return). Defaults to true.
+     *
+     * Note that this prop is only available if the `fullRowEditing` property on the containing
+     * GridModel is false.  It is ignored in `fullRowEditing` mode.
+     */
+    quickToggle?: boolean;
+}
+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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { DateInputProps } from '@xh/hoist/desktop/cmp/input';
+import '@xh/hoist/desktop/register';
+import { EditorProps } from './EditorProps';
+import './Editors.scss';
+export type DateEditorProps = EditorProps<DateInputProps>;
+export declare const DateEditor: import("react").FC<DateEditorProps>, dateEditor: import("@xh/hoist/core").ElementFactory<DateEditorProps>;

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

@@ -0,0 +1,17 @@
+import { Column, GridModel } from '@xh/hoist/cmp/grid';
+import { HoistInputProps } from '@xh/hoist/cmp/input';
+import { HoistProps } from '@xh/hoist/core';
+import { StoreRecord } from '@xh/hoist/data';
+import '@xh/hoist/desktop/register';
+import type { ICellEditorParams } from '@ag-grid-community/core';
+export interface EditorProps<InputPropsT extends HoistInputProps> extends HoistProps {
+    /** Column in StoreRecord being edited. */
+    column: Column;
+    /** Owning GridModel of record being edited.  */
+    gridModel: GridModel;
+    /** StoreRecord being edited. */
+    record: StoreRecord;
+    /** Props to pass through to the underlying HoistInput component */
+    inputProps: InputPropsT;
+    agParams: ICellEditorParams;
+}

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { NumberInputProps } from '@xh/hoist/desktop/cmp/input';
+import '@xh/hoist/desktop/register';
+import { EditorProps } from './EditorProps';
+import './Editors.scss';
+export type NumberEditorProps = EditorProps<NumberInputProps>;
+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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { SelectProps } from '@xh/hoist/desktop/cmp/input';
+import '@xh/hoist/desktop/register';
+import { EditorProps } from './EditorProps';
+import './Editors.scss';
+export type SelectEditorProps = EditorProps<SelectProps>;
+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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import '@xh/hoist/desktop/register';
+import { TextAreaProps } from '../../input';
+import { EditorProps } from './EditorProps';
+import './Editors.scss';
+export type TextAreaEditorProps = EditorProps<TextAreaProps>;
+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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { TextInputProps } from '@xh/hoist/desktop/cmp/input';
+import '@xh/hoist/desktop/register';
+import { EditorProps } from './EditorProps';
+import './Editors.scss';
+export type TextEditorProps = EditorProps<TextInputProps>;
+export declare const TextEditor: import("react").FC<TextEditorProps>, textEditor: import("@xh/hoist/core").ElementFactory<TextEditorProps>;

package/build/types/desktop/cmp/grid/editors/impl/InlineEditorModel.d.ts

@@ -0,0 +1,15 @@
+import { ElementFactory } from '@xh/hoist/core';
+import { EditorProps } from '@xh/hoist/desktop/cmp/grid/editors/EditorProps';
+import { ForwardedRef, ReactElement } from 'react';
+/**
+ * Hook to render a component to be used for inline cell editing in ag-grid.
+ * @internal - Hoist provides components wrapping the currently-supported `HoistInput`s.
+ *
+ * Implements the lifecycle methods required by ag-grid cell editors.
+ * See https://www.ag-grid.com/react-grid/react-hooks/#hooks-with-lifecycle-methods for details.
+ *
+ * @param component - ElementFactory for HoistInput to render.
+ * @param props - props passed to containing component
+ * @param ref - forwardRef passed to containing component
+ */
+export declare function useInlineEditorModel(component: ElementFactory, props: EditorProps<any>, ref: ForwardedRef<any>): ReactElement;

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

@@ -0,0 +1,6 @@
+export * from './BooleanEditor';
+export * from './DateEditor';
+export * from './NumberEditor';
+export * from './SelectEditor';
+export * from './TextEditor';
+export * from './TextAreaEditor';

package/build/types/desktop/cmp/grid/find/GridFindField.d.ts

@@ -0,0 +1,43 @@
+/// <reference types="react" />
+import { GridModel } from '@xh/hoist/cmp/grid';
+import { LayoutProps } from '@xh/hoist/core';
+import { TextInputProps } from '@xh/hoist/desktop/cmp/input';
+import '@xh/hoist/desktop/register';
+import './GridFindField.scss';
+export interface GridFindFieldProps extends TextInputProps, LayoutProps {
+    /**
+     * GridModel whose data this control should search. This component will, by default, use the
+     * fields for all *visible* columns when matching, as well as any groupBy field.
+     */
+    gridModel?: GridModel;
+    /** Mode to use when searching (default 'startWord'). */
+    matchMode?: 'start' | 'startWord' | 'any';
+    /**
+     * Delay (in ms) to buffer searching the grid after the value changes from user input.
+     * Default 200ms. Set to 0 to filter immediately on each keystroke.
+     */
+    queryBuffer?: number;
+    /**
+     * Names of field(s) to include in search. Cannot be used with `excludeFields`.
+     */
+    includeFields?: string[];
+    /** Names of field(s) to exclude from search. Cannot be used with `includeFields`. */
+    excludeFields?: string[];
+}
+/**
+ * A text input Component that enables users to search through a Grid and select rows that match
+ * the entered search term based on simple word-boundary matching of its value to the value of
+ * configured fields on a record. If any field values match, the record itself is considered a match.
+ *
+ * This component is designed to be bound to a GridModel via `gridModel` prop. (If not configured to
+ * bind to a specific GridModel, this component will bind by default to the nearest GridModel found
+ * in context.) Binding in this way allows the component to auto-generate the fields in the store to
+ * be searched by the field and to automatically select the results in the Grid.
+ *
+ * Fields to be searched can be automatically determined from the bound Grid's Store, and/or
+ * customized via the include/excludeFields props. See prop comments for details.
+ *
+ * This component supports all props available to TextInput and will pass them along to its
+ * underlying TextInput.
+ */
+export declare const GridFindField: import("react").FC<GridFindFieldProps>, gridFindField: import("@xh/hoist/core").ElementFactory<GridFindFieldProps>;

package/build/types/desktop/cmp/grid/find/impl/GridFindFieldImplModel.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="react" />
+import { GridModel } from '@xh/hoist/cmp/grid';
+import { HoistModel } from '@xh/hoist/core';
+import { TextInputModel } from '@xh/hoist/desktop/cmp/input';
+/**
+ * @internal
+ */
+export declare class GridFindFieldImplModel extends HoistModel {
+    xhImpl: boolean;
+    gridModel: GridModel;
+    get matchMode(): string;
+    get queryBuffer(): number;
+    get includeFields(): string[];
+    get excludeFields(): string[];
+    results: any;
+    inputRef: import("react").RefObject<TextInputModel> & ((instance: TextInputModel) => void);
+    _records: any;
+    get count(): number;
+    get selectedIdx(): number;
+    get countLabel(): string;
+    get hasFocus(): boolean;
+    get hasQuery(): boolean;
+    get hasResults(): boolean;
+    get query(): string;
+    setQuery(v: any): void;
+    constructor();
+    onLinked(): void;
+    selectPrev(): void;
+    selectNext(): void;
+    private updateResults;
+    private getRecords;
+    private sortRecordsRecursive;
+    private sortRecordsByGroupBy;
+    private getRegex;
+    private getActiveFields;
+    private getValGetters;
+}