vxe-pc-ui 0.0.2 → 0.1.0

package/types/components/select.d.ts

@@ -0,0 +1,274 @@
+import { RenderFunction, SetupContext, Ref, ComponentPublicInstance } from 'vue'
+import { defineVxeComponent, VxeComponentBase, VxeComponentEvent, VxeComponentSize, VxeComponentStyle, ValueOf } from '../tool'
+import { VxeGlobalRendererHandles } from '../ui'
+import { VxeOptgroupProps } from './optgroup'
+import { VxeOptionProps, VxeOptionPropTypes } from './option'
+
+/* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
+
+export declare const VxeSelect: defineVxeComponent<VxeSelectProps, VxeSelectEventProps>
+
+export type VxeSelectInstance = ComponentPublicInstance<VxeSelectProps, VxeSelectConstructor>
+
+export interface VxeSelectConstructor extends VxeComponentBase, VxeSelectMethods {
+  props: VxeSelectProps
+  context: SetupContext<VxeSelectEmits>
+  reactData: SelectReactData
+  getRefMaps(): SelectPrivateRef
+  getComputeMaps(): SelectPrivateComputed
+  renderVN: RenderFunction
+}
+
+export interface SelectPrivateRef {
+  refElem: Ref<HTMLDivElement | undefined>
+}
+export interface VxeSelectPrivateRef extends SelectPrivateRef { }
+
+export namespace VxeSelectPropTypes {
+  export type Size = VxeComponentSize
+  export type ModelValue = any
+  export type Clearable = boolean
+  export type Placeholder = string
+  export type Loading = boolean
+  export type Disabled = boolean
+  export type ClassName = string | ((params: { $select: VxeSelectConstructor }) => string)
+  export type PopupClassName = string | ((params: { $select: VxeSelectConstructor }) => string)
+  export type Multiple = boolean
+  export type MultiCharOverflow = number | string
+  export type PrefixIcon = string
+  export type Placement = string
+  export type Options = VxeSelectDefines.SelectOptions[]
+  export type OptionProps = VxeGlobalRendererHandles.RenderOptionProps
+  export type OptionGroups = VxeSelectDefines.SelectOptgroups[]
+  export type OptionGroupProps = VxeGlobalRendererHandles.RenderOptionGroupProps
+  export type Filterable = boolean
+  export type FilterMethod = (params: { group: any, option: any, searchValue: string }) => boolean
+  export type Remote = boolean
+  export type RemoteMethod = (params: { searchValue: string }) => Promise<void> | void
+  export type Max = number | string
+  /**
+   * 选项配置项
+   */
+  export interface OptionConfig {
+    useKey?: boolean
+    keyField?: string
+  }
+  export type EmptyText = string
+  export type OptionId = string
+  export type OptionKey = boolean
+  export type Transfer = boolean
+}
+
+export type VxeSelectProps = {
+  size?: VxeSelectPropTypes.Size
+  modelValue?: VxeSelectPropTypes.ModelValue
+  clearable?: VxeSelectPropTypes.Clearable
+  placeholder?: VxeSelectPropTypes.Placeholder
+  loading?: VxeSelectPropTypes.Loading
+  disabled?: VxeSelectPropTypes.Disabled
+  className?: VxeSelectPropTypes.ClassName
+  popupClassName?: VxeSelectPropTypes.PopupClassName
+  multiple?: VxeSelectPropTypes.Multiple
+  multiCharOverflow?: VxeSelectPropTypes.MultiCharOverflow
+  prefixIcon?: VxeSelectPropTypes.PrefixIcon
+  placement?: VxeSelectPropTypes.Placement
+  options?: VxeSelectPropTypes.Options
+  optionProps?: VxeSelectPropTypes.OptionProps
+  optionGroups?: VxeSelectPropTypes.OptionGroups
+  optionGroupProps?: VxeSelectPropTypes.OptionGroupProps
+  optionConfig?: VxeSelectPropTypes.OptionConfig
+  emptyText?: VxeSelectPropTypes.EmptyText
+  filterable?: VxeSelectPropTypes.Filterable
+  filterMethod?: VxeSelectPropTypes.FilterMethod
+  remote?: VxeSelectPropTypes.Remote
+  remoteMethod?: VxeSelectPropTypes.RemoteMethod
+  max?: VxeSelectPropTypes.Max
+  /**
+   * 已废弃，被 optionConfig.keyField 替换
+   * @deprecated
+   */
+  optionId?: VxeSelectPropTypes.OptionId
+  /**
+   * 已废弃，被 optionConfig.useKey 替换
+   * @deprecated
+   */
+  optionKey?: VxeSelectPropTypes.OptionKey
+  transfer?: VxeSelectPropTypes.Transfer
+}
+
+export interface SelectPrivateComputed {
+}
+export interface VxeSelectPrivateComputed extends SelectPrivateComputed { }
+
+export interface SelectReactData {
+  inited: boolean
+  staticOptions: VxeSelectDefines.OptionInfo[]
+  fullGroupList: any[]
+  fullOptionList: any[]
+  visibleGroupList: any[]
+  visibleOptionList: any[]
+  remoteValueList: {
+    key: string
+    result: any
+  }[]
+  panelIndex: number
+  panelStyle: VxeComponentStyle
+  panelPlacement: any
+  currentOption: any
+  currentValue: any
+  visiblePanel: boolean
+  animatVisible: boolean
+  isActivated: boolean
+  searchValue: string,
+  searchLoading: boolean
+}
+
+export interface SelectMethods {
+  dispatchEvent(type: ValueOf<VxeSelectEmits>, params: any, evnt?: Event): void
+  /**
+   * 判断下拉面板是否可视
+   */
+  isPanelVisible(): boolean
+  /**
+   * 切换下拉面板
+   */
+  togglePanel(): Promise<any>
+  /**
+   * 显示下拉面板
+   */
+  showPanel(): Promise<any>
+  /**
+   * 隐藏下拉面板
+   */
+  hidePanel(): Promise<any>
+  /**
+   * 刷新选项，当选项被动态显示/隐藏时可能会用到
+   */
+  refreshOption(): Promise<any>
+  /**
+   * 获取焦点
+   */
+  focus(): Promise<any>
+  /**
+   * 失去焦点
+   */
+  blur(): Promise<any>
+}
+export interface VxeSelectMethods extends SelectMethods { }
+
+export interface SelectPrivateMethods { }
+export interface VxeSelectPrivateMethods extends SelectPrivateMethods { }
+
+export type VxeSelectEmits = [
+  'update:modelValue',
+  'change',
+  'clear',
+  'blur',
+  'focus'
+]
+
+export namespace VxeSelectDefines {
+  export class OptionInfo {
+    id: string
+
+    value: any
+    label: VxeOptionPropTypes.Label
+    visible: VxeOptionPropTypes.Visible
+    className: VxeOptionPropTypes.ClassName
+    disabled: VxeOptionPropTypes.Disabled
+
+    options: OptionInfo[]
+  }
+
+  export interface SelectOptions extends VxeOptionProps {
+    slots?: VxeOptionPropTypes.Slots
+  }
+
+  export interface SelectOptgroups extends VxeOptgroupProps {
+    options?: VxeOptionProps[]
+    slots?: VxeOptionPropTypes.Slots
+  }
+
+  interface SelectEventParams extends VxeComponentEvent {
+    $select: VxeSelectConstructor
+  }
+
+  export interface ChangeParams {
+    value: any
+  }
+  export interface ChangeEventParams extends SelectEventParams, ChangeParams { }
+
+  export interface ClearParams {
+    value: any
+  }
+  export interface ClearEventParams extends SelectEventParams, ClearParams { }
+
+  export interface FocusEventParams extends SelectEventParams { }
+  export interface BlurEventParams extends SelectEventParams { }
+}
+
+export type VxeSelectEventProps = {
+  onChange?: VxeSelectEvents.Change
+  onClear?: VxeSelectEvents.Clear
+  onFocus?: VxeSelectEvents.Focus
+  onBlur?: VxeSelectEvents.Blur
+}
+
+export interface VxeSelectListeners {
+  change?: VxeSelectEvents.Change
+  clear?: VxeSelectEvents.Clear
+  focus?: VxeSelectEvents.Focus
+  blur?: VxeSelectEvents.Blur
+}
+
+export namespace VxeSelectEvents {
+  export type Change = (params: VxeSelectDefines.ChangeEventParams) => void
+  export type Clear = (params: VxeSelectDefines.ClearEventParams) => void
+  export type Focus = (params: VxeSelectDefines.FocusEventParams) => void
+  export type Blur = (params: VxeSelectDefines.BlurEventParams) => void
+}
+
+export namespace VxeSelectSlotTypes {
+  export interface DefaultSlotParams {}
+}
+
+export interface VxeSelectSlots {
+  /**
+   * 自定义前缀图标模板
+   */
+  prefix: (params: {
+    [key: string]: any
+  }) => any
+  /**
+   * 自定义弹窗容器头部模板
+   */
+  header: (params: {
+    [key: string]: any
+  }) => any
+  /**
+   * 自定义弹窗容器选项模板
+   */
+  option: ((params: {
+    option: any
+    group: any
+    [key: string]: any
+  }) => any) | undefined
+  /**
+   * 自定义弹窗容器底部模板
+   */
+  footer: ((params: {
+    [key: string]: any
+  }) => any) | undefined
+
+  /**
+   * 自定义插槽模板
+   */
+  [key: string]: ((params: {
+    option: any
+    group: any
+    [key: string]: any
+  }) => any) | undefined
+}
+
+export const Select: typeof VxeSelect
+export default VxeSelect

package/types/components/switch.d.ts

@@ -0,0 +1,118 @@
+import { RenderFunction, SetupContext, Ref, ComponentPublicInstance } from 'vue'
+import { defineVxeComponent, VxeComponentBase, VxeComponentEvent, VxeComponentSize, ValueOf } from '../tool'
+
+/* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
+
+export declare const VxeSwitch: defineVxeComponent<VxeSwitchProps, VxeSwitchEventProps>
+
+export type VxeSwitchInstance = ComponentPublicInstance<VxeSwitchProps, VxeSwitchConstructor>
+
+export interface VxeSwitchConstructor extends VxeComponentBase, VxeSwitchMethods {
+  props: VxeSwitchProps
+  context: SetupContext<VxeSwitchEmits>
+  reactData: SwitchReactData
+  getRefMaps(): SwitchPrivateRef
+  getComputeMaps(): SwitchPrivateComputed
+  renderVN: RenderFunction
+}
+
+export interface SwitchPrivateRef {
+  refElem: Ref<HTMLDivElement | undefined>
+}
+export interface VxeSwitchPrivateRef extends SwitchPrivateRef { }
+
+export namespace VxeSwitchPropTypes {
+  export type Size = VxeComponentSize
+  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 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 interface SwitchPrivateComputed {
+}
+export interface VxeSwitchPrivateComputed extends SwitchPrivateComputed { }
+
+export interface SwitchReactData {
+  isActivated: boolean
+  hasAnimat: boolean
+  offsetLeft: number
+}
+
+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 VxeComponentEvent {
+    $switch: VxeSwitchConstructor
+  }
+
+  export interface ChangeEventParams extends SwitchEventParams { }
+  export interface FocusEventParams extends SwitchEventParams { }
+  export interface BlurEventParams extends SwitchEventParams { }
+}
+
+export type VxeSwitchEventProps = {
+  onChange?: VxeSwitchEvents.Change
+  onFocus?: VxeSwitchEvents.Focus
+  onBlur?: VxeSwitchEvents.Blur
+}
+
+export interface VxeSwitchListeners {
+  change?: VxeSwitchEvents.Change
+  focus?: VxeSwitchEvents.Focus
+  blur?: VxeSwitchEvents.Blur
+}
+
+export namespace VxeSwitchEvents {
+  export type Change = (params: VxeSwitchDefines.ChangeEventParams) => void
+  export type Focus = (params: VxeSwitchDefines.FocusEventParams) => void
+  export type Blur = (params: VxeSwitchDefines.BlurEventParams) => void
+}
+
+export namespace VxeSwitchSlotTypes {
+  export interface DefaultSlotParams {}
+}
+
+export interface VxeSwitchSlots {
+  default: (params: VxeSwitchSlotTypes.DefaultSlotParams) => any
+}
+
+export const Switch: typeof VxeSwitch
+export default VxeSwitch

package/types/components/textarea.d.ts

@@ -0,0 +1,212 @@
+import { RenderFunction, SetupContext, Ref, ComponentPublicInstance } from 'vue'
+import { defineVxeComponent, VxeComponentBase, VxeComponentEvent, VxeComponentSize, ValueOf } from '../tool'
+
+/* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
+
+export declare const VxeTextarea: defineVxeComponent<VxeTextareaProps, VxeTextareaEventProps>
+
+export type VxeTextareaInstance = ComponentPublicInstance<VxeTextareaProps, VxeTextareaConstructor>
+
+export interface VxeTextareaConstructor extends VxeComponentBase, VxeTextareaMethods {
+  props: VxeTextareaProps
+  context: SetupContext<VxeTextareaEmits>
+  reactData: TextareaReactData
+  getRefMaps(): TextareaPrivateRef
+  getComputeMaps(): TextareaPrivateComputed
+  renderVN: RenderFunction
+}
+
+export interface TextareaPrivateRef {
+  refElem: Ref<HTMLDivElement | undefined>
+  refTextarea: Ref<HTMLTextAreaElement>
+}
+export interface VxeTextareaPrivateRef extends TextareaPrivateRef { }
+
+export namespace VxeTextareaPropTypes {
+  export type Size = VxeComponentSize
+  export type ModelValue = string | number
+  export type ClassName = string
+  export type Immediate = boolean
+  export type Name = string
+  export type Readonly = boolean
+  export type Disabled = boolean
+  export type Placeholder = string
+  export type Maxlength = string | number
+  export type Rows = string | number
+  export type Cols = string | number
+  export type ShowWordCount = boolean
+  export type CountMethod = (params: {
+    value: string
+  }) => number
+  export type Autosize = {
+    minRows?: number
+    maxRows?: number
+  }
+  export type Form = string
+  export type Resize = string
+}
+
+export type VxeTextareaProps = {
+  size?: VxeTextareaPropTypes.Size
+  /**
+   * 绑定值
+   */
+  modelValue?: VxeTextareaPropTypes.ModelValue
+  className?: VxeTextareaPropTypes.ClassName
+  immediate?: VxeTextareaPropTypes.Immediate
+  /**
+   * 原生 name 属性
+   */
+  name?: VxeTextareaPropTypes.Name
+  /**
+   * 是否只读
+   */
+  readonly?: VxeTextareaPropTypes.Readonly
+  /**
+   * 是否禁用
+   */
+  disabled?: VxeTextareaPropTypes.Disabled
+  /**
+   * 当值为空时，显示的占位符
+   */
+  placeholder?: VxeTextareaPropTypes.Placeholder
+  /**
+   * 最大长度
+   */
+  maxlength?: VxeTextareaPropTypes.Maxlength
+  /**
+   * 原生 rows 属性
+   */
+  rows?: VxeTextareaPropTypes.Rows
+  /**
+   * 原生 cols 属性
+   */
+  cols?: VxeTextareaPropTypes.Cols
+  /**
+   * 是否显示字数统计
+   */
+  showWordCount?: VxeTextareaPropTypes.ShowWordCount
+  /**
+   * 自定义字数统计方法
+   */
+  countMethod?: VxeTextareaPropTypes.CountMethod
+  /**
+   * 自适应文本高度
+   */
+  autosize?: VxeTextareaPropTypes.Autosize
+  /**
+   * 原生 form 属性
+   */
+  form?: VxeTextareaPropTypes.Form
+  /**
+   * 调整文本域大小的方式
+   */
+  resize?: VxeTextareaPropTypes.Resize
+}
+
+export interface TextareaPrivateComputed {
+}
+export interface VxeTextareaPrivateComputed extends TextareaPrivateComputed { }
+
+export interface TextareaReactData {
+  inputValue: any
+}
+
+export interface TextareaMethods {
+  dispatchEvent(type: ValueOf<VxeTextareaEmits>, params: any, evnt: Event): void
+  /**
+   * 获取焦点
+   */
+  focus(): Promise<any>
+  /**
+   * 失去焦点
+   */
+  blur(): Promise<any>
+}
+export interface VxeTextareaMethods extends TextareaMethods { }
+
+export interface TextareaPrivateMethods { }
+export interface VxeTextareaPrivateMethods extends TextareaPrivateMethods { }
+
+export type VxeTextareaEmits = [
+  'update:modelValue',
+  'input',
+  'keydown',
+  'keyup',
+  'click',
+  'change',
+  'focus',
+  'blur'
+]
+
+export namespace VxeTextareaDefines {
+  export interface TextareaEventParams extends VxeComponentEvent {
+    $textarea: VxeTextareaConstructor
+  }
+
+  export interface InputParams {
+    value: string
+  }
+  export interface InputEventParams extends TextareaEventParams, InputParams { }
+
+  export interface ChangeParams extends InputParams {}
+  export interface ChangeEventParams extends TextareaEventParams, ChangeParams { }
+
+  export interface KeyupParams extends InputParams {}
+  export interface KeyupEventParams extends TextareaEventParams, KeyupParams { }
+
+  export interface KeydownParams extends InputParams {}
+  export interface KeydownEventParams extends TextareaEventParams, KeydownParams { }
+
+  export interface ClickParams extends InputParams {}
+  export interface ClickEventParams extends TextareaEventParams, ClickParams { }
+
+  export interface FocusParams extends InputParams {}
+  export interface FocusEventParams extends TextareaEventParams, FocusParams { }
+
+  export interface BlurParams extends InputParams {}
+  export interface BlurEventParams extends TextareaEventParams, BlurParams { }
+}
+
+export type VxeTextareaEventProps = {
+  onInput?: VxeTextareaEvents.Input
+  onChange?: VxeTextareaEvents.Change
+  onKeydown?: VxeTextareaEvents.Keydown
+  onKeyup?: VxeTextareaEvents.Keyup
+  onClick?: VxeTextareaEvents.Click
+  onFocus?: VxeTextareaEvents.Focus
+  onBlur?: VxeTextareaEvents.Blur
+}
+
+export interface VxeTextareaListeners {
+  input?: VxeTextareaEvents.Input
+  change?: VxeTextareaEvents.Change
+  keydown?: VxeTextareaEvents.Keydown
+  keyup?: VxeTextareaEvents.Keyup
+  click?: VxeTextareaEvents.Click
+  focus?: VxeTextareaEvents.Focus
+  blur?: VxeTextareaEvents.Blur
+}
+
+export namespace VxeTextareaEvents {
+  export type Input = (params: VxeTextareaDefines.InputEventParams) => void
+  export type Change = (params: VxeTextareaDefines.ChangeEventParams) => void
+  export type Keydown = (params: VxeTextareaDefines.KeydownEventParams) => void
+  export type Keyup = (params: VxeTextareaDefines.KeyupEventParams) => void
+  export type Click = (params: VxeTextareaDefines.ClickEventParams) => void
+  export type Focus = (params: VxeTextareaDefines.FocusEventParams) => void
+  export type Blur = (params: VxeTextareaDefines.BlurEventParams) => void
+}
+
+export namespace VxeTextareaSlotTypes {
+  export interface DefaultSlotParams {
+    [key: string]: any
+  }
+}
+
+export interface VxeTextareaSlots {
+  default: (params: VxeTextareaSlotTypes.DefaultSlotParams) => any
+}
+
+export const Textarea: typeof VxeTextarea
+export default VxeTextarea