@vxe-ui/core 0.0.1

package/types/core/index.d.ts

@@ -0,0 +1,115 @@
+import { VxeGlobalConfig } from './global-config'
+import { VxeGlobalIcon } from './global-icon'
+import { VxeGlobalRenderer } from './renderer'
+import { VxeGlobalValidators } from './validators'
+import { VxeGlobalMenus } from './menus'
+import { VxeGlobalFormats } from './formats'
+import { VxeGlobalCommands } from './commands'
+import { VxeGlobalInterceptor } from './interceptor'
+import { VxeGlobalClipboard } from './clipboard'
+import { VxeGlobalHooks } from './hooks'
+
+/* eslint-disable no-use-before-define */
+
+export function setConfig(options?: VxeGlobalConfig): VxeCoreExport
+
+export function getConfig(key: string | number | null | undefined, defaultValue?: any): any
+
+export function setIcon(options?: VxeGlobalIcon): VxeCoreExport
+
+export function getIcon(key: string): any
+
+export function getI18n(key: string, args?: any): string
+
+export const version: string
+
+export const renderer: VxeGlobalRenderer
+
+export const validators: VxeGlobalValidators
+
+export const menus: VxeGlobalMenus
+
+export const formats: VxeGlobalFormats
+
+export const commands: VxeGlobalCommands
+
+export const interceptor: VxeGlobalInterceptor
+
+export const clipboard: VxeGlobalClipboard
+
+export const hooks: VxeGlobalHooks
+
+export interface VxeCoreExport {
+  /**
+   * 版本号
+   */
+  version: string
+  /**
+   * 设置全局参数
+   */
+  setConfig: typeof setConfig
+  /**
+   * 获取全局参数
+   */
+  getConfig: typeof getConfig
+  /**
+   * 设置全局图标
+   */
+  setIcon: typeof setIcon
+  /**
+   * 翻译组件语言
+   */
+  getI18n: typeof getI18n
+  /**
+   * 获取全局图标
+   */
+  getIcon: typeof getIcon,
+
+  /**
+   * 全局渲染器
+   */
+  renderer: VxeGlobalRenderer
+  /**
+   * 全局校验扩展
+   */
+  validators: VxeGlobalValidators
+  /**
+   * 全局右键菜单扩展
+   */
+  menus: VxeGlobalMenus
+  /**
+   * 全局格式化对象
+   */
+  formats: VxeGlobalFormats
+  /**
+   * 全局操作指令
+   */
+  commands: VxeGlobalCommands
+  /**
+   * 全局事件拦截处理对象
+   */
+  interceptor: VxeGlobalInterceptor
+  /**
+   * 全局剪贴板
+   */
+  clipboard: VxeGlobalClipboard
+
+  // 扩展插件
+  hooks: VxeGlobalHooks
+}
+
+export declare const VxeCore: VxeCoreExport
+
+export * from './global-config'
+export * from './global-icon'
+export * from './renderer'
+export * from './validators'
+export * from './menus'
+export * from './formats'
+export * from './commands'
+export * from './interceptor'
+export * from './clipboard'
+
+export * from './hooks'
+
+export default VxeCore

package/types/core/interceptor.d.ts

@@ -0,0 +1,18 @@
+/* eslint-disable no-use-before-define */
+
+export namespace VxeGlobalInterceptorHandles {
+  export type InterceptorCallback = (params: InterceptorParams) => any
+  export interface InterceptorParams {}
+}
+
+/**
+ * 全局事件拦截器
+ */
+export interface VxeGlobalInterceptor {
+  mixin(options: {
+    [type: string]: VxeGlobalInterceptorHandles.InterceptorCallback
+  }): VxeGlobalInterceptor
+  get(type: string): VxeGlobalInterceptorHandles.InterceptorCallback[]
+  add(type: string, callback: VxeGlobalInterceptorHandles.InterceptorCallback): VxeGlobalInterceptor
+  delete(type: string, callback?: VxeGlobalInterceptorHandles.InterceptorCallback): void
+}

package/types/core/menus.d.ts

@@ -0,0 +1,25 @@
+/* eslint-disable no-use-before-define */
+
+export namespace VxeGlobalMenusHandles {
+  export type MenusOption = {
+    menuMethod?: (params: MenuMethodParams, event: Event) => any
+  }
+  export interface MenuMethodParams {
+    $event: MouseEvent
+    menu: any
+  }
+}
+
+/**
+ * 全局快捷菜单
+ */
+export interface VxeGlobalMenus {
+  mixin(opts: {
+    [code: string]: VxeGlobalMenusHandles.MenusOption | ((params: VxeGlobalMenusHandles.MenuMethodParams, event: Event) => any)
+  }): VxeGlobalMenus
+  has(code: string): boolean
+  get(code: string): VxeGlobalMenusHandles.MenusOption
+  add(code: string, options: VxeGlobalMenusHandles.MenusOption | ((params: VxeGlobalMenusHandles.MenuMethodParams, event: Event) => any)): VxeGlobalMenus
+  delete(code: string): void
+  forEach(callback: (options: VxeGlobalMenusHandles.MenusOption, code: string) => void): void
+}

package/types/core/renderer.d.ts

@@ -0,0 +1,26 @@
+import { VxeComponentSlot } from '../tool'
+
+/* eslint-disable no-use-before-define */
+
+type RendererOptions = DefineRendererOption<VxeGlobalRendererHandles.RenderResult>
+
+export interface DefineRendererOption<T> {}
+
+export namespace VxeGlobalRendererHandles {
+  export type RenderResult = VxeComponentSlot | VxeComponentSlot[]
+}
+
+/**
+ * 渲染器
+ */
+export interface VxeGlobalRenderer {
+  mixin(options: {
+    [name: string]: RendererOptions
+  }): VxeGlobalRenderer
+  get(name: string | null | undefined): DefineRendererOption<VxeGlobalRendererHandles.RenderResult>
+  add(name: string, options: RendererOptions): VxeGlobalRenderer
+  forEach(callback: (item: DefineRendererOption<VxeGlobalRendererHandles.RenderResult>, name: string, renderMap: {
+    [name: string]: RendererOptions
+  }) => void): VxeGlobalRenderer
+  delete(name: string): void
+}

package/types/core/validators.d.ts

@@ -0,0 +1,22 @@
+/* eslint-disable no-use-before-define */
+
+export namespace VxeGlobalValidatorsHandles {
+  export interface ValidatorsOptions {
+    itemValidatorMethod?(params: ItemValidatorParams, ...args: any[]): void | Error | Promise<any>
+  }
+  export interface ItemValidatorParams {}
+}
+
+/**
+ * 全局快捷菜单
+ */
+export interface VxeGlobalValidators {
+  mixin(options: {
+    [code: string]: VxeGlobalValidatorsHandles.ValidatorsOptions
+  }): VxeGlobalValidators
+  has(code: string): boolean
+  get(code: string): VxeGlobalValidatorsHandles.ValidatorsOptions
+  add(code: string, callback: VxeGlobalValidatorsHandles.ValidatorsOptions): VxeGlobalValidators
+  delete(code: string): void
+  forEach(callback: (options: VxeGlobalValidatorsHandles.ValidatorsOptions, code: string) => void): void
+}

package/types/index.d.ts

@@ -0,0 +1,10 @@
+import { VxeCoreExport, VxeGlobalConfig } from './core'
+
+declare global {
+  interface Window {
+    VxeCore: VxeCoreExport;
+  }
+}
+
+export * from './tool'
+export * from './core'

package/types/tool/common.d.ts

@@ -0,0 +1,61 @@
+import { App, VNode } from 'vue'
+
+/**
+ * 定义组件
+ */
+export type defineVxeComponent<
+  P = { [key: string]: any },
+  E = { [key: string]: any },
+  S = { [key: string]: (...args: any[]) => any }
+> = ({
+  new (): {
+    $props: P & E,
+    $slots: S
+  }
+} & {
+  install(app: App): void
+})
+
+/**
+ * 组件通用的基础参数
+ */
+export interface VxeComponentBase {
+  xID: string
+}
+
+/**
+ * 组件事件参数
+ */
+export interface VxeComponentEvent {
+  $event: Event
+}
+
+/**
+ * 组件尺寸类型
+ */
+export type VxeComponentSize = null | '' | 'medium' | 'small' | 'mini'
+
+/**
+ * 组件对齐方式
+ */
+export type VxeComponentAlign = null | '' | 'left' | 'right' | 'center'
+
+/**
+ * 组件状态
+ */
+export type VxeComponentStatus = null | '' | 'primary' | 'success' | 'info' | 'warning' | 'danger' | 'error'
+
+/**
+ * 组件样式类型
+ */
+export type VxeComponentStyle = Record<string, string | number>
+
+/**
+ * 组件 className 类型
+ */
+export type VxeComponentClassName = Record<string, boolean>
+
+/**
+ * 组件插槽类型
+ */
+export type VxeComponentSlot = VNode | string | number

package/types/tool/index.d.ts

@@ -0,0 +1,2 @@
+export * from './util'
+export * from './common'

package/types/tool/util.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 取出对象值类型
+ */
+export type ValueOf<T> = T extends any[] ? T[number] : T[keyof T]