gg-y-ui/typings/steps.d.ts

An enterprise-class UI design language and Vue-based implementation for web

import { YUIComponent } from './component';

/** Direction type */
export type DirectionType = 'vertical' | 'horizontal';

/** Status type */
export type StatusType = 'wait' | 'process' | 'finish' | 'success';

/** Steps Component */
export declare class YSteps extends YUIComponent {
  /** Steps space */
  space: Number | String;

  /** Steps active */
  active: Number;

  /** Steps processStatus
   * process step status
   */
  processStatus: StatusType;

  /** Steps finishStatus
   * finish step status
   */
  finishStatus: StatusType;

  /** Steps displayDescription
   * When direction is 'vertical'
   * if description show
   */
  displayDescription: Boolean;

  /** Steps direction */
  direction: DirectionType;

  /** When the active changes */
  change(newVal: Number, oldVal, Number): void;
}