vxe-pc-ui/types/components/icon.d.ts

A vue based PC component library

import { RenderFunction, SetupContext, Ref } from 'vue'
import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, VxeComponentSizeType, ValueOf } from '@vxe-ui/core'

/* eslint-disable no-use-before-define,@typescript-eslint/ban-types */

export declare const VxeIcon: DefineVxeComponentApp<VxeIconProps, VxeIconEventProps, VxeIconSlots>
export type VxeIconComponent = DefineVxeComponentOptions<VxeIconProps, VxeIconEventProps>

export type VxeIconInstance = DefineVxeComponentInstance<VxeIconProps, VxeIconConstructor>

export interface VxeIconConstructor extends VxeComponentBaseOptions, VxeIconMethods {
  props: VxeIconProps
  context: SetupContext<VxeIconEmits>
  reactData: IconReactData
  getRefMaps(): IconPrivateRef
  getComputeMaps(): IconPrivateComputed
  renderVN: RenderFunction
}

export interface IconPrivateRef {
  refElem: Ref<HTMLDivElement | undefined>
}
export interface VxeIconPrivateRef extends IconPrivateRef { }

export namespace VxeIconPropTypes {
  export type Name = 'dropper' | 'add' | 'add-sub' | 'add-user' | 'add-users' | 'align-center' | 'align-left' | 'align-right' | 'alipay' | 'arrow-double-left' | 'arrow-double-right' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrows-down' | 'arrows-left' | 'arrows-right' | 'arrows-up' | 'association-form' | 'bell' | 'bell-fill' | 'calendar' | 'caret-down' | 'caret-left' | 'caret-right' | 'caret-up' | 'carousel' | 'chart-bar-x' | 'chart-bar-y' | 'chart-line' | 'chart-pie' | 'chart-radar' | 'chat' | 'chat-fill' | 'check' | 'checkbox-checked' | 'checkbox-checked-fill' | 'checkbox-indeterminate-fill' | 'checkbox-unchecked' | 'click-button' | 'close' | 'cloud-download' | 'cloud-upload' | 'cloudy' | 'comment' | 'company' | 'copy' | 'custom-column' | 'cut' | 'delete' | 'delete-fill' | 'dot' | 'download' | 'drag-handle' | 'edit' | 'ellipsis-h' | 'ellipsis-v' | 'empty' | 'end-page' | 'envelope' | 'envelope-fill' | 'envelope-open' | 'envelope-open-fill' | 'error-circle' | 'error-circle-fill' | 'exclamation' | 'eye-fill' | 'eye-fill-close' | 'feedback' | 'file' | 'file-excel' | 'file-image' | 'file-markdown' | 'file-pdf' | 'file-ppt' | 'file-txt' | 'file-word' | 'file-zip' | 'fixed-left' | 'fixed-left-fill' | 'fixed-right' | 'fixed-right-fill' | 'flag' | 'flag-fill' | 'flow-branch' | 'folder' | 'folder-open' | 'fullscreen' | 'funnel' | 'funnel-clear' | 'gitee-fill' | 'github-fill' | 'goods' | 'goods-fill' | 'heavy-rain' | 'home' | 'home-fill' | 'home-page' | 'indicator' | 'info-circle' | 'info-circle-fill' | 'information' | 'input' | 'language-switch' | 'layout' | 'lightning' | 'link' | 'location' | 'location-fill' | 'lock' | 'lock-fill' | 'maximize' | 'menu' | 'menu-fold' | 'menu-unfold' | 'merge-cells' | 'message-fill' | 'microphone' | 'microphone-fill' | 'minimize' | 'minus' | 'mobile' | 'moon' | 'no-drop' | 'notice-left-fill' | 'notice-right-fill' | 'num-list' | 'number' | 'paste' | 'pc' | 'pct-1-1' | 'pct-full' | 'picture' | 'picture-fill' | 'platform' | 'print' | 'print-batch' | 'question' | 'question-circle' | 'question-circle-fill' | 'radio-checked' | 'radio-checked-fill' | 'radio-unchecked' | 'recover' | 'refresh' | 'repeat' | 'rich-text' | 'rmb' | 'rotate-left' | 'rotate-right' | 'row-col' | 'save' | 'search' | 'search-zoom-in' | 'search-zoom-out' | 'select' | 'send' | 'send-fill' | 'setting' | 'setting-fill' | 'share' | 'share-fill' | 'signature' | 'slider' | 'sort' | 'sort-alpha-asc' | 'sort-alpha-desc' | 'sort-asc' | 'sort-desc' | 'sort-numeric-asc' | 'sort-numeric-desc' | 'spinner' | 'square' | 'square-caret-right' | 'square-caret-right-fill' | 'square-checked' | 'square-checked-fill' | 'square-close' | 'square-close-fill' | 'square-down' | 'square-down-fill' | 'square-fill' | 'square-left' | 'square-left-fill' | 'square-minus' | 'square-minus-fill' | 'square-plus' | 'square-plus-fill' | 'square-plus-square' | 'square-right' | 'square-right-fill' | 'square-square' | 'square-up' | 'square-up-fill' | 'star' | 'star-fill' | 'star-half' | 'subtable' | 'success-circle' | 'success-circle-fill' | 'sunny' | 'swap' | 'swap-down' | 'swap-left' | 'swap-right' | 'swap-up' | 'switch' | 'table' | 'tabs' | 'text' | 'textarea' | 'time' | 'tree-select' | 'undo' | 'unlock' | 'unlock-fill' | 'upload' | 'usd' | 'user' | 'user-fill' | 'voice' | 'voice-fill' | 'warning-circle' | 'warning-circle-fill' | 'warning-triangle' | 'warning-triangle-fill' | 'wechat' | 'zoom-in' | 'zoom-out'
  export type ClassName = string
  export type Roll = boolean
  export type Status = string
  export type Size = VxeComponentSizeType
}

export type VxeIconProps = {
  name?: VxeIconPropTypes.Name
  className?: VxeIconPropTypes.Name
  roll?: VxeIconPropTypes.Roll
  status?: VxeIconPropTypes.Status
  size?: VxeIconPropTypes.Size
}

export interface IconPrivateComputed {
}
export interface VxeIconPrivateComputed extends IconPrivateComputed { }

export interface IconReactData {
}

export interface IconMethods {
  dispatchEvent(type: ValueOf<VxeIconEmits>, params: Record<string, any>, evnt: Event | null): void
}
export interface VxeIconMethods extends IconMethods { }

export interface IconPrivateMethods { }
export interface VxeIconPrivateMethods extends IconPrivateMethods { }

export type VxeIconEmits = [
  'click'
]

export namespace VxeIconDefines {
  export interface IconEventParams extends VxeComponentEventParams {
    $icon: VxeIconConstructor
  }

  export interface ClickParams {}
  export interface ClickEventParams extends IconEventParams, ClickParams { }
}

export type VxeIconEventProps = {
  onClick?: VxeIconEvents.Click
}

export interface VxeIconListeners {
  onClick?: VxeIconEvents.Click
}

export namespace VxeIconEvents {
  export type Click = (params: VxeIconDefines.ClickEventParams) => void
 }

export namespace VxeIconSlotTypes {}

export interface VxeIconSlots {
}

export const Icon: typeof VxeIcon
export default VxeIcon