vxe-table/types/switch.d.ts

import { SetupContext, RenderFunction, ComponentPublicInstance } from 'vue'
import { VXEComponent, VxeComponentBase, VxeEvent, SizeType, ValueOf } from './component'

/**
 * 组件 - 开关
 * @example import { Switch as VxeSwitch } from 'vxe-table'
 */
export const Switch: VXEComponent<VxeSwitchProps, VxeSwitchEventProps>;

export type VxeSwitchInstance = ComponentPublicInstance<VxeSwitchProps, VxeSwitchConstructor>;

export interface VxeSwitchConstructor extends VxeComponentBase, VxeSwitchMethods {
  props: VxeSwitchProps;
  context: SetupContext<VxeSwitchEmits>;
  reactData: SwitchReactData;
  renderVN: RenderFunction;
}

export interface SwitchReactData {
  isActivated: boolean;
  hasAnimat: boolean;
  offsetLeft: number;
}

export type VxeSwitchProps = {
  size?: VxeSwitchPropTypes.Size;
  modelValue?: VxeSwitchPropTypes.ModelValue;
  disabled?: VxeSwitchPropTypes.Disabled;
  openLabel?: VxeSwitchPropTypes.OpenLabel;
  closeLabel?: VxeSwitchPropTypes.CloseLabel;
  openValue?: VxeSwitchPropTypes.OpenValue;
  closeValue?: VxeSwitchPropTypes.CloseValue;
  openIcon?: VxeSwitchPropTypes.OpenIcon;
  closeIcon?: VxeSwitchPropTypes.CloseIcon;
}

export namespace VxeSwitchPropTypes {
  export type Size = SizeType;
  export type ModelValue = string | number | boolean;
  export type Disabled = boolean;
  export type OpenLabel = string;
  export type CloseLabel = string;
  export type OpenValue = string | number | boolean;
  export type CloseValue = string | number | boolean;
  export type OpenIcon = string;
  export type CloseIcon = string;
}

export interface SwitchMethods {
  dispatchEvent(type: ValueOf<VxeSwitchEmits>, params: any, evnt: Event): void;
  /**
   * 获取焦点
   */
  focus(): Promise<any>;
  /**
   * 失去焦点
   */
  blur(): Promise<any>;
}
export interface VxeSwitchMethods extends SwitchMethods { }

export interface SwitchPrivateMethods { }
export interface VxeSwitchPrivateMethods extends SwitchPrivateMethods { }

export type VxeSwitchEmits = [
  'update:modelValue',
  'change',
  'focus',
  'blur'
]

export namespace VxeSwitchDefines {
  interface SwitchEventParams extends VxeEvent {
    $switch: VxeSwitchConstructor;
  }
}

export type VxeSwitchEventProps = {}

export interface VxeSwitchListeners { }

export namespace VxeSwitchEvents { }