@cdx-ui/primitives 0.3.5 → 0.3.7

package/src/stepper/types.ts

@@ -0,0 +1,104 @@
+import type { ViewProps } from 'react-native';
+
+export type StepperOrientation = 'horizontal' | 'vertical';
+
+export type StepperLabelPlacement = 'end' | 'bottom';
+
+export interface StepperStepState {
+  /** Zero-based position among the steps. */
+  readonly index: number;
+  /** Number of steps rendered. */
+  readonly count: number;
+  readonly isCurrent: boolean;
+  /** Resolved completion: the explicit `isComplete`, or `index < currentStep`. */
+  readonly isComplete: boolean;
+  /** Clamped to 0–100. Non-finite values are 0. */
+  readonly progress: number;
+  /** True when the partial ring is drawn: `0 < progress` and not complete. */
+  readonly hasProgress: boolean;
+  readonly isLast: boolean;
+  /** True when the step renders as a button. */
+  readonly isClickable: boolean;
+  readonly isDisabled: boolean;
+  readonly orientation: StepperOrientation;
+  readonly labelPlacement: StepperLabelPlacement;
+}
+
+export interface InterfaceStepperProps extends ViewProps {
+  /**
+   * Controlled, zero-based current step. A value outside `0…count-1` means no step is
+   * current; a value `>= count` makes every step complete by default.
+   */
+  readonly currentStep?: number;
+  /**
+   * Uncontrolled starting step. Ignored when `currentStep` is set.
+   * @default 0
+   */
+  readonly defaultStep?: number;
+  /** Called with the pressed step's index. Setting it makes eligible steps clickable. */
+  readonly onStepChange?: (index: number) => void;
+  /**
+   * When `true`, only complete steps are clickable. When `false`, every non-current,
+   * non-disabled step is.
+   * @default true
+   */
+  readonly isLinear?: boolean;
+  /**
+   * `'horizontal'` lays the steps out in a row. `labelPlacement` chooses where each label sits.
+   * @default 'vertical'
+   */
+  readonly orientation?: StepperOrientation;
+  /**
+   * Horizontal only; ignored when `orientation` is `'vertical'`. `'end'` puts each label after
+   * its indicator, sizes steps to their labels and stretches the separators between them.
+   * `'bottom'` gives every step an equal column with the indicator and label centered.
+   * @default 'end'
+   */
+  readonly labelPlacement?: StepperLabelPlacement;
+  /**
+   * Returns the state phrase appended to each step's title for assistive technology,
+   * replacing the English default (for example `"current step, 40% complete"`).
+   */
+  readonly getStepAccessibilityText?: (state: StepperStepState) => string;
+  /** @default false */
+  readonly asChild?: boolean;
+}
+
+export type IStepperProps = InterfaceStepperProps;
+
+export interface InterfaceStepperStepProps extends ViewProps {
+  /**
+   * Whether the step is complete. An explicit value wins in both directions.
+   * @default index < currentStep
+   */
+  readonly isComplete?: boolean;
+  /**
+   * Partial progress, 0–100. Values outside the range are clamped; non-finite values are `0`.
+   * @default 0
+   */
+  readonly progress?: number;
+  /**
+   * Only affects clickability. A disabled step still shows its state.
+   * @default false
+   */
+  readonly isDisabled?: boolean;
+  /** @default false */
+  readonly asChild?: boolean;
+}
+
+export type IStepperStepProps = InterfaceStepperStepProps;
+
+export type IStepperStepTriggerProps = ViewProps;
+
+export interface StepperContextValue {
+  /** Resolved current step (controlled or uncontrolled). */
+  readonly currentStep: number;
+  readonly count: number;
+  readonly orientation: StepperOrientation;
+  readonly labelPlacement: StepperLabelPlacement;
+  readonly isLinear: boolean;
+  /** True when the consumer passed `onStepChange`. */
+  readonly hasStepChangeHandler: boolean;
+  readonly setCurrentStep: (index: number) => void;
+  readonly getStepAccessibilityText: (state: StepperStepState) => string;
+}