@xh/hoist 57.0.0 → 57.0.2

package/build/types/desktop/cmp/treemap/SplitTreeMapModel.d.ts

@@ -0,0 +1,79 @@
+import { HoistModel, PlainObject, Theme } from '@xh/hoist/core';
+import '@xh/hoist/desktop/register';
+import { StoreRecord, StoreRecordId } from '@xh/hoist/data';
+import { ReactNode } from 'react';
+import { TreeMapAlgorithm, TreeMapColorMode, TreeMapModel, TreeMapConfig } from './TreeMapModel';
+/**
+ * Core Model for a SplitTreeMap.
+ *
+ * Binds to a Store (or GridModel) and splits the data into two managed child TreeMaps.
+ * Users should specify a `mapFilter` function to control how records are divided
+ * across the two TreeMaps.
+ *
+ * Additionally, accepts and passes along all settings for TreeMapModel.
+ * @see TreeMapModel
+ */
+interface SplitTreeMapConfig extends TreeMapConfig {
+    /**
+     * Filter used to allocate records between the primary and secondary maps.
+     * Defaults to: `record[valueField] >= 0`.
+     */
+    mapFilter?: SplitTreeMapFilterFn;
+    /** Function to render region titles. */
+    mapTitleFn?: SplitTreeMapTitleFn;
+    /** True to insert a four pixel buffer between the two maps. */
+    showSplitter?: boolean;
+    /** Layout orientation to use. */
+    orientation?: SplitTreeMapOrientation;
+}
+export declare class SplitTreeMapModel extends HoistModel {
+    mapFilter: SplitTreeMapFilterFn;
+    mapTitleFn: SplitTreeMapTitleFn;
+    showSplitter: boolean;
+    primaryMapModel: TreeMapModel;
+    secondaryMapModel: TreeMapModel;
+    orientation: SplitTreeMapOrientation;
+    constructor(config: SplitTreeMapConfig);
+    get total(): number;
+    get selectedIds(): StoreRecordId[];
+    get isMasking(): boolean;
+    get empty(): boolean;
+    get expandState(): PlainObject;
+    get error(): string;
+    get emptyText(): ReactNode;
+    get highchartsConfig(): any;
+    get labelField(): string;
+    get heatField(): string;
+    get maxDepth(): number;
+    get maxHeat(): number;
+    get algorithm(): TreeMapAlgorithm;
+    get colorMode(): TreeMapColorMode;
+    get theme(): Theme;
+    setOrientation(orientation: SplitTreeMapOrientation): void;
+    setHighchartsConfig(highchartsConfig: any): void;
+    setLabelField(labelField: string): void;
+    setHeatField(heatField: string): void;
+    setMaxDepth(maxDepth: number): void;
+    setMaxHeat(maxHeat: number): void;
+    setAlgorithm(algorithm: TreeMapAlgorithm): void;
+    setColorMode(colorMode: TreeMapColorMode): void;
+    setTheme(theme: Theme): void;
+    defaultMapFilter: (record: any) => boolean;
+}
+/**
+ * Return true if record belongs to / should appear within the primary map, falsy to
+ * have it allocated to the secondary map.
+ */
+type SplitTreeMapFilterFn = (record: PlainObject | StoreRecord) => boolean;
+/**
+ * Function to generate the region title to display.
+ * `isPrimary` is true if the region is the primary (top/left) map in the pair.
+ */
+type SplitTreeMapTitleFn = (treeMapModel: TreeMapModel, isPrimary: boolean) => ReactNode;
+/**
+ * Layout orientation:
+ *   - 'vertical' (default) to display primary and secondary maps one above the other.
+ *   - 'horizontal' to show them side-by-side.
+ */
+type SplitTreeMapOrientation = 'vertical' | 'horizontal';
+export {};

package/build/types/desktop/cmp/treemap/TreeMap.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import { LayoutProps, HoistProps } from '@xh/hoist/core';
+import '@xh/hoist/desktop/register';
+import './TreeMap.scss';
+import { TreeMapModel } from './TreeMapModel';
+export interface TreeMapProps extends HoistProps<TreeMapModel>, LayoutProps {
+}
+/**
+ * Component for rendering a TreeMap.
+ *
+ * It is a managed wrapper around a Highcharts TreeMap visualization, which renders
+ * records from a Store and optionally binds to a GridModel.
+ *
+ * @see TreeMapModel
+ */
+export declare const TreeMap: import("react").FC<TreeMapProps>, treeMap: import("@xh/hoist/core").ElementFactory<TreeMapProps>;

package/build/types/desktop/cmp/treemap/TreeMapModel.d.ts

@@ -0,0 +1,182 @@
+import { HoistModel, PlainObject, Theme } from '@xh/hoist/core';
+import { Store, StoreRecord, StoreRecordId } from '@xh/hoist/data';
+import { GridModel } from '@xh/hoist/cmp/grid';
+import { FilterLike } from '@xh/hoist/data/filter/Types';
+import '@xh/hoist/desktop/register';
+import { ReactNode } from 'react';
+/**
+ * Core Model for a TreeMap.
+ *
+ * You should specify the TreeMap's data store, in addition to which StoreRecord fields should be
+ * mapped to label (a node's display name), value (a node's size), and heat (a node's color).
+ *
+ * Can also (optionally) be bound to a GridModel. This will enable selection syncing and
+ * expand / collapse syncing for GridModels in `treeMode`.
+ *
+ * Supports any Highcharts TreeMap algorithm ('squarified', 'sliceAndDice', 'stripes' or 'strip').
+ *
+ * Node colors are normalized to a 0-1 range and mapped to a colorAxis via the following colorModes:
+ * 'linear' distributes normalized color values across the colorAxis according to the heatField.
+ * 'wash' ignores the intensity of the heat value, applying a single positive and negative color.
+ * 'none' will ignore the colorAxis, and instead use the neutral color.
+ *
+ * Color customization can be managed by setting colorAxis stops via the `highchartsConfig`.
+ *
+ * @see https://www.highcharts.com/docs/chart-and-series-types/treemap for Highcharts config options
+ */
+export interface TreeMapConfig {
+    /** A store containing records to be displayed. */
+    store?: Store;
+    /** Optional GridModel to bind to. */
+    gridModel?: GridModel;
+    /** Maximum number of nodes to render. Be aware that increasing this can severely degrade performance. */
+    maxNodes?: number;
+    /**
+     * Maximum number of node labels to attempt to render. Defaults to 250, based on the fact that
+     * the smaller boxes beyond that count are unlikely to be able to have enough room to render
+     * labels in any case. Be aware that increasing this can degrade performance.
+     */
+    maxLabels?: number;
+    /**
+     * Highcharts configuration object for the managed map.
+     * Will be recursively merged into the top-level HC config generated by this model, the component.
+     */
+    highchartsConfig?: PlainObject;
+    /** StoreRecord field to use to determine node label. */
+    labelField?: string;
+    /** StoreRecord field to use to determine node size. */
+    valueField?: string;
+    /** StoreRecord field to use to determine node color. */
+    heatField?: string;
+    /** Renderer to use when displaying value in the default tooltip. Should return HTML. */
+    valueRenderer?: TreeMapValueRendererFn;
+    /** Renderer to use when displaying heat in the default tooltip. Should return HTML. */
+    heatRenderer?: TreeMapHeatRendererFn;
+    /**
+     * Value for providing a clamped, stable upper boundary on heat color intensity.
+     * If not provided, maxHeat will be determined by the dataset on each load.
+     */
+    maxHeat?: number;
+    /** Maximum tree depth to render. */
+    maxDepth?: number;
+    /** Layout algorithm to use. */
+    algorithm?: TreeMapAlgorithm;
+    /** Heat color distribution mode. */
+    colorMode?: TreeMapColorMode;
+    /** Theme to use. Leave undefined to use the global theme. */
+    theme?: Theme;
+    /**
+     * Callback to call when a node is clicked.
+     * If not provided, by default will select a record when using a GridModel.
+     */
+    onClick?: (StoreRecord: any, MouseEvent: any) => void;
+    /**
+     * Callback to call when a node is double clicked.
+     * If not provided, by default will expand / collapse a record when using a GridModel.
+     */
+    onDoubleClick?: (StoreRecord: any, MouseEvent: any) => void;
+    /** `true` to use the default tooltip renderer, or a custom tooltipFn. */
+    tooltip?: boolean | TreeMapTooltipFn;
+    /** Element/text to render if TreeMap has no records. */
+    emptyText?: ReactNode;
+    /** Data filter to apply to records. */
+    filter?: FilterLike;
+}
+export declare class TreeMapModel extends HoistModel {
+    store: Store;
+    gridModel: GridModel;
+    maxNodes: number;
+    maxLabels: number;
+    valueRenderer: TreeMapValueRendererFn;
+    heatRenderer: TreeMapHeatRendererFn;
+    onClick: (StoreRecord: any, MouseEvent: any) => void;
+    onDoubleClick: (StoreRecord: any, MouseEvent: any) => void;
+    tooltip: boolean | TreeMapTooltipFn;
+    emptyText: ReactNode;
+    highchartsConfig: any;
+    data: TreeMapRecord[];
+    labelField: string;
+    valueField: string;
+    heatField: string;
+    maxHeat: number;
+    maxDepth: number;
+    algorithm: TreeMapAlgorithm;
+    colorMode: TreeMapColorMode;
+    theme: Theme;
+    isMasking: boolean;
+    _filter: any;
+    constructor(config?: TreeMapConfig);
+    get total(): number;
+    get valueFieldLabel(): string;
+    get heatFieldLabel(): string;
+    get selectedIds(): StoreRecordId[];
+    get expandState(): PlainObject;
+    get empty(): boolean;
+    get error(): string;
+    processAndSetData(sourceRecords: any): void;
+    /**
+     * Create a flat list of TreeMapRecords from hierarchical store data, ready to be
+     * passed to HighCharts for rendering. Drilldown children are included according
+     * to the bound GridModel's expandState.
+     */
+    processRecordsRecursive(sourceRecords: any, parentId?: any, depth?: number): Partial<TreeMapRecord>[];
+    /**
+     * Removes node labels if the number of nodes exceeds maxLabels.
+     * This is a performance optimisation to mitigate slow SVG text rendering. Labels are prioritized
+     * according to node size, from largest to smallest, on the basis that removed labels would
+     * likely be hidden due to the size of the node.
+     */
+    limitLabels(data: any): any;
+    /**
+     * Normalizes heatValues to colorValues between 0-1, where 0 is the maximum negative heat,
+     * 1 is the maximum positive heat, and 0.5 is no heat. This allows the colorValue to map to
+     * the colorAxis provided to Highcharts.
+     *
+     * Takes the colorMode into account:
+     * a) 'linear' distributes normalized color values across the colorAxis.
+     * b) 'wash' ignores the intensity of the heat value, applying a flat positive or negative color.
+     * c) 'none' ignores the heat value altogether, coloring all nodes with the neutral color
+     */
+    normaliseColorValues(data: any): any;
+    normalizeToRange(value: any, fromMin: any, fromMax: any, toMin: any, toMax: any): any;
+    valueIsValid(value: any): boolean;
+    nodeIsExpanded(treePath: any): any;
+    toggleNodeExpanded(treePath: any): void;
+    defaultOnClick: (record: any, e: any) => void;
+    defaultOnDoubleClick: (record: any) => void;
+}
+export interface TreeMapRecord {
+    /** StoreRecordId of the StoreRecord from which TreeMapRecord was created. */
+    id: StoreRecordId;
+    /** StoreRecord from which TreeMapRecord was created. */
+    record: StoreRecord;
+    /** Used by Highcharts to determine the node label. */
+    name: string;
+    /** Used by Highcharts to determine the node size. */
+    value: number;
+    /** Transient property used to determine the Highcharts colorValue. */
+    heatValue: number;
+    /** Used by Highcharts to determine the color in a heat map. */
+    colorValue: number;
+    /** StoreRecordId of parent StoreRecord in hierarchical data. */
+    parent?: StoreRecordId;
+}
+/** Layout algorithm to use. */
+export type TreeMapAlgorithm = 'squarified' | 'sliceAndDice' | 'stripes' | 'strip';
+/** Heat color distribution mode. */
+export type TreeMapColorMode = 'linear' | 'wash' | 'none';
+/**
+ * Normalized renderer function to display value in the tree map tooltip.
+ * @returns the formatted value (html) for display.
+ */
+export type TreeMapValueRendererFn = (value: any, record: StoreRecord) => string;
+/**
+ * Normalized renderer function to display heat in the tree map tooltip.
+ * @returns the formatted value (html) for display.
+ */
+export type TreeMapHeatRendererFn = (value: any, record: StoreRecord) => string;
+/**
+ * Normalized renderer function to produce a tree map tooltip.
+ * @returns the formatted value (html) for display.
+ */
+export type TreeMapTooltipFn = (record: StoreRecord) => string;

package/build/types/desktop/cmp/treemap/impl/Splitter.d.ts

@@ -0,0 +1,6 @@
+import { SplitTreeMapModel } from '../SplitTreeMapModel';
+import './Splitter.scss';
+/**
+ * @internal
+ */
+export declare const splitter: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<SplitTreeMapModel>>;

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

@@ -0,0 +1,4 @@
+export * from './TreeMap';
+export * from './TreeMapModel';
+export * from './SplitTreeMap';
+export * from './SplitTreeMapModel';

package/build/types/desktop/hooks/UseContextMenu.d.ts

@@ -0,0 +1,11 @@
+import { ContextMenuSpec } from '@xh/hoist/desktop/cmp/contextmenu/ContextMenu';
+import { ReactElement } from 'react';
+/**
+ * Hook to add context menu support to a component.
+ *
+ * @param child - element to be given context menu support. Must specify Component
+ *      that takes react context menu event as a prop (e.g. boxes, panel, div, etc).
+ * @param spec - Context Menu to be shown. If null, or the number of items is empty,
+ *      no menu will be rendered, and the event will be consumed.
+ */
+export declare function useContextMenu(child?: ReactElement, spec?: ContextMenuSpec): ReactElement;

package/build/types/desktop/hooks/UseHotkeys.d.ts

@@ -0,0 +1,14 @@
+import { ReactElement } from 'react';
+import { HotkeyConfig } from '@blueprintjs/core/src/hooks/hotkeys/hotkeyConfig';
+/**
+ * Hook to add Key handling support to a component.
+ *
+ * The implementation of this hook is based on BlueprintJS.
+ * See their docs {@link https://blueprintjs.com/docs/#core/components/hotkeys} for more info.
+ *
+ * @param child - element to be given hotkey support.  Must specify Component
+ *      that takes react key events as props (e.g. boxes, panel, div, etc).
+ * @param hotkeys - An array of hotkeys, or configs for hotkeys,
+ *      as prescribed by blueprint. A Hotkeys element may also be provided.
+ */
+export declare function useHotkeys(child?: ReactElement, hotkeys?: HotkeyConfig[]): ReactElement<any, string | import("react").JSXElementConstructor<any>>;

package/build/types/desktop/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './UseHotkeys';
+export * from './UseContextMenu';

package/build/types/desktop/register.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/dynamics/desktop.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The exports below are platform specific classes we would like to use (carefully!) in our
+ * cross-platform code.
+ *
+ * These are dynamically bound in the method below. This dynamic binding ensures that they are
+ * included only on the intended platform to avoid platform specific code contaminating the builds
+ * of other platforms.
+ *
+ * See the platform specific AppContainer where these implementations are actually provided.
+ */
+export declare let tabContainerImpl: any;
+export declare let dockContainerImpl: any;
+export declare let colChooser: any;
+export declare let columnHeaderFilter: any;
+export declare let gridFilterDialog: any;
+export declare let storeFilterFieldImpl: any;
+export declare let pinPadImpl: any;
+export declare let ColChooserModel: any;
+export declare let ColumnHeaderFilterModel: any;
+export declare let useContextMenu: any;
+export declare let ModalSupportModel: any;
+/**
+ * Provide implementations of functions and classes exported in this file.
+ *
+ * Not for Application use.
+ */
+export declare function installDesktopImpls(impls: any): void;

package/build/types/dynamics/mobile.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The exports below are platform specific classes we would like to use (carefully!) in our
+ * cross-platform code.
+ *
+ * These are dynamically bound in the method below. This dynamic binding ensures that they are
+ * included only on the intended platform to avoid platform specific code contaminating the builds
+ * of other platforms.
+ *
+ * See the platform specific AppContainer where these implementations are actually provided.
+ */
+export declare let tabContainerImpl: any;
+export declare let storeFilterFieldImpl: any;
+export declare let pinPadImpl: any;
+export declare let colChooser: any;
+export declare let ColChooserModel: any;
+/**
+ * Provide implementations of functions and classes exported in this file.
+ *
+ * Not for Application use.
+ */
+export declare function installMobileImpls(impls: any): void;

package/build/types/format/FormatDate.d.ts

@@ -0,0 +1,52 @@
+import { ReactNode } from 'react';
+import { DateLike } from '../core/types/Types';
+import { FormatOptions } from './FormatMisc';
+export declare const DATE_FMT = "YYYY-MM-DD", DATETIME_FMT = "YYYY-MM-DD h:mma", DATETIMESEC_FMT = "YYYY-MM-DD h:mm:ssa", TIME_FMT = "h:mma", MONTH_DAY_FMT = "MMM D";
+/**
+ * An object specifying how a date should be formatted.
+ */
+export interface DateFormatOptions extends FormatOptions<DateLike> {
+    /** Display value for null values. */
+    nullDisplay?: ReactNode;
+    /** A MomentJs format string. */
+    fmt?: string;
+}
+/**
+ * Render a date like value with a default format of {@link DATE_FMT}.
+ */
+export declare function fmtDate(v: DateLike, opts?: DateFormatOptions | string): ReactNode;
+/**
+ * Render dates with a default format of {@link DATETIME_FMT}.
+ */
+export declare function fmtDateTime(v: any, opts?: DateFormatOptions | string): ReactNode;
+/**
+ * Render dates with a default format of {@link DATETIMESEC_FMT}.
+ */
+export declare function fmtDateTimeSec(v: DateLike, opts?: DateFormatOptions | string): ReactNode;
+/**
+ * Render dates with a default format of {@link TIME_FMT}.
+ */
+export declare function fmtTime(v: DateLike, opts?: DateFormatOptions | string): ReactNode;
+export interface CompactDateFormatOptions extends FormatOptions<DateLike> {
+    /**
+     * Format for date matching current day, defaults to 'hh:mma' for dates, 'MMM D' for LocalDates.
+     */
+    sameDayFmt?: string;
+    /**
+     *  Format for dates within the number of months specified by the distantThreshold, defaults
+     *  to 'MMM D'.
+     */
+    nearFmt?: string;
+    /**
+     * Format for dates beyond number of months specified by the distantThreshold, defaults to
+     * 'YYYY-MM-DD'.
+     */
+    distantFmt?: string;
+    /** Number of months away from the current month to be considered 'recent' or 'near'. */
+    distantThreshold?: number;
+}
+/**
+ * Render dates formatted based on distance in time from current day.
+ */
+export declare function fmtCompactDate(v: DateLike, opts?: CompactDateFormatOptions): ReactNode;
+export declare const dateRenderer: (obj?: string | DateFormatOptions) => (v: DateLike) => ReactNode, dateTimeRenderer: (obj?: string | DateFormatOptions) => (v: any) => ReactNode, dateTimeSecRenderer: (obj?: string | DateFormatOptions) => (v: DateLike) => ReactNode, timeRenderer: (obj?: string | DateFormatOptions) => (v: DateLike) => ReactNode, compactDateRenderer: (obj?: CompactDateFormatOptions) => (v: DateLike) => ReactNode;

package/build/types/format/FormatMisc.d.ts

@@ -0,0 +1,41 @@
+import { ReactNode } from 'react';
+export interface FormatOptions<T = any> {
+    /** Display value for null values. */
+    nullDisplay?: ReactNode;
+    /** Function to generate a tooltip string. */
+    tooltip?: (v: T) => string;
+    /** Return an HTML string rather than a React element (default false).*/
+    asHtml?: boolean;
+    /** The unaltered original value to be formatted. Not typically used by applications.*/
+    originalValue?: T;
+}
+export interface SpanFormatOptions extends FormatOptions {
+    className?: string;
+    title?: string;
+    /** Set to true to add a space before the v to be wrapped.*/
+    leadSpc?: boolean;
+    /** Set to true to add a space after the span to be returned. */
+    trailSpc?: boolean;
+}
+/**
+ * Wrap values in a custom span
+ *
+ * @param v - value to be placed in span, will be coerced into a string
+ * @param opts - an options object
+ */
+export declare function fmtSpan(v: any, opts?: SpanFormatOptions): ReactNode;
+export interface JSONFormatOptions {
+    /** Method or array pattern for replacing/skipping nodes to pass to `stringify` */
+    replacer?: any;
+    /** Indentation amount to pass to `stringify`*/
+    space?: number | string;
+}
+/**
+ * Pretty-print a JSON string, adding line breaks and indentation.
+ */
+export declare function fmtJson(str: string, opts?: JSONFormatOptions): string;
+/**
+ * Basic util for splitting a string (via ' ') and capitalizing each word - e.g. for names.
+ * Not intended to handle more advanced usages such as HTML or other word boundary characters.
+ */
+export declare function capitalizeWords(str: string): string;

package/build/types/format/FormatNumber.d.ts

@@ -0,0 +1,112 @@
+import Numbro from 'numbro';
+import { ReactNode } from 'react';
+import { FormatOptions } from './FormatMisc';
+export interface NumberFormatOptions extends Omit<FormatOptions<number>, 'tooltip'> {
+    /** A valid numbro format object or string. */
+    formatConfig?: string | Numbro.Format;
+    /** Desired number of decimal places. */
+    precision?: number | 'auto';
+    /** True to pad with trailing zeros out to given precision. */
+    zeroPad?: boolean;
+    /** Optional display value for the input value 0. */
+    zeroDisplay?: ReactNode;
+    /** True to use ledger format. */
+    ledger?: boolean;
+    /**
+     * True to add placeholder after positive ledgers to align vertically with negative ledgers
+     * in columns.
+     */
+    forceLedgerAlign?: boolean;
+    /** True to prepend positive numbers with a '+'. */
+    withPlusSign?: boolean;
+    /** True to prepend an up / down arrow. */
+    withSignGlyph?: boolean;
+    /** True to include comma delimiters. */
+    withCommas?: boolean;
+    /** Set to true to omit comma if value has exactly 4 digits (i.e. 1500 instead of 1,500). */
+    omitFourDigitComma?: boolean;
+    /** Prefix to prepend to value (between the number and its sign). */
+    prefix?: string;
+    /** Label to append to value, or true to append a default label for the formattter
+     * e.g. 'm' for fmtMillions.
+     */
+    label?: string | boolean;
+    /** CSS class of label span. */
+    labelCls?: string;
+    /**
+     * Color output based on the sign of the value. True to use red/green/grey defaults, or provide
+     * an object with alternate CSS classes.
+     */
+    colorSpec?: boolean | ColorSpec;
+    /**
+     * True to enable default tooltip with minimally formatted original value, or a function to
+     * generate a custom tooltip string.
+     */
+    tooltip?: boolean | ((v: number) => string);
+}
+export interface QuantityFormatOptions extends NumberFormatOptions {
+    useMillions?: boolean;
+    useBillions?: boolean;
+}
+/** Config for pos/neg/neutral color classes. */
+export interface ColorSpec {
+    /** CSS color class to wrap around positive values */
+    pos?: string;
+    /** CSS class to wrap around negative values */
+    neg?: string;
+    /** CSS class to wrap around zero values. */
+    neutral?: string;
+}
+/**
+ * Standard number formatting for Hoist
+ *
+ * This method delegates to numbro, @see http://numbrojs.com for more details.
+ *
+ * Hierarchy of params is by specificity: formatPattern, precision.
+ * If no options are given, a heuristic based auto-rounding will occur.
+ *
+ * @returns a ReactNode, for an HTML string see {@link fmtDateAsHtml}
+ */
+export declare function fmtNumber(v: number, opts?: NumberFormatOptions): ReactNode;
+/**
+ * Render number in thousands.
+ */
+export declare function fmtThousands(v: number, opts?: NumberFormatOptions): ReactNode;
+/**
+ * Render number in millions.
+ */
+export declare function fmtMillions(v: number, opts?: NumberFormatOptions): ReactNode;
+/**
+ * Render number in billions.
+ */
+export declare function fmtBillions(v: number, opts?: NumberFormatOptions): ReactNode;
+/**
+ * Render a quantity value, handling highly variable amounts by using units of millions (m) and
+ * billions (b) as needed.'
+ */
+export declare function fmtQuantity(v: number, opts?: QuantityFormatOptions): ReactNode;
+/**
+ * Render market price.
+ */
+export declare function fmtPrice(v: number, opts?: NumberFormatOptions): ReactNode;
+/**
+ * Render a number as a percent. Value will be multiplied by 100 to calculated the percentage.
+ * This behavior purposefully matches Microsoft Excel's percentage formatting.
+ */
+export declare function fmtPercent(v: number, opts?: NumberFormatOptions): ReactNode;
+/**
+ * Render a minimally formatted, full precision number, suitable for use in tooltips.
+ * Only ledger opt is supported.
+ *
+ * @param v - value to format.
+ * @param opts - set key 'ledger' to true to use ledger format, default false
+ */
+export declare function fmtNumberTooltip(v: number, opts?: {
+    ledger?: boolean;
+}): string;
+export declare const numberRenderer: (obj?: NumberFormatOptions) => (v: number) => ReactNode, thousandsRenderer: (obj?: NumberFormatOptions) => (v: number) => ReactNode, millionsRenderer: (obj?: NumberFormatOptions) => (v: number) => ReactNode, billionsRenderer: (obj?: NumberFormatOptions) => (v: number) => ReactNode, quantityRenderer: (obj?: QuantityFormatOptions) => (v: number) => ReactNode, priceRenderer: (obj?: NumberFormatOptions) => (v: number) => ReactNode, percentRenderer: (obj?: NumberFormatOptions) => (v: number) => ReactNode;
+/**
+ * @param value - A value that represents a shorthand numerical value
+ * @returns The number represented by the shorthand string, or NaN
+ */
+export declare function parseNumber(value: any): number;

package/build/types/format/FormatUtils.d.ts

@@ -0,0 +1,11 @@
+import { PlainObject } from '@xh/hoist/core';
+/**
+ * Generate a renderer for a given formatter function.
+ *
+ * The returned renderer takes an optional config for its assigned formatter and itself returns
+ * a function that takes only a value, for convenient use with e.g. grid cell rendering.
+ *
+ * @param formatter - an existing formatter method.
+ * @returns - a configurable renderer.
+ */
+export declare function createRenderer<V = any, C = PlainObject, R = any>(formatter: (v: V, obj?: C) => R): (obj?: C) => (v: V) => R;

package/build/types/format/impl/Utils.d.ts

@@ -0,0 +1,7 @@
+import { PlainObject } from '@xh/hoist/core';
+/**
+ * Install a value on an options object as `originalValue` for later reference, if an
+ * originalValue key has not already been set.
+ * @internal
+ */
+export declare function saveOriginal(v: any, opts: PlainObject): void;

package/build/types/format/index.d.ts

@@ -0,0 +1,4 @@
+export * from './FormatNumber';
+export * from './FormatDate';
+export * from './FormatUtils';
+export * from './FormatMisc';