vxe-pc-ui 0.0.2 → 0.1.0

package/types/components/modal.d.ts

@@ -0,0 +1,381 @@
+import { RenderFunction, SetupContext, Ref, ComponentPublicInstance } from 'vue'
+import { defineVxeComponent, VxeComponentSize, VxeComponentBase, VxeComponentEvent, ValueOf, VxeComponentSlot } from '../tool'
+
+/* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
+
+export declare const VxeModal: defineVxeComponent<VxeModalProps, VxeModalEventProps>
+
+export type VxeModalInstance = ComponentPublicInstance<VxeModalProps, VxeModalConstructor>
+
+export interface VxeModalConstructor extends VxeComponentBase, VxeModalMethods {
+  props: VxeModalProps
+  context: SetupContext<VxeModalEmits>
+  reactData: ModalReactData
+  getRefMaps(): ModalPrivateRef
+  getComputeMaps(): ModalPrivateComputed
+  renderVN: RenderFunction
+}
+
+export interface ModalPrivateRef {
+  refElem: Ref<HTMLDivElement | undefined>
+}
+export interface VxeModalPrivateRef extends ModalPrivateRef { }
+
+/**
+ * 窗口类型
+ */
+export type ModalType = 'alert' | 'confirm' | 'message' | 'modal'
+/**
+ * 窗口状态
+ */
+export type ModalStatus = 'info' | 'success' | 'warning' | 'question' | 'error' | 'loading'
+
+export type ModalPosition = {
+  top?: number
+  left?: number
+}
+
+/**
+ * 窗口事件类型
+ */
+export type ModalEventTypes = 'model' | 'mask' | 'close' | 'confirm' | 'cancel' | 'exit' | 'exist'
+
+export namespace VxeModalPropTypes {
+  export type Size = VxeComponentSize
+  export type ModelValue = boolean
+  export type ID = string | null
+  export type Type = ModalType
+  export type Loading = boolean
+  export type Status = ModalStatus
+  export type IconStatus = string
+  export type ClassName = string
+  export type Top = number | string
+  export type Position = 'center' | ModalPosition
+  export type Title = string | number
+  export type Duration = number | string
+  export type Content = number | string | null
+  /**
+   * 请使用 content
+   * @deprecated
+   */
+  export type Message = Content
+  export type CancelButtonText = string
+  export type ConfirmButtonText = string
+  export type LockView = boolean
+  export type LockScroll = boolean
+  export type Mask = boolean
+  export type MaskClosable = boolean
+  export type EscClosable = boolean
+  export type Resize = boolean
+  export type ShowHeader = boolean
+  export type ShowFooter = boolean
+  export type ShowZoom = boolean
+  export type ShowClose = boolean
+  export type DblclickZoom = boolean
+  export type Width = number | string
+  export type Height = number | string
+  export type MinWidth = number | string
+  export type MinHeight = number | string
+  export type ZIndex = number
+  export type MarginSize = number | string
+  export type Fullscreen = boolean
+  export type Draggable = boolean
+  export type Remember = boolean
+  export type DestroyOnClose = boolean
+  export type ShowTitleOverflow = boolean
+  export type Transfer = boolean
+  export type Storage = boolean
+  export type StorageKey = string
+  export type Animat = boolean
+  export type BeforeHideMethod = (params: ModalVisibleParams) => Promise<any>
+  export type Slots = VxeModalSlots
+}
+
+export type VxeModalProps = {
+  size?: VxeModalPropTypes.Size
+  modelValue?: VxeModalPropTypes.ModelValue
+  id?: VxeModalPropTypes.ID
+  type?: VxeModalPropTypes.Type
+  loading?: VxeModalPropTypes.Loading
+  status?: VxeModalPropTypes.Status
+  iconStatus?: VxeModalPropTypes.IconStatus
+  className?: VxeModalPropTypes.ClassName
+  top?: VxeModalPropTypes.Top
+  position?: VxeModalPropTypes.Position
+  title?: VxeModalPropTypes.Title
+  duration?: VxeModalPropTypes.Duration
+  content?: VxeModalPropTypes.Content
+  cancelButtonText?: VxeModalPropTypes.CancelButtonText
+  confirmButtonText?: VxeModalPropTypes.ConfirmButtonText
+  lockView?: VxeModalPropTypes.LockView
+  lockScroll?: VxeModalPropTypes.LockScroll
+  mask?: VxeModalPropTypes.Mask
+  maskClosable?: VxeModalPropTypes.MaskClosable
+  escClosable?: VxeModalPropTypes.EscClosable
+  resize?: VxeModalPropTypes.Resize
+  showHeader?: VxeModalPropTypes.ShowHeader
+  showFooter?: VxeModalPropTypes.ShowFooter
+  showZoom?: VxeModalPropTypes.ShowZoom
+  showClose?: VxeModalPropTypes.ShowClose
+  dblclickZoom?: VxeModalPropTypes.DblclickZoom
+  draggable?: VxeModalPropTypes.Draggable
+  width?: VxeModalPropTypes.Width
+  height?: VxeModalPropTypes.Height
+  minWidth?: VxeModalPropTypes.MinWidth
+  minHeight?: VxeModalPropTypes.MinHeight
+  zIndex?: VxeModalPropTypes.ZIndex
+  marginSize?: VxeModalPropTypes.MarginSize
+  fullscreen?: VxeModalPropTypes.Fullscreen
+  remember?: VxeModalPropTypes.Remember
+  destroyOnClose?: VxeModalPropTypes.DestroyOnClose
+  showTitleOverflow?: VxeModalPropTypes.ShowTitleOverflow
+  transfer?: VxeModalPropTypes.Transfer
+  storage?: VxeModalPropTypes.Storage
+  storageKey?: VxeModalPropTypes.StorageKey
+  animat?: VxeModalPropTypes.Animat
+  beforeHideMethod?: VxeModalPropTypes.BeforeHideMethod
+  slots?: VxeModalPropTypes.Slots
+  /**
+   * @deprecated 已废弃，请使用 content
+   */
+  message?: VxeModalPropTypes.Content
+}
+
+export interface ModalPrivateComputed {
+}
+export interface VxeModalPrivateComputed extends ModalPrivateComputed { }
+
+export interface ModalReactData {
+  inited: boolean
+  visible: boolean
+  contentVisible: boolean
+  modalTop: number
+  modalZindex: number
+  zoomLocat: {
+    left: number
+    top: number
+    width: number
+    height: number
+  } | null
+  firstOpen: boolean
+}
+
+export interface ModalMethods {
+  dispatchEvent(type: ValueOf<VxeModalEmits>, params: any, evnt?: Event): void
+  /**
+   * 手动打开窗口
+   */
+  open(): Promise<any>
+  /**
+   * 手动关闭窗口
+   */
+  close(): Promise<any>
+  /**
+   * 获取当前窗口元素
+   */
+  getBox(): HTMLElement
+  /**
+   * 获取窗口位置
+   */
+  getPosition(): {
+    top?: number
+    left?: number
+  } | null
+  /**
+   * 设置窗口位置
+   */
+  setPosition(top?: number, left?: number): Promise<any>
+  /**
+   * 判断是否最大化显示
+   */
+  isMaximized(): boolean
+  /**
+   * 切换窗口最大化/还原
+   */
+  zoom(): Promise<boolean>
+  /**
+   * 如果窗口处于常规状态，则最大化窗口
+   */
+  maximize(): Promise<any>
+  /**
+   * 如果窗口处于最大化状态，则还原窗口
+   */
+  revert(): Promise<any>
+}
+export interface VxeModalMethods extends ModalMethods { }
+
+export interface ModalPrivateMethods { }
+export interface VxeModalPrivateMethods extends ModalPrivateMethods { }
+
+export type VxeModalEmits = [
+  'update:modelValue',
+  'show',
+  'hide',
+  'before-hide',
+  'close',
+  'confirm',
+  'cancel',
+  'zoom'
+]
+
+export namespace VxeModalDefines {
+  export interface ModalOptions extends VxeModalProps, VxeModalEventProps {
+    key?: string | number
+  }
+
+  interface ModalEventParams extends VxeComponentEvent {
+    $modal: VxeModalConstructor & VxeModalMethods
+  }
+
+  interface ModalBaseParams extends ModalVisibleParams { }
+
+  export interface ShowParams extends ModalBaseParams { }
+  export interface ShowEventParams extends ModalEventParams, ShowParams { }
+
+  export interface HideParams extends ModalBaseParams { }
+  export interface HideEventParams extends ModalEventParams, HideParams { }
+
+  export interface BeforeHideParams extends ModalBaseParams { }
+  export interface BeforeHideEventParams extends ModalEventParams, BeforeHideParams { }
+
+  export interface ConfirmParams extends ModalBaseParams { }
+  export interface ConfirmEventParams extends ModalEventParams, ConfirmParams { }
+
+  export interface CancelParams extends ModalBaseParams { }
+  export interface CancelEventParams extends ModalEventParams, CancelParams { }
+
+  export interface CloseParams extends ModalBaseParams { }
+  export interface CloseEventParams extends ModalEventParams, CloseParams { }
+
+  export interface ZoomParams extends ModalBaseParams { }
+  export interface ZoomEventParams extends ModalEventParams, ZoomParams { }
+}
+
+export type VxeModalEventProps = {
+  onShow?: VxeModalEvents.Show
+  onHide?: VxeModalEvents.Hide
+  onBeforeHide?: VxeModalEvents.BeforeHide
+  onConfirm?: VxeModalEvents.Confirm
+  onCancel?: VxeModalEvents.Cancel
+  onClose?: VxeModalEvents.Close
+  onZoom?: VxeModalEvents.Zoom
+}
+
+export interface VxeModalListeners {
+  show?: VxeModalEvents.Show
+  hide?: VxeModalEvents.Hide
+  beforeHide?: VxeModalEvents.BeforeHide
+  confirm?: VxeModalEvents.Confirm
+  cancel?: VxeModalEvents.Cancel
+  close?: VxeModalEvents.Close
+  zoom?: VxeModalEvents.Zoom
+}
+
+/**
+ * 全局窗口控制器
+ */
+export interface ModalController {
+  /**
+   * 创建窗口
+   * @param options 参数
+   */
+  open(options: VxeModalDefines.ModalOptions): Promise<ModalEventTypes>
+  /**
+   * 创建提示框
+   * @param content 消息内容
+   * @param title 标题
+   * @param options 参数
+   */
+  alert(content: VxeModalPropTypes.Content, title?: VxeModalPropTypes.Title, options?: VxeModalDefines.ModalOptions): Promise<ModalEventTypes>
+  /**
+   * 创建提示框
+   * @param options 参数
+   */
+  alert(options: VxeModalDefines.ModalOptions): Promise<ModalEventTypes>
+  /**
+   * 创建确认框
+   * @param content 消息内容
+   * @param title 标题
+   * @param options 参数
+   */
+  confirm(content: VxeModalPropTypes.Content, title?: VxeModalPropTypes.Title, options?: VxeModalDefines.ModalOptions): Promise<ModalEventTypes>
+  /**
+   * 创建确认框
+   * @param options 参数
+   */
+  confirm(options: VxeModalDefines.ModalOptions): Promise<ModalEventTypes>
+  /**
+   * 创建消息提示
+   * @param content 消息内容
+   * @param title 标题
+   * @param options 参数
+   */
+  message(content: VxeModalPropTypes.Content, options?: VxeModalDefines.ModalOptions): Promise<ModalEventTypes>
+  /**
+   * 创建消息提示
+   * @param options 参数
+   */
+  message(options: VxeModalDefines.ModalOptions): Promise<ModalEventTypes>
+  /**
+   * 获取动态的活动窗口
+   * @param id 窗口唯一标识
+   */
+  get(id: string): VxeModalConstructor & VxeModalMethods
+  /**
+   * 关闭动态的活动窗口，如果为空则关闭所有
+   * @param id 窗口唯一标识
+   */
+  close(id?: VxeModalPropTypes.ID): Promise<any>
+}
+
+export interface ModalDefaultSlotParams {
+  $modal: VxeModalConstructor & VxeModalMethods
+}
+
+export interface ModalHeaderSlotParams extends ModalDefaultSlotParams { }
+export interface ModalTitleSlotParams extends ModalDefaultSlotParams { }
+export interface ModalFooterSlotParams extends ModalDefaultSlotParams { }
+
+interface ModalVisibleParams {
+  type: ModalEventTypes
+}
+
+export namespace VxeModalEvents {
+  export type Show = (params: VxeModalDefines.ShowEventParams) => void
+  export type Hide = (params: VxeModalDefines.HideEventParams) => void
+  export type BeforeHide = (params: VxeModalDefines.BeforeHideEventParams) => void
+  export type Confirm = (params: VxeModalDefines.ConfirmEventParams) => void
+  export type Cancel = (params: VxeModalDefines.CancelEventParams) => void
+  export type Close = (params: VxeModalDefines.CloseEventParams) => void
+  export type Zoom = (params: VxeModalDefines.ZoomEventParams) => void
+}
+
+export namespace VxeModalSlotTypes {
+  export interface DefaultSlotParams {}
+}
+
+export interface VxeModalSlots {
+  /**
+   * 自定义窗口内容模板
+   */
+  default?(params: ModalDefaultSlotParams): VxeComponentSlot[] | VxeComponentSlot
+  /**
+   * 自定义窗口头部的模板
+   */
+  header?(params: ModalHeaderSlotParams): VxeComponentSlot[] | VxeComponentSlot
+  /**
+   * 自定义窗口标题的模板（如果使用了 header 插槽，则该插槽无效）
+   */
+  title?(params: ModalTitleSlotParams): VxeComponentSlot[] | VxeComponentSlot
+  /**
+   * 自定义窗口右上角的模板
+   */
+  corner?(params: ModalTitleSlotParams): VxeComponentSlot[] | VxeComponentSlot
+  /**
+   * 自定义窗口底部的模板
+   */
+  footer?(params: ModalFooterSlotParams): VxeComponentSlot[] | VxeComponentSlot
+}
+
+export const Modal: typeof VxeModal
+export default VxeModal

package/types/components/optgroup.d.ts

@@ -0,0 +1,80 @@
+import { RenderFunction, SetupContext, Ref, ComponentPublicInstance } from 'vue'
+import { defineVxeComponent, VxeComponentBase, VxeComponentEvent } from '../tool'
+
+/* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
+
+export declare const VxeOptgroup: defineVxeComponent<VxeOptgroupProps, VxeOptgroupEventProps>
+
+export type VxeOptgroupInstance = ComponentPublicInstance<VxeOptgroupProps, VxeOptgroupConstructor>
+
+export interface VxeOptgroupConstructor extends VxeComponentBase, VxeOptgroupMethods {
+  props: VxeOptgroupProps
+  context: SetupContext<VxeOptgroupEmits>
+  reactData: OptgroupReactData
+  getRefMaps(): OptgroupPrivateRef
+  getComputeMaps(): OptgroupPrivateComputed
+  renderVN: RenderFunction
+}
+
+export interface OptgroupPrivateRef {
+  refElem: Ref<HTMLDivElement | undefined>
+}
+export interface VxeOptgroupPrivateRef extends OptgroupPrivateRef { }
+
+export namespace VxeOptgroupPropTypes {
+}
+
+export type VxeOptgroupProps = {
+  /**
+   * 显示内容
+   */
+  label?: VxeOptionPropTypes.Label
+  /**
+   * 是否禁用
+   */
+  visible?: VxeOptionPropTypes.Visible
+  className?: VxeOptionPropTypes.ClassName
+  /**
+   * 是否禁用
+   */
+  disabled?: VxeOptionPropTypes.Disabled
+}
+
+export interface OptgroupPrivateComputed {
+}
+export interface VxeOptgroupPrivateComputed extends OptgroupPrivateComputed { }
+
+export interface OptgroupReactData {
+}
+
+export interface OptgroupMethods {
+}
+export interface VxeOptgroupMethods extends OptgroupMethods { }
+
+export interface OptgroupPrivateMethods { }
+export interface VxeOptgroupPrivateMethods extends OptgroupPrivateMethods { }
+
+export type VxeOptgroupEmits = []
+
+export namespace VxeOptgroupDefines {
+  export interface OptgroupEventParams extends VxeComponentEvent {
+    $optgroup: VxeOptgroupConstructor
+  }
+}
+
+export type VxeOptgroupEventProps = {}
+
+export interface VxeOptgroupListeners { }
+
+export namespace VxeOptgroupEvents { }
+
+export namespace VxeOptgroupSlotTypes {
+  export interface DefaultSlotParams {}
+}
+
+export interface VxeOptgroupSlots {
+  default: (params: VxeOptgroupSlotTypes.DefaultSlotParams) => any
+}
+
+export const Optgroup: typeof VxeOptgroup
+export default VxeOptgroup

package/types/components/option.d.ts

@@ -0,0 +1,99 @@
+import { RenderFunction, SetupContext, Ref, ComponentPublicInstance } from 'vue'
+import { defineVxeComponent, VxeComponentBase, VxeComponentEvent } from '../tool'
+
+/* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
+
+export declare const VxeOption: defineVxeComponent<VxeOptionProps, VxeOptionEventProps>
+
+export type VxeOptionInstance = ComponentPublicInstance<VxeOptionProps, VxeOptionConstructor>
+
+export interface VxeOptionConstructor extends VxeComponentBase, VxeOptionMethods {
+  props: VxeOptionProps
+  context: SetupContext<VxeOptionEmits>
+  reactData: OptionReactData
+  getRefMaps(): OptionPrivateRef
+  getComputeMaps(): OptionPrivateComputed
+  renderVN: RenderFunction
+}
+
+export interface OptionPrivateRef {
+  refElem: Ref<HTMLDivElement | undefined>
+}
+export interface VxeOptionPrivateRef extends OptionPrivateRef { }
+
+export namespace VxeOptionPropTypes {
+  export type Value = any
+  export type Label = string | number | boolean
+  export type Visible = boolean
+  export type ClassName = string | ((params: {
+    option: any
+    $select: VxeSelectConstructor
+  }) => string)
+  export type Disabled = boolean
+  export type Slots = {
+    default?: string | ((params: {
+      option: any
+      $select: VxeSelectConstructor
+    }) => SlotVNodeType | SlotVNodeType[]) | null
+  }
+}
+
+export type VxeOptionProps = {
+  /**
+  * 绑定值
+  */
+  value?: VxeOptionPropTypes.Value
+  /**
+  * 显示内容
+  */
+  label?: VxeOptionPropTypes.Label
+  /**
+  * 是否显示
+  */
+  visible?: VxeOptionPropTypes.Visible
+  className?: VxeOptionPropTypes.ClassName
+  /**
+  * 是否禁用
+  */
+  disabled?: VxeOptionPropTypes.Disabled
+  slots?: VxeOptionPropTypes.Slots
+}
+
+export interface OptionPrivateComputed {
+}
+export interface VxeOptionPrivateComputed extends OptionPrivateComputed { }
+
+export interface OptionReactData {
+}
+
+export interface OptionMethods {
+}
+export interface VxeOptionMethods extends OptionMethods { }
+
+export interface OptionPrivateMethods { }
+export interface VxeOptionPrivateMethods extends OptionPrivateMethods { }
+
+export type VxeOptionEmits = []
+
+export namespace VxeOptionDefines {
+  export interface OptionEventParams extends VxeComponentEvent {
+    $option: VxeOptionConstructor
+  }
+}
+
+export type VxeOptionEventProps = {}
+
+export interface VxeOptionListeners { }
+
+export namespace VxeOptionEvents { }
+
+export namespace VxeOptionSlotTypes {
+  export interface DefaultSlotParams {}
+}
+
+export interface VxeOptionSlots {
+  default: (params: VxeOptionSlotTypes.DefaultSlotParams) => any
+}
+
+export const Option: typeof VxeOption
+export default VxeOption