@yamada-ui/react/dist/types/components/steps/use-steps.d.ts

React UI components of the Yamada, by the Yamada, for the Yamada built with React and Emotion

import { Orientation } from "../../core/system/index.types.js";
import { HTMLProps, PropGetter } from "../../core/components/index.types.js";
import "../../core/index.js";
import { Descendant } from "../../hooks/use-descendants/index.js";
import "../../index.js";
import * as react2618 from "react";

//#region src/components/steps/use-steps.d.ts
type StepStatusScheme = "complete" | "current" | "incomplete";
declare const StepsDescendantsContext: react2618.Context<{
    active: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined, options?: FocusOptions) => void;
    count: () => number;
    destroy: () => void;
    enabledCount: () => number;
    enabledFirstValue: () => Descendant<HTMLLIElement, {}> | undefined;
    enabledIndexOf: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined) => number;
    enabledLastValue: () => Descendant<HTMLLIElement, {}> | undefined;
    enabledNextValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    enabledPrevValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    enabledValue: (index: number) => Descendant<HTMLLIElement, {}> | undefined;
    enabledValues: () => Descendant<HTMLLIElement, {}>[];
    firstValue: () => Descendant<HTMLLIElement, {}> | undefined;
    indexOf: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined) => number;
    lastValue: () => Descendant<HTMLLIElement, {}> | undefined;
    nextValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    prevValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    register: (props?: {
      disabled?: boolean | ((node: HTMLLIElement) => boolean) | undefined;
    } | undefined) => react2618.RefCallback<HTMLLIElement>;
    unregister: (node?: HTMLLIElement | null | undefined) => void;
    value: (indexOrNode: number | HTMLLIElement | null) => Descendant<HTMLLIElement, {}> | undefined;
    values: () => Descendant<HTMLLIElement, {}>[];
  }>, useStepsDescendant: (props?: {
    disabled?: boolean | ((node: HTMLLIElement) => boolean) | undefined;
  } | undefined) => {
    descendants: {
      active: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined, options?: FocusOptions) => void;
      count: () => number;
      destroy: () => void;
      enabledCount: () => number;
      enabledFirstValue: () => Descendant<HTMLLIElement, {}> | undefined;
      enabledIndexOf: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined) => number;
      enabledLastValue: () => Descendant<HTMLLIElement, {}> | undefined;
      enabledNextValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
      enabledPrevValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
      enabledValue: (index: number) => Descendant<HTMLLIElement, {}> | undefined;
      enabledValues: () => Descendant<HTMLLIElement, {}>[];
      firstValue: () => Descendant<HTMLLIElement, {}> | undefined;
      indexOf: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined) => number;
      lastValue: () => Descendant<HTMLLIElement, {}> | undefined;
      nextValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
      prevValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
      register: (props?: {
        disabled?: boolean | ((node: HTMLLIElement) => boolean) | undefined;
      } | undefined) => react2618.RefCallback<HTMLLIElement>;
      unregister: (node?: HTMLLIElement | null | undefined) => void;
      value: (indexOrNode: number | HTMLLIElement | null) => Descendant<HTMLLIElement, {}> | undefined;
      values: () => Descendant<HTMLLIElement, {}>[];
    };
    register: react2618.RefCallback<HTMLLIElement>;
  }, useStepsDescendants: () => {
    active: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined, options?: FocusOptions) => void;
    count: () => number;
    destroy: () => void;
    enabledCount: () => number;
    enabledFirstValue: () => Descendant<HTMLLIElement, {}> | undefined;
    enabledIndexOf: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined) => number;
    enabledLastValue: () => Descendant<HTMLLIElement, {}> | undefined;
    enabledNextValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    enabledPrevValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    enabledValue: (index: number) => Descendant<HTMLLIElement, {}> | undefined;
    enabledValues: () => Descendant<HTMLLIElement, {}>[];
    firstValue: () => Descendant<HTMLLIElement, {}> | undefined;
    indexOf: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined) => number;
    lastValue: () => Descendant<HTMLLIElement, {}> | undefined;
    nextValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    prevValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    register: (props?: {
      disabled?: boolean | ((node: HTMLLIElement) => boolean) | undefined;
    } | undefined) => react2618.RefCallback<HTMLLIElement>;
    unregister: (node?: HTMLLIElement | null | undefined) => void;
    value: (indexOrNode: number | HTMLLIElement | null) => Descendant<HTMLLIElement, {}> | undefined;
    values: () => Descendant<HTMLLIElement, {}>[];
  };
interface StepsContext extends Omit<UseStepsReturn, "descendants" | "getRootProps"> {}
declare const StepsContext: react2618.Context<StepsContext>, useStepsContext: () => StepsContext;
interface StepsItemContext extends Omit<UseStepsItemReturn, "getRootProps"> {}
declare const StepsItemContext: react2618.Context<StepsItemContext>, useStepsItemContext: () => StepsItemContext;
interface UseStepsProps extends Omit<HTMLProps, "onChange"> {
  /**
   * The total number of steps.
   */
  count?: number;
  /**
   * The initial index of the active step.
   *
   * @default 0
   */
  defaultIndex?: number;
  /**
   * The index of the active step.
   */
  index?: number;
  /**
   * The orientation of the steps.
   *
   * @default 'horizontal'
   */
  orientation?: Orientation;
  /**
   * The callback function that is called when the active step index is changed.
   */
  onChange?: (index: number) => void;
}
declare const useSteps: ({
  count,
  defaultIndex,
  index: indexProp,
  orientation,
  onChange,
  ...rest
}?: UseStepsProps) => {
  id: string;
  count: number;
  descendants: {
    active: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined, options?: FocusOptions) => void;
    count: () => number;
    destroy: () => void;
    enabledCount: () => number;
    enabledFirstValue: () => Descendant<HTMLLIElement, {}> | undefined;
    enabledIndexOf: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined) => number;
    enabledLastValue: () => Descendant<HTMLLIElement, {}> | undefined;
    enabledNextValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    enabledPrevValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    enabledValue: (index: number) => Descendant<HTMLLIElement, {}> | undefined;
    enabledValues: () => Descendant<HTMLLIElement, {}>[];
    firstValue: () => Descendant<HTMLLIElement, {}> | undefined;
    indexOf: (target?: HTMLLIElement | Descendant<HTMLLIElement, {}> | null | undefined) => number;
    lastValue: () => Descendant<HTMLLIElement, {}> | undefined;
    nextValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    prevValue: (indexOrNode: number | HTMLLIElement | Descendant<HTMLLIElement, {}> | null, loop?: boolean) => Descendant<HTMLLIElement, {}> | undefined;
    register: (props?: {
      disabled?: boolean | ((node: HTMLLIElement) => boolean) | undefined;
    } | undefined) => react2618.RefCallback<HTMLLIElement>;
    unregister: (node?: HTMLLIElement | null | undefined) => void;
    value: (indexOrNode: number | HTMLLIElement | null) => Descendant<HTMLLIElement, {}> | undefined;
    values: () => Descendant<HTMLLIElement, {}>[];
  };
  getStatus: (indexProp: number) => StepStatusScheme;
  index: number;
  orientation: Orientation;
  setIndex: react2618.Dispatch<react2618.SetStateAction<number>>;
  getContentProps: PropGetter<"div", {
    index?: number;
  }, undefined>;
  getListProps: PropGetter<"ol", undefined, undefined>;
  getNextTriggerProps: PropGetter<"button", undefined, undefined>;
  getPrevTriggerProps: PropGetter<"button", undefined, undefined>;
  getRootProps: PropGetter<"div", undefined, undefined>;
  onNext: () => void;
  onPrev: () => void;
};
type UseStepsReturn = ReturnType<typeof useSteps>;
interface UseStepsItemProps extends HTMLProps<"li"> {
  /**
   * The index of the step.
   */
  index: number;
}
declare const useStepsItem: ({
  "aria-labelledby": ariaLabelledbyProp,
  index,
  ...rest
}: UseStepsItemProps) => {
  first: boolean;
  index: number;
  last: boolean;
  status: StepStatusScheme;
  getDescriptionProps: PropGetter<"p", undefined, undefined>;
  getIndicatorProps: PropGetter<"div", undefined, undefined>;
  getRootProps: PropGetter<"li", undefined, undefined>;
  getSeparatorProps: PropGetter<"div", undefined, undefined>;
  getTitleProps: PropGetter<"h3", undefined, undefined>;
};
type UseStepsItemReturn = ReturnType<typeof useStepsItem>;
//#endregion
export { StepStatusScheme, StepsContext, StepsDescendantsContext, StepsItemContext, UseStepsItemProps, UseStepsItemReturn, UseStepsProps, UseStepsReturn, useSteps, useStepsContext, useStepsDescendant, useStepsDescendants, useStepsItem, useStepsItemContext };
//# sourceMappingURL=use-steps.d.ts.map