@coinbase/cds-common 8.13.1 → 8.13.5

package/dts/motion/utils.d.ts

@@ -1,15 +1,33 @@
 import type { MotionCurve, MotionProperty, MotionValue } from '../types';
 type MotionValues = [MotionValue, MotionValue] | MotionValue;
-export declare const generateAnimToken: (property: MotionProperty, values: MotionValues, easing: MotionCurve) => {
-    property: MotionProperty;
-    fromValue: MotionValue;
-    toValue: MotionValue;
-    easing: "global" | "enterExpressive" | "enterFunctional" | "exitExpressive" | "exitFunctional" | "linear";
-} | {
-    property: MotionProperty;
-    toValue: MotionValue;
-    easing: "global" | "enterExpressive" | "enterFunctional" | "exitExpressive" | "exitFunctional" | "linear";
-    fromValue?: undefined;
-};
+export declare const generateAnimToken: (
+  property: MotionProperty,
+  values: MotionValues,
+  easing: MotionCurve,
+) =>
+  | {
+      property: MotionProperty;
+      fromValue: MotionValue;
+      toValue: MotionValue;
+      easing:
+        | 'global'
+        | 'enterExpressive'
+        | 'enterFunctional'
+        | 'exitExpressive'
+        | 'exitFunctional'
+        | 'linear';
+    }
+  | {
+      property: MotionProperty;
+      toValue: MotionValue;
+      easing:
+        | 'global'
+        | 'enterExpressive'
+        | 'enterFunctional'
+        | 'exitExpressive'
+        | 'exitFunctional'
+        | 'linear';
+      fromValue?: undefined;
+    };
 export {};
-//# sourceMappingURL=utils.d.ts.map
+//# sourceMappingURL=utils.d.ts.map

package/dts/numbers/IntlNumberFormat.d.ts

@@ -1,16 +1,16 @@
 export type NumberPart = {
-    type: string;
-    value: number | string;
+  type: string;
+  value: number | string;
 };
 export type KeyedNumberPart = {
-    key: string;
+  key: string;
 } & NumberPart;
 export type IntlNumberParts = {
-    pre: KeyedNumberPart[];
-    integer: KeyedNumberPart[];
-    fraction: KeyedNumberPart[];
-    post: KeyedNumberPart[];
-    formatted: string;
+  pre: KeyedNumberPart[];
+  integer: KeyedNumberPart[];
+  fraction: KeyedNumberPart[];
+  post: KeyedNumberPart[];
+  formatted: string;
 };
 /**
  * Lightweight wrapper around the built-in Intl.NumberFormat that standardizes
@@ -31,101 +31,99 @@ export type IntlNumberParts = {
  *   method will throw and callers should polyfill it.
  */
 export declare class IntlNumberFormat {
+  value: number;
+  formatOptions?: Intl.NumberFormatOptions;
+  locale?: Intl.LocalesArgument;
+  formatter: Intl.NumberFormat;
+  constructor(props: {
     value: number;
-    formatOptions?: Intl.NumberFormatOptions;
+    format?: Intl.NumberFormatOptions;
     locale?: Intl.LocalesArgument;
-    formatter: Intl.NumberFormat;
-    constructor(props: {
-        value: number;
-        format?: Intl.NumberFormatOptions;
-        locale?: Intl.LocalesArgument;
-    });
-    /**
-     * Returns the formatted string.
-     */
-    format(): string;
-    /**
-     * Returns the number parts for RollingNumber with groupings and keys for animations
-     * Examples
-     *
-     * Example 1 — basic currency
-     * Input:
-     * ```json
-     * {
-     *   "value": 98345.67,
-     *   "format": {
-     *     "style": "currency",
-     *     "currency": "USD",
-     *     "minimumFractionDigits": 2,
-     *     "maximumFractionDigits": 5
-     *   },
-     *   "locale": "en-US",
-     *   "prefix": "+",
-     *   "suffix": " BTC"
-     * }
-     * ```
-     *
-     * Output:
-     * ```json
-     * {
-     *   "pre": [
-     *     { "type": "currency", "value": "$", "key": "currency:0" }
-     *   ],
-     *   "integer": [
-     *     { "type": "integer", "value": 9, "key": "integer:4" },
-     *     { "type": "integer", "value": 8, "key": "integer:3" },
-     *     { "type": "group",   "value": ",", "key": "group:0" },
-     *     { "type": "integer", "value": 3, "key": "integer:2" },
-     *     { "type": "integer", "value": 4, "key": "integer:1" },
-     *     { "type": "integer", "value": 5, "key": "integer:0" }
-     *   ],
-     *   "fraction": [
-     *     { "type": "decimal",   "value": ".", "key": "decimal:0" },
-     *     { "type": "fraction",  "value": 6,   "key": "fraction:0" },
-     *     { "type": "fraction",  "value": 7,   "key": "fraction:1" }
-     *   ],
-     *   "post": [],
-     * }
-     * ```
-     *
-     * Example 2 — subscript notation enabled
-     * Input:
-     * ```json
-     * {
-     *   "value": 1e-10,
-     *   "format": {
-     *     "minimumFractionDigits": 2,
-     *     "maximumFractionDigits": 25
-     *   },
-     *   "locale": "en-US",
-     *   "enableSubscriptNotation": true
-     * }
-     * ```
-     *
-     * Output:
-     * ```json
-     * {
-     *   "pre": [],
-     *   "integer": [
-     *     { "type": "integer", "value": 0, "key": "integer:0" }
-     *   ],
-     *   "fraction": [
-     *     { "type": "decimal",   "value": ".", "key": "decimal:0" },
-     *     { "type": "fraction",  "value": 0,   "key": "fraction:0" },
-     *     { "type": "subscript", "value": "₉", "key": "subscript:0" },
-     *     { "type": "fraction",  "value": 1,   "key": "fraction:1" }
-     *   ],
-     *   "post": [],
-     * }
-     * ```
-     */
-    formatToParts({ enableSubscriptNotation }?: {
-        enableSubscriptNotation?: boolean;
-    }): {
-        pre: KeyedNumberPart[];
-        integer: KeyedNumberPart[];
-        fraction: KeyedNumberPart[];
-        post: KeyedNumberPart[];
-    };
+  });
+  /**
+   * Returns the formatted string.
+   */
+  format(): string;
+  /**
+   * Returns the number parts for RollingNumber with groupings and keys for animations
+   * Examples
+   *
+   * Example 1 — basic currency
+   * Input:
+   * ```json
+   * {
+   *   "value": 98345.67,
+   *   "format": {
+   *     "style": "currency",
+   *     "currency": "USD",
+   *     "minimumFractionDigits": 2,
+   *     "maximumFractionDigits": 5
+   *   },
+   *   "locale": "en-US",
+   *   "prefix": "+",
+   *   "suffix": " BTC"
+   * }
+   * ```
+   *
+   * Output:
+   * ```json
+   * {
+   *   "pre": [
+   *     { "type": "currency", "value": "$", "key": "currency:0" }
+   *   ],
+   *   "integer": [
+   *     { "type": "integer", "value": 9, "key": "integer:4" },
+   *     { "type": "integer", "value": 8, "key": "integer:3" },
+   *     { "type": "group",   "value": ",", "key": "group:0" },
+   *     { "type": "integer", "value": 3, "key": "integer:2" },
+   *     { "type": "integer", "value": 4, "key": "integer:1" },
+   *     { "type": "integer", "value": 5, "key": "integer:0" }
+   *   ],
+   *   "fraction": [
+   *     { "type": "decimal",   "value": ".", "key": "decimal:0" },
+   *     { "type": "fraction",  "value": 6,   "key": "fraction:0" },
+   *     { "type": "fraction",  "value": 7,   "key": "fraction:1" }
+   *   ],
+   *   "post": [],
+   * }
+   * ```
+   *
+   * Example 2 — subscript notation enabled
+   * Input:
+   * ```json
+   * {
+   *   "value": 1e-10,
+   *   "format": {
+   *     "minimumFractionDigits": 2,
+   *     "maximumFractionDigits": 25
+   *   },
+   *   "locale": "en-US",
+   *   "enableSubscriptNotation": true
+   * }
+   * ```
+   *
+   * Output:
+   * ```json
+   * {
+   *   "pre": [],
+   *   "integer": [
+   *     { "type": "integer", "value": 0, "key": "integer:0" }
+   *   ],
+   *   "fraction": [
+   *     { "type": "decimal",   "value": ".", "key": "decimal:0" },
+   *     { "type": "fraction",  "value": 0,   "key": "fraction:0" },
+   *     { "type": "subscript", "value": "₉", "key": "subscript:0" },
+   *     { "type": "fraction",  "value": 1,   "key": "fraction:1" }
+   *   ],
+   *   "post": [],
+   * }
+   * ```
+   */
+  formatToParts({ enableSubscriptNotation }?: { enableSubscriptNotation?: boolean }): {
+    pre: KeyedNumberPart[];
+    integer: KeyedNumberPart[];
+    fraction: KeyedNumberPart[];
+    post: KeyedNumberPart[];
+  };
 }
-//# sourceMappingURL=IntlNumberFormat.d.ts.map
+//# sourceMappingURL=IntlNumberFormat.d.ts.map

package/dts/numbers/subscript.d.ts

@@ -4,4 +4,4 @@ export declare const toSubscriptNumber: (n: number) => string;
  * Builds parts for the fractional digits with subscript applied to leading zeros.
  */
 export declare function buildFractionPartsWithSubscript(fractionDigits: string): NumberPart[];
-//# sourceMappingURL=subscript.d.ts.map
+//# sourceMappingURL=subscript.d.ts.map

package/dts/overlays/ModalContext.d.ts

@@ -1,25 +1,25 @@
 export type ModalContextValue = {
-    /**
-     * Controls visibility of the Modal
-     * @default false
-     */
-    visible: boolean;
-    /**
-     * Callback function fired when modal is closed.
-     */
-    onRequestClose: () => void;
-    /**
-     * Hide top and bottom dividers inside Modal body
-     * @default false
-     */
-    hideDividers?: boolean;
-    /**
-     * Hide the close icon on the top right
-     * @default false
-     */
-    hideCloseButton?: boolean;
-    accessibilityLabelledBy?: string;
+  /**
+   * Controls visibility of the Modal
+   * @default false
+   */
+  visible: boolean;
+  /**
+   * Callback function fired when modal is closed.
+   */
+  onRequestClose: () => void;
+  /**
+   * Hide top and bottom dividers inside Modal body
+   * @default false
+   */
+  hideDividers?: boolean;
+  /**
+   * Hide the close icon on the top right
+   * @default false
+   */
+  hideCloseButton?: boolean;
+  accessibilityLabelledBy?: string;
 };
-export declare const ModalContext: import("react").Context<ModalContextValue>;
+export declare const ModalContext: import('react').Context<ModalContextValue>;
 export declare const useModalContext: () => ModalContextValue;
-//# sourceMappingURL=ModalContext.d.ts.map
+//# sourceMappingURL=ModalContext.d.ts.map

package/dts/overlays/OverlayContentContext.d.ts

@@ -1,13 +1,13 @@
 export type OverlayContentContextValue = {
-    /** True if we are inside any overlay component like Overlay, Modal, Tray, or Drawer. */
-    isOverlay?: boolean;
-    /** True if we are inside a Modal component. */
-    isModal?: boolean;
-    /** True if we are inside a Drawer or Tray component. */
-    isDrawer?: boolean;
-    /** True if we are inside a Tour component. */
-    isTour?: boolean;
+  /** True if we are inside any overlay component like Overlay, Modal, Tray, or Drawer. */
+  isOverlay?: boolean;
+  /** True if we are inside a Modal component. */
+  isModal?: boolean;
+  /** True if we are inside a Drawer or Tray component. */
+  isDrawer?: boolean;
+  /** True if we are inside a Tour component. */
+  isTour?: boolean;
 };
-export declare const OverlayContentContext: import("react").Context<OverlayContentContextValue>;
+export declare const OverlayContentContext: import('react').Context<OverlayContentContextValue>;
 export declare const useOverlayContentContext: () => OverlayContentContextValue;
-//# sourceMappingURL=OverlayContentContext.d.ts.map
+//# sourceMappingURL=OverlayContentContext.d.ts.map

package/dts/overlays/PortalContext.d.ts

@@ -1,8 +1,8 @@
 import type { PortalNode } from './usePortalState';
 export type PortalProviderStates = {
-    addNode: (id: string, element: PortalNode['element']) => void;
-    removeNode: (id: string) => void;
-    nodes: PortalNode[];
+  addNode: (id: string, element: PortalNode['element']) => void;
+  removeNode: (id: string) => void;
+  nodes: PortalNode[];
 };
-export declare const PortalContext: import("react").Context<PortalProviderStates>;
-//# sourceMappingURL=PortalContext.d.ts.map
+export declare const PortalContext: import('react').Context<PortalProviderStates>;
+//# sourceMappingURL=PortalContext.d.ts.map

package/dts/overlays/ToastProvider.d.ts

@@ -1,28 +1,35 @@
 import React from 'react';
 import type { ThemeVars } from '../core/theme';
-import type { DimensionValue, OverlayLifecycleProps, SharedAccessibilityProps, SharedProps } from '../types';
+import type {
+  DimensionValue,
+  OverlayLifecycleProps,
+  SharedAccessibilityProps,
+  SharedProps,
+} from '../types';
 export type ToastRefHandle = {
-    hide: () => Promise<boolean>;
+  hide: () => Promise<boolean>;
 };
 export type ToastDuration = {
-    /**
-     * Duration in milliseconds.
-     * Duration is automatically calculated
-     * @danger This will override default calculated value.
-     */
-    duration?: number;
+  /**
+   * Duration in milliseconds.
+   * Duration is automatically calculated
+   * @danger This will override default calculated value.
+   */
+  duration?: number;
 };
 export type ToastAction = SharedProps & {
-    /**
-     * Label for the action button
-     */
-    label: string;
-    /**
-     * Callback function fired when the button is pressed
-     */
-    onPress: () => void;
+  /**
+   * Label for the action button
+   */
+  label: string;
+  /**
+   * Callback function fired when the button is pressed
+   */
+  onPress: () => void;
 };
-export type ToastBaseProps = SharedProps & SharedAccessibilityProps & Pick<OverlayLifecycleProps, 'onWillHide' | 'onDidHide'> & {
+export type ToastBaseProps = SharedProps &
+  SharedAccessibilityProps &
+  Pick<OverlayLifecycleProps, 'onWillHide' | 'onDidHide'> & {
     /**
      * The message to be displayed in the toast
      */
@@ -40,34 +47,36 @@ export type ToastBaseProps = SharedProps & SharedAccessibilityProps & Pick<Overl
      * @default primary
      */
     variant?: ThemeVars.Color;
-};
-export type ToastElement = React.ReactElement<ToastBaseProps & {
+  };
+export type ToastElement = React.ReactElement<
+  ToastBaseProps & {
     ref?: React.Ref<ToastRefHandle>;
-}>;
+  }
+>;
 /**
  * The data structure managed by the ToastProvider.
  * It composes together the Toast element requested to be rendered and the duration for which it should be displayed.
  */
 export type ToastNode = {
-    duration: number;
-    element: ToastElement;
+  duration: number;
+  element: ToastElement;
 };
 export type ToastProviderProps = {
-    /**
-     * An optional, global override to individual Toasts' bottomOffset prop.
-     * This value will be applied to all Toasts render via this Provider instance
-     */
-    toastBottomOffset?: ToastBaseProps['bottomOffset'];
+  /**
+   * An optional, global override to individual Toasts' bottomOffset prop.
+   * This value will be applied to all Toasts render via this Provider instance
+   */
+  toastBottomOffset?: ToastBaseProps['bottomOffset'];
 };
 export type ToastProviderStates = {
-    activeToast?: ToastNode;
-    addToast: (element: ToastNode['element'], duration: number) => void;
-    removeToast: () => void;
-    hideToast: () => void;
-    clearToastQueue: () => void;
-    pauseTimer: () => void;
-    resumeTimer: () => void;
+  activeToast?: ToastNode;
+  addToast: (element: ToastNode['element'], duration: number) => void;
+  removeToast: () => void;
+  hideToast: () => void;
+  clearToastQueue: () => void;
+  pauseTimer: () => void;
+  resumeTimer: () => void;
 };
 export declare const ToastContext: React.Context<ToastProviderStates>;
 export declare const ToastProvider: React.FC<React.PropsWithChildren<ToastProviderProps>>;
-//# sourceMappingURL=ToastProvider.d.ts.map
+//# sourceMappingURL=ToastProvider.d.ts.map

package/dts/overlays/useAlert.d.ts

@@ -2,7 +2,7 @@
  * @deprecated Use the visible and onRequestClose props as outlined in the docs here https://cds.coinbase.com/components/modal#get-started
  */
 export declare const useAlert: () => {
-    open: (content: import("./usePortalState").PortalNode["element"]) => string;
-    close: () => void;
+  open: (content: import('./usePortalState').PortalNode['element']) => string;
+  close: () => void;
 };
-//# sourceMappingURL=useAlert.d.ts.map
+//# sourceMappingURL=useAlert.d.ts.map

package/dts/overlays/useModal.d.ts

@@ -2,7 +2,7 @@
  * @deprecated Use the visible and onRequestClose props as outlined in the docs here https://cds.coinbase.com/components/modal#get-started
  */
 export declare const useModal: () => {
-    openModal: (content: import("./usePortalState").PortalNode["element"]) => string;
-    closeModal: () => void;
+  openModal: (content: import('./usePortalState').PortalNode['element']) => string;
+  closeModal: () => void;
 };
-//# sourceMappingURL=useModal.d.ts.map
+//# sourceMappingURL=useModal.d.ts.map

package/dts/overlays/useOverlay.d.ts

@@ -1,6 +1,6 @@
 import type { PortalNode } from './usePortalState';
 export declare const useOverlay: (idPrefix?: string) => {
-    open: (content: PortalNode["element"]) => string;
-    close: () => void;
+  open: (content: PortalNode['element']) => string;
+  close: () => void;
 };
-//# sourceMappingURL=useOverlay.d.ts.map
+//# sourceMappingURL=useOverlay.d.ts.map

package/dts/overlays/usePortal.d.ts

@@ -1,2 +1,2 @@
-export declare const usePortal: () => import("./PortalContext").PortalProviderStates;
-//# sourceMappingURL=usePortal.d.ts.map
+export declare const usePortal: () => import('./PortalContext').PortalProviderStates;
+//# sourceMappingURL=usePortal.d.ts.map

package/dts/overlays/usePortalState.d.ts

@@ -3,22 +3,22 @@ import type React from 'react';
  * This type defines the basic interface of a Component rendered through the PortalProvider.
  */
 export type PortalNode = {
-    id: string;
-    element: React.ReactElement<{
-        visible: boolean;
-        onDidClose: () => void;
-        children?: React.ReactNode;
-        ref?: React.Ref<{
-            onRequestClose: () => void;
-        }>;
+  id: string;
+  element: React.ReactElement<{
+    visible: boolean;
+    onDidClose: () => void;
+    children?: React.ReactNode;
+    ref?: React.Ref<{
+      onRequestClose: () => void;
     }>;
+  }>;
 };
 /**
  * This hook is used to manage the state of a set of nodes rendered through the PortalProvider.
  */
 export declare const usePortalState: () => {
-    nodes: PortalNode[];
-    addNode: (id: string, element: PortalNode["element"]) => void;
-    removeNode: (id: string) => void;
+  nodes: PortalNode[];
+  addNode: (id: string, element: PortalNode['element']) => void;
+  removeNode: (id: string) => void;
 };
-//# sourceMappingURL=usePortalState.d.ts.map
+//# sourceMappingURL=usePortalState.d.ts.map

package/dts/overlays/useToastQueue.d.ts

@@ -1,11 +1,11 @@
 import type { ToastNode } from './ToastProvider';
 export declare const useToastQueue: () => {
-    activeToast: ToastNode | undefined;
-    addToast: (element: ToastNode["element"], duration: number) => void;
-    removeToast: () => void;
-    hideToast: () => Promise<boolean | undefined>;
-    clearToastQueue: () => Promise<void>;
-    pauseTimer: () => number;
-    resumeTimer: () => void;
+  activeToast: ToastNode | undefined;
+  addToast: (element: ToastNode['element'], duration: number) => void;
+  removeToast: () => void;
+  hideToast: () => Promise<boolean | undefined>;
+  clearToastQueue: () => Promise<void>;
+  pauseTimer: () => number;
+  resumeTimer: () => void;
 };
-//# sourceMappingURL=useToastQueue.d.ts.map
+//# sourceMappingURL=useToastQueue.d.ts.map

package/dts/stepper/useStepper.d.ts

@@ -1,31 +1,31 @@
 export type BaseStepperValue = {
-    id: string;
-    subSteps?: BaseStepperValue[];
+  id: string;
+  subSteps?: BaseStepperValue[];
 };
 export type StepperOptions<StepType extends BaseStepperValue = BaseStepperValue> = {
-    /** The array of steps data. */
-    steps: StepType[];
-    /** The default active step ID. If not provided, the first step will be used. Pass null to indicate no active step initially. */
-    defaultActiveStepId?: string | null;
-    /** If true, steps containing sub-steps will never be made active.
-     * This is useful if you want the parent step to treated only as a visual grouping of steps rather than a step itself.
-     * @default false
-     */
-    skipParentSteps?: boolean;
+  /** The array of steps data. */
+  steps: StepType[];
+  /** The default active step ID. If not provided, the first step will be used. Pass null to indicate no active step initially. */
+  defaultActiveStepId?: string | null;
+  /** If true, steps containing sub-steps will never be made active.
+   * This is useful if you want the parent step to treated only as a visual grouping of steps rather than a step itself.
+   * @default false
+   */
+  skipParentSteps?: boolean;
 };
 export type StepperState = {
-    /** React state for the currently active step ID. Can be null if no step is active. */
-    activeStepId: string | null;
+  /** React state for the currently active step ID. Can be null if no step is active. */
+  activeStepId: string | null;
 };
 export type StepperApi = {
-    /** Update the currently active step to the step with `stepId`. */
-    goToStep: (stepId: string) => void;
-    /** Update the currently active step to the next enabled step in the steps array. Does nothing if the last step is already active. */
-    goNextStep: () => void;
-    /** Update the currently active step to the previous enabled step in the steps array. Does nothing if the first step is already active. */
-    goPreviousStep: () => void;
-    /** Reset the active step to the original default active step. */
-    reset: () => void;
+  /** Update the currently active step to the step with `stepId`. */
+  goToStep: (stepId: string) => void;
+  /** Update the currently active step to the next enabled step in the steps array. Does nothing if the last step is already active. */
+  goNextStep: () => void;
+  /** Update the currently active step to the previous enabled step in the steps array. Does nothing if the first step is already active. */
+  goPreviousStep: () => void;
+  /** Reset the active step to the original default active step. */
+  reset: () => void;
 };
 /**
  * A hook for managing StepperHorizontal or StepperVertical state.
@@ -37,5 +37,9 @@ export type StepperApi = {
  * @param options.skipParentSteps - If true, steps containing sub-steps will never be made active.
  * @returns A tuple where the first element is the stepper state and the second element is an API for manipulating the stepper state.
  */
-export declare const useStepper: <StepType extends BaseStepperValue = BaseStepperValue>({ steps, defaultActiveStepId, skipParentSteps, }: StepperOptions<StepType>) => [StepperState, StepperApi];
-//# sourceMappingURL=useStepper.d.ts.map
+export declare const useStepper: <StepType extends BaseStepperValue = BaseStepperValue>({
+  steps,
+  defaultActiveStepId,
+  skipParentSteps,
+}: StepperOptions<StepType>) => [StepperState, StepperApi];
+//# sourceMappingURL=useStepper.d.ts.map