@gooddata/sdk-ui-kit 11.13.0-alpha.1 → 11.13.0-alpha.3

package/esm/sdk-ui-kit.d.ts

@@ -51,7 +51,8 @@ import { IMeasureSortTarget } from '@gooddata/sdk-model';
 import { IMetadataObjectBase } from '@gooddata/sdk-model';
 import { IntlShape } from 'react-intl';
 import { ISeparators } from '@gooddata/sdk-ui';
-import { ISeparators as ISeparators_2 } from '@gooddata/sdk-model';
+import { ISeparators as ISeparators_2 } from '@gooddata/number-formatter';
+import { ISeparators as ISeparators_3 } from '@gooddata/sdk-model';
 import { ISettings } from '@gooddata/sdk-model';
 import { ISortItem } from '@gooddata/sdk-model';
 import { ITheme } from '@gooddata/sdk-model';
@@ -64,6 +65,7 @@ import { KeyboardEventHandler } from 'react';
 import { LocalIdRef } from '@gooddata/sdk-model';
 import { MemoExoticComponent } from 'react';
 import { MessageDescriptor } from 'react-intl';
+import type { MetricType } from '@gooddata/sdk-model';
 import { ModifierKey } from 'react';
 import { MouseEvent as MouseEvent_2 } from 'react';
 import { MutableRefObject } from 'react';
@@ -119,6 +121,12 @@ export declare function AddGranteeBase({ appliedGrantees, addedGrantees, current
  */
 export declare type AddMessageType = (message: MessageDescriptor, options?: MessageParameters) => IMessage;
 
+/**
+ * Advanced format template definitions (complex conditional formats).
+ * @internal
+ */
+export declare const ADVANCED_TEMPLATE_DEFINITIONS: readonly ITemplateDefinition[];
+
 /**
  * @internal
  */
@@ -148,7 +156,7 @@ export declare type Alignment = {
 /**
  * @internal
  */
-export declare const AppHeader: ComponentType<Omit<WithIntlProps<IAppHeaderProps & WrappedComponentProps>, "theme" | "themeIsLoading" | "themeStatus">>;
+export declare const AppHeader: ComponentType<Omit<IAppHeaderProps, "theme" | "themeIsLoading" | "themeStatus">>;
 
 /**
  * @internal
@@ -417,9 +425,7 @@ export declare type Color = string;
 /**
  * @internal
  */
-export declare const ColorPicker: FC<WithIntlProps<IColorPickerProps & WrappedComponentProps>> & {
-    WrappedComponent: ComponentType<IColorPickerProps & WrappedComponentProps>;
-};
+export declare function ColorPicker(props: IColorPickerProps): JSX.Element;
 
 /**
  * @internal
@@ -468,6 +474,80 @@ export declare function ContentDivider({ className }: {
  */
 export declare type CopyCodeOriginType = "keyboard" | "button";
 
+/**
+ * Creates all localized format templates (standard + currency + advanced).
+ *
+ * @param formatMessage - Function to format localized messages (e.g., from react-intl)
+ * @param messageIdPrefix - Optional prefix for message IDs (default: "metricComponent.numberFormat.template")
+ * @returns Array of all format templates with localized names
+ * @internal
+ */
+export declare function createAllTemplates(formatMessage: (descriptor: {
+    id: string;
+}) => string, messageIdPrefix?: string): IFormatTemplate[];
+
+/**
+ * Creates localized currency format presets.
+ *
+ * @param formatMessage - Function to format localized messages (e.g., from react-intl)
+ * @param messageIdPrefix - Optional prefix for message IDs (default: "metricComponent.numberFormat.preset")
+ * @returns Array of currency format presets with localized names
+ * @internal
+ */
+export declare function createCurrencyPresets(formatMessage: (descriptor: {
+    id: string;
+}) => string, messageIdPrefix?: string): IFormatPreset[];
+
+/**
+ * Creates localized standard format presets.
+ *
+ * @param formatMessage - Function to format localized messages (e.g., from react-intl)
+ * @param messageIdPrefix - Optional prefix for message IDs (default: "metricComponent.numberFormat.preset")
+ * @returns Array of standard format presets with localized names
+ * @internal
+ */
+export declare function createStandardPresets(formatMessage: (descriptor: {
+    id: string;
+}) => string, messageIdPrefix?: string): IFormatPreset[];
+
+/**
+ * Creates localized format templates.
+ *
+ * @param formatMessage - Function to format localized messages (e.g., from react-intl)
+ * @param definitions - Template definitions to localize
+ * @param messageIdPrefix - Optional prefix for message IDs (default: "metricComponent.numberFormat.template")
+ * @returns Array of format templates with localized names
+ * @internal
+ */
+export declare function createTemplates(formatMessage: (descriptor: {
+    id: string;
+}) => string, definitions: readonly ITemplateDefinition[], messageIdPrefix?: string): IFormatTemplate[];
+
+/**
+ * Base currency preset definitions.
+ * These are the raw preset data that can be used to create localized presets.
+ * @internal
+ */
+export declare const CURRENCY_PRESET_DEFINITIONS: readonly ICurrencyPresetDefinition[];
+
+/**
+ * Currency format template definitions.
+ * @internal
+ */
+export declare const CURRENCY_TEMPLATE_DEFINITIONS: readonly ITemplateDefinition[];
+
+/**
+ * Local identifiers of templates that are currency-specific.
+ * Used to filter templates when metric type is CURRENCY.
+ * @internal
+ */
+export declare const CURRENCY_TEMPLATE_IDS: string[];
+
+/**
+ * @alpha
+ */
+export declare type CurrencyFormatValidationErrorCode = "empty" | "invalidFormat" | "missingCurrencySymbol" | "missingDecimalPlaces";
+
 /**
  * @internal
  */
@@ -492,6 +572,12 @@ export declare class Datepicker extends PureComponent<IDatePickerOwnProps> {
     render(): JSX.Element;
 }
 
+/**
+ * Default message ID prefix for currency preset definitions.
+ * @internal
+ */
+export declare const DEFAULT_CURRENCY_PRESET_PREFIX = "metricComponent.numberFormat.preset";
+
 /**
  * @internal
  */
@@ -502,6 +588,18 @@ export declare const DEFAULT_ITEM_HEIGHT = 28;
  */
 export declare const DEFAULT_MOBILE_ITEM_HEIGHT = 40;
 
+/**
+ * Default message ID prefix for standard preset definitions.
+ * @internal
+ */
+export declare const DEFAULT_STANDARD_PRESET_PREFIX = "metricComponent.numberFormat.preset";
+
+/**
+ * Default message ID prefix for template definitions.
+ * @internal
+ */
+export declare const DEFAULT_TEMPLATE_PREFIX = "metricComponent.numberFormat.template";
+
 /**
  * Dummy theme metadata object which represents the default colors of GD.
  *
@@ -833,9 +931,7 @@ export declare function FilterGroupItem({ title, subtitle, selectedItemsCount, s
 /**
  * @internal
  */
-export declare const FilterLabel: FC<WithIntlProps<IFilterLabelProps & WrappedComponentProps>> & {
-    WrappedComponent: ComponentType<IFilterLabelProps & WrappedComponentProps>;
-};
+export declare const FilterLabel: NamedExoticComponent<IFilterLabelProps>;
 
 /**
  * @internal
@@ -2321,6 +2417,56 @@ export declare function IconWebsite({ color, className, width, height }: IIconPr
  */
 export declare function IconWidget({ color, className, width, height }: IIconProps): JSX.Element;
 
+/**
+ * @alpha
+ */
+export declare interface ICurrencyFormatValidationError {
+    code: CurrencyFormatValidationErrorCode;
+    /**
+     * Indexes of sections (0-based) that failed validation.
+     * The value is only present for section-driven validations.
+     */
+    sectionIndexes?: number[];
+    message: string;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ICurrencyFormatValidationOptions {
+    /**
+     * Sample value used to verify the formatter does not throw.
+     * Defaults to 12345.67 to cover both thousands and decimals.
+     */
+    sampleValue?: number;
+    /**
+     * Number of mandatory decimal places each section must contain.
+     * Set to 0 (or a negative value) to skip the decimal check.
+     * Defaults to 2.
+     */
+    requiredDecimalPlaces?: number;
+    separators?: ISeparators_2;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ICurrencyFormatValidationResult {
+    isValid: boolean;
+    errors: ICurrencyFormatValidationError[];
+}
+
+/**
+ * Base currency preset definitions without localized names.
+ * @internal
+ */
+export declare interface ICurrencyPresetDefinition {
+    localIdentifier: string;
+    format: string;
+    previewNumber: number;
+    messageId: string;
+}
+
 /**
  * @internal
  */
@@ -2413,7 +2559,7 @@ export declare interface IDescriptionPanelProps {
     useReferences?: boolean;
     LoadingComponent?: ComponentType;
     filters?: IFilter[];
-    separators?: ISeparators_2;
+    separators?: ISeparators_3;
     execConfig?: IExecutionConfig;
     id?: string;
 }
@@ -3470,7 +3616,7 @@ export declare interface IInsightListItemProps {
     type?: string;
     width?: number;
     filters?: IFilter[];
-    separators?: ISeparators_2;
+    separators?: ISeparators_3;
     onClick?: () => void;
     onDelete?: () => void;
     onDescriptionPanelOpen?: () => void;
@@ -3894,7 +4040,6 @@ export declare interface ILegacyListState {
  * @internal
  */
 export declare interface ILegacyMultiSelectListItemProps {
-    intl: IntlShape;
     isLoading?: boolean;
     onMouseOut?: (source: any) => void;
     onMouseOver?: (source: any) => void;
@@ -4257,7 +4402,6 @@ export declare interface IMultiSelectListItemProps {
  * @internal
  */
 export declare interface IMultiSelectListProps<T> {
-    intl: IntlShape;
     height?: number;
     width?: number;
     itemHeight?: number;
@@ -4435,49 +4579,13 @@ export declare interface InputState {
 /**
  * @internal
  */
-export declare class InputWithNumberFormat extends PureComponent<InputWithNumberFormatProps, InputWithNumberFormatState> {
-    private input;
-    static defaultProps: {
-        separators: {
-            thousand: string;
-            decimal: string;
-        };
-        autofocus: boolean;
-        className: string;
-        clearOnEsc: boolean;
-        disabled: boolean;
-        hasError: boolean;
-        hasWarning: boolean;
-        isSearch: boolean;
-        isSmall: boolean;
-        maxlength: number;
-        onChange: (..._: any[]) => void;
-        onEscKeyPress: (..._: any[]) => void;
-        onEnterKeyPress: (..._: any[]) => void;
-        onBlur: (..._: any[]) => void;
-        onFocus: (..._: any[]) => void;
-        placeholder: string;
-        prefix: string;
-        readonly: boolean;
-        suffix: string;
-        label: string;
-        labelPositionTop: boolean;
-        value: string;
-    };
-    constructor(props: InputWithNumberFormatProps);
-    UNSAFE_componentWillReceiveProps({ value: newValue }: InputWithNumberFormatProps): void;
-    onChange: (value: number, e: ChangeEvent<HTMLInputElement>) => void;
-    onFocus: (e: FocusEvent_2<HTMLInputElement>) => void;
-    onBlur: (e: FocusEvent_2<HTMLInputElement>) => void;
-    handleCaretShift(e: ChangeEvent<HTMLInputElement>): void;
-    render(): JSX.Element;
-}
+export declare const InputWithNumberFormat: NamedExoticComponent<InputWithNumberFormatProps>;
 
 /**
  * @internal
  */
 export declare interface InputWithNumberFormatOwnProps {
-    separators: Separators;
+    separators?: Separators;
 }
 
 /**
@@ -4506,9 +4614,7 @@ export declare function InsightIcon({ visualizationUrl, iconProps, }: IInsightIc
 /**
  * @internal
  */
-export declare const InsightListItem: FC<WithIntlProps<IInsightListItemProps & WrappedComponentProps>> & {
-    WrappedComponent: ComponentType<IInsightListItemProps & WrappedComponentProps>;
-};
+export declare function InsightListItem({ title, description, updated, type, isSelected, isLoading, filters, separators, LoadingComponent, onClick, onDescriptionPanelOpen, showDescriptionPanel, useRichText, useReferences, richTextExecConfig, width, isLocked, onDelete, metadataTimeZone, }: IInsightListItemProps): JSX.Element;
 
 /**
  * @internal
@@ -4853,7 +4959,7 @@ export declare interface IRichTextProps {
     /**
      * Separators to be used for rendering references.
      */
-    separators?: ISeparators_2;
+    separators?: ISeparators_3;
     /**
      * @alpha
      */
@@ -4948,6 +5054,14 @@ export declare interface IScrollGradientProps {
     children?: ReactNode;
 }
 
+/**
+ * Checks if a format string represents a currency format.
+ * A currency format is one where at least one numeric section contains a currency symbol.
+ *
+ * @alpha
+ */
+export declare function isCurrencyFormat(format: string | undefined | null): boolean;
+
 /**
  * @internal
  */
@@ -5360,6 +5474,17 @@ export declare const isSpaceKey: (event: KeyboardEvent_2) => boolean;
  */
 export declare const isTabKey: (event: KeyboardEvent_2) => boolean;
 
+/**
+ * Base standard preset definition without localized name.
+ * @internal
+ */
+export declare interface IStandardPresetDefinition {
+    localIdentifier: string;
+    format: string;
+    previewNumber: number;
+    messageId: string;
+}
+
 /**
  * @internal
  */
@@ -5411,7 +5536,7 @@ export declare interface IStylingSettingWidgetProps<T extends StylingPickerItemC
     className?: string;
     shouldDisableCancelButton?: boolean;
     shouldDisableApplyButton?: boolean;
-    onApply?: (ref: ObjRef) => void;
+    onApply?: (ref: ObjRef | null) => void;
     onCancel?: () => void;
     onListActionClick?: () => void;
     onItemEdit?: (modifiedItem: IStylingPickerItem<T>) => void;
@@ -5419,7 +5544,7 @@ export declare interface IStylingSettingWidgetProps<T extends StylingPickerItemC
     locale?: string;
     onHelpClick?: () => void;
     onItemMenuToggle?: (ref: ObjRef) => void;
-    onItemSelect?: (ref: ObjRef) => void;
+    onItemSelect?: (ref: ObjRef | null) => void;
     isEditingSupported?: boolean;
     isSavingActionInProgress?: boolean;
 }
@@ -5501,6 +5626,16 @@ export declare interface ITabsState {
  */
 export declare function Item({ checked, subMenu, disabled, className, children, style, onClick, }: IItemProps): JSX.Element;
 
+/**
+ * Base template definition without localized name.
+ * @internal
+ */
+export declare interface ITemplateDefinition {
+    localIdentifier: string;
+    format: string;
+    messageId: string;
+}
+
 /**
  * @internal
  */
@@ -6444,9 +6579,7 @@ export declare const modifierNegator: "!";
 /**
  * @internal
  */
-export declare const MultiSelectList: FC<WithIntlProps<IMultiSelectListProps<unknown>>> & {
-    WrappedComponent: ComponentType<IMultiSelectListProps<unknown>>;
-};
+export declare function MultiSelectList<T>({ isMobile, width, height, items, itemHeight, itemsCount, onScrollEnd, renderItem, selectedItems, listClassNames, onSelectAll, onSelectNone, isInverted, isSearching, isSelected, filteredItemsCount, selectAllCheckbox, tagName, }: IMultiSelectListProps<T>): JSX.Element;
 
 /**
  * @internal
@@ -7010,6 +7143,19 @@ export declare const Spinner: NamedExoticComponent<ISpinnerProps>;
  */
 export declare type SpinnerSize = "large" | "small";
 
+/**
+ * Standard numeric preset definitions.
+ * These are the raw preset data that can be used to create localized presets.
+ * @internal
+ */
+export declare const STANDARD_PRESET_DEFINITIONS: readonly IStandardPresetDefinition[];
+
+/**
+ * Standard format template definitions (basic numeric formats).
+ * @internal
+ */
+export declare const STANDARD_TEMPLATE_DEFINITIONS: readonly ITemplateDefinition[];
+
 /**
  * Properties for BEM modifiers.
  *
@@ -7183,6 +7329,7 @@ export declare interface UiAsyncTableAccessibilityConfig<T> {
 export declare interface UiAsyncTableBulkAction {
     label: string;
     onClick: () => void;
+    accessibilityConfig?: IAccessibilityConfigBase;
 }
 
 /**
@@ -7795,6 +7942,92 @@ export declare interface UiPagedVirtualListSkeletonItemProps {
     itemHeight: number;
 }
 
+/**
+ * A circular button used for pagination navigation (previous/next).
+ *
+ * @remarks
+ * The button has a circular shape with a light gray background that darkens on hover.
+ * The icon color inverts to white when hovered or active.
+ *
+ * @internal
+ */
+export declare const UiPaginationButton: ForwardRefExoticComponent<UiPaginationButtonProps & RefAttributes<HTMLButtonElement>>;
+
+/**
+ * Direction of the pagination button arrow.
+ *
+ * @internal
+ */
+export declare type UiPaginationButtonDirection = "previous" | "next";
+
+/**
+ * Props for the UiPaginationButton component.
+ *
+ * @internal
+ */
+export declare interface UiPaginationButtonProps {
+    /**
+     * Direction of the arrow icon.
+     * - "previous" shows left arrow (paginationLeft)
+     * - "next" shows right arrow (paginationRight)
+     */
+    direction: UiPaginationButtonDirection;
+    /**
+     * Accessible label for the button.
+     */
+    label: string;
+    /**
+     * Size of the button.
+     * - "small" (22x22) - for desktop views
+     * - "large" (32x32) - for mobile views
+     * @defaultValue "small"
+     */
+    size?: UiPaginationButtonSize;
+    /**
+     * Whether the button is disabled.
+     */
+    isDisabled?: boolean;
+    /**
+     * Whether the button is in active/selected state.
+     */
+    isActive?: boolean;
+    /**
+     * Click handler.
+     */
+    onClick?: (e: MouseEvent_2<HTMLButtonElement>) => void;
+    /**
+     * Keyboard event handler.
+     */
+    onKeyDown?: (e: KeyboardEvent_2<HTMLButtonElement>) => void;
+    /**
+     * Data attribute for tracking/analytics.
+     */
+    dataId?: string;
+    /**
+     * Data attribute for testing.
+     */
+    dataTestId?: string;
+    /**
+     * Tab index for keyboard navigation.
+     */
+    tabIndex?: number;
+    /**
+     * HTML id attribute.
+     */
+    id?: string;
+    /**
+     * Accessibility configuration for ARIA attributes.
+     */
+    accessibilityConfig?: IAccessibilityConfigBase;
+}
+
+/**
+ * Size variant for UiPaginationButton.
+ *
+ * @internal
+ */
+export declare type UiPaginationButtonSize = "small" | "large";
+
 /**
  * @internal
  */
@@ -8163,6 +8396,27 @@ export declare function useAsyncTableResponsiveColumns<T>(columns: Array<UiAsync
     columns: UiAsyncTableColumnDefinitionResponsive<T>[];
 };
 
+/**
+ * @internal
+ *
+ * Ensures that currency metrics default to a meaningful preset instead of falling back to custom formats.
+ * - When no format is set yet, it applies the inherited override or the standard currency preset.
+ * - When switching to currency with an incompatible format, it coerces the format to a supported preset.
+ */
+export declare function useCurrencyFormatDefaults({ metricType, normalizedFormat, currencyFormatOverride, presetFormats, hasInheritPreset, onFormatChange, shouldBootstrap, fallbackFormat, }: UseCurrencyFormatDefaultsConfig): void;
+
+/** @internal */
+export declare interface UseCurrencyFormatDefaultsConfig {
+    metricType?: MetricType;
+    normalizedFormat: string | null;
+    currencyFormatOverride?: string | null;
+    presetFormats: string[];
+    hasInheritPreset: boolean;
+    onFormatChange: (format: string | null) => void;
+    shouldBootstrap: boolean;
+    fallbackFormat?: string;
+}
+
 /**
  * @internal
  */
@@ -8179,6 +8433,19 @@ export declare function useFocusWithinContainer(idToFocus?: string | null): {
     containerRef: RefObject<HTMLElement | null>;
 };
 
+/**
+ * Hook that creates all format templates.
+ * Use this when you need templates without metric type filtering.
+ *
+ * @param formatMessage - Function to format localized messages
+ * @param excludeCurrencyTemplates - Whether to exclude currency-specific templates
+ * @returns Array of format templates
+ * @internal
+ */
+export declare function useFormatTemplates(formatMessage: (descriptor: {
+    id: string;
+}) => string, excludeCurrencyTemplates?: boolean): IFormatTemplate[];
+
 /**
  * Internal context hook used to provide header search drop-down state to the components.
  * @internal
@@ -8254,6 +8521,98 @@ export declare function useListWithActionsKeyboardNavigation<Item, Action extend
  */
 export declare const useMediaQuery: (mediaQueryName: keyof IMediaQueries) => boolean;
 
+/**
+ * Hook that creates format presets and templates based on metric type.
+ *
+ * This hook encapsulates the logic for building format options that respect:
+ * - Metric type (CURRENCY vs standard)
+ * - Currency format override (creates "inherit" preset)
+ *
+ * @example
+ * ```tsx
+ * const { presets, templates, inheritPreset } = useMetricTypePresets({
+ *   metricType: "CURRENCY",
+ *   currencyFormatOverride: "$#,##0.00",
+ *   formatMessage: (d) => intl.formatMessage(d),
+ * });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // With custom message ID prefixes (e.g., for Analytical Designer)
+ * const { presets, templates } = useMetricTypePresets({
+ *   metricType: undefined,
+ *   formatMessage: (d) => intl.formatMessage(d),
+ *   presetMessageIdPrefix: "measure_number_format.preset",
+ *   templateMessageIdPrefix: "measure_number_format.template",
+ * });
+ * ```
+ *
+ * @internal
+ */
+export declare function useMetricTypePresets({ metricType, currencyFormatOverride, formatMessage, presetMessageIdPrefix, templateMessageIdPrefix, }: UseMetricTypePresetsConfig): UseMetricTypePresetsResult;
+
+/**
+ * Configuration for the useMetricTypePresets hook.
+ * @internal
+ */
+export declare interface UseMetricTypePresetsConfig {
+    /**
+     * The metric type. When "CURRENCY", currency-specific presets are shown.
+     * When undefined, standard numeric presets are shown.
+     */
+    metricType?: MetricType;
+    /**
+     * The currency format override from workspace settings.
+     * When set and metricType is "CURRENCY", an "inherit" preset is added.
+     */
+    currencyFormatOverride?: string | null;
+    /**
+     * Function to format localized messages (e.g., from react-intl).
+     */
+    formatMessage: (descriptor: {
+        id: string;
+    }) => string;
+    /**
+     * Optional prefix for preset message IDs.
+     * Default: "metricComponent.numberFormat.preset"
+     *
+     * Use this to customize the translation keys for presets.
+     * For example, set to "measure_number_format.preset" for Analytical Designer compatibility.
+     */
+    presetMessageIdPrefix?: string;
+    /**
+     * Optional prefix for template message IDs.
+     * Default: "metricComponent.numberFormat.template"
+     *
+     * Use this to customize the translation keys for templates.
+     * For example, set to "measure_number_format.template" for Analytical Designer compatibility.
+     */
+    templateMessageIdPrefix?: string;
+}
+
+/**
+ * Result from the useMetricTypePresets hook.
+ * @internal
+ */
+export declare interface UseMetricTypePresetsResult {
+    /**
+     * Format presets based on metric type.
+     * For CURRENCY: currency presets with optional inherit preset.
+     * For other types: standard numeric presets.
+     */
+    presets: IFormatPreset[];
+    /**
+     * Format templates. For CURRENCY metrics, currency templates are excluded
+     * from the general list (they're already in presets).
+     */
+    templates: IFormatTemplate[];
+    /**
+     * The inherit preset if available (only for CURRENCY with override).
+     */
+    inheritPreset: IFormatPreset | null;
+}
+
 /**
  * Hook to get current instance of the {@link OverlayController}
  *
@@ -8323,6 +8682,18 @@ export declare const useScrollContext: () => {
     scrollIntoView: (_element: HTMLElement, _bottomMargin?: number, _isElementInvisibleCheck?: isElementInvisibleType) => void;
 };
 
+/**
+ * Hook that creates standard numeric format presets.
+ * Use this when you don't need metric type awareness.
+ *
+ * @param formatMessage - Function to format localized messages
+ * @returns Array of standard format presets
+ * @internal
+ */
+export declare function useStandardPresets(formatMessage: (descriptor: {
+    id: string;
+}) => string): IFormatPreset[];
+
 /**
  * @internal
  */
@@ -8393,6 +8764,13 @@ export declare function useUiTreeViewEventSubscriber<T extends UiTreeViewEventTy
  */
 export declare const useZoom: () => IZoomContextState;
 
+/**
+ * Validates a number format string that is expected to represent a currency amount.
+ *
+ * @alpha
+ */
+export declare function validateCurrencyFormat(format: string | undefined | null, options?: ICurrencyFormatValidationOptions): ICurrencyFormatValidationResult;
+
 /**
  * @internal
  * Icon button variant same as tertiary but removing extra padding around the icon