element-plus
Version:
A Component Library for Vue 3
1 lines • 8 kB
Source Map (JSON)
{"version":3,"file":"message.mjs","sources":["../../../../../../packages/components/message/src/message.ts"],"sourcesContent":["import {\n buildProps,\n definePropType,\n iconPropType,\n isClient,\n mutable,\n} from '@element-plus/utils'\n\nimport type {\n AppContext,\n ExtractPropTypes,\n ExtractPublicPropTypes,\n VNode,\n} from 'vue'\nimport type { Mutable } from '@element-plus/utils'\nimport type MessageConstructor from './message.vue'\n\nexport const messageTypes = [\n 'primary',\n 'success',\n 'info',\n 'warning',\n 'error',\n] as const\n\nexport const messagePlacement = [\n 'top',\n 'top-left',\n 'top-right',\n 'bottom',\n 'bottom-left',\n 'bottom-right',\n] as const\n\nexport const MESSAGE_DEFAULT_PLACEMENT = 'top'\n\nexport type MessageType = (typeof messageTypes)[number]\nexport type MessagePlacement = (typeof messagePlacement)[number]\n/** @deprecated please use `MessageType` instead */\nexport type messageType = MessageType // will be removed in 3.0.0.\n\nexport interface MessageConfigContext {\n max?: number\n grouping?: boolean\n duration?: number\n offset?: number\n showClose?: boolean\n plain?: boolean\n placement?: string\n}\n\nexport const messageDefaults = mutable({\n customClass: '',\n dangerouslyUseHTMLString: false,\n duration: 3000,\n icon: undefined,\n id: '',\n message: '',\n onClose: undefined,\n showClose: false,\n type: 'info',\n plain: false,\n offset: 16,\n placement: undefined,\n zIndex: 0,\n grouping: false,\n repeatNum: 1,\n appendTo: isClient ? document.body : (undefined as never),\n} as const)\n\nexport const messageProps = buildProps({\n /**\n * @description custom class name for Message\n */\n customClass: {\n type: String,\n default: messageDefaults.customClass,\n },\n /**\n * @description whether `message` is treated as HTML string\n */\n dangerouslyUseHTMLString: {\n type: Boolean,\n default: messageDefaults.dangerouslyUseHTMLString,\n },\n /**\n * @description display duration, millisecond. If set to 0, it will not turn off automatically\n */\n duration: {\n type: Number,\n default: messageDefaults.duration,\n },\n /**\n * @description custom icon component, overrides `type`\n */\n icon: {\n type: iconPropType,\n default: messageDefaults.icon,\n },\n /**\n * @description message dom id\n */\n id: {\n type: String,\n default: messageDefaults.id,\n },\n /**\n * @description message text\n */\n message: {\n type: definePropType<string | VNode | (() => VNode)>([\n String,\n Object,\n Function,\n ]),\n default: messageDefaults.message,\n },\n /**\n * @description callback function when closed with the message instance as the parameter\n */\n onClose: {\n type: definePropType<() => void>(Function),\n default: messageDefaults.onClose,\n },\n /**\n * @description whether to show a close button\n */\n showClose: {\n type: Boolean,\n default: messageDefaults.showClose,\n },\n /**\n * @description message type\n */\n type: {\n type: String,\n values: messageTypes,\n default: messageDefaults.type,\n },\n /**\n * @description whether message is plain\n */\n plain: {\n type: Boolean,\n default: messageDefaults.plain,\n },\n /**\n * @description set the distance to the top of viewport\n */\n offset: {\n type: Number,\n default: messageDefaults.offset,\n },\n /**\n * @description message placement position\n */\n placement: {\n type: String,\n values: messagePlacement,\n default: messageDefaults.placement,\n },\n /**\n * @description input box size\n */\n zIndex: {\n type: Number,\n default: messageDefaults.zIndex,\n },\n /**\n * @description merge messages with the same content, type of VNode message is not supported\n */\n grouping: {\n type: Boolean,\n default: messageDefaults.grouping,\n },\n /**\n * @description The number of repetitions, similar to badge, is used as the initial number when used with `grouping`\n */\n repeatNum: {\n type: Number,\n default: messageDefaults.repeatNum,\n },\n} as const)\nexport type MessageProps = ExtractPropTypes<typeof messageProps>\nexport type MessagePropsPublic = ExtractPublicPropTypes<typeof messageProps>\n\nexport const messageEmits = {\n destroy: () => true,\n}\nexport type MessageEmits = typeof messageEmits\n\nexport type MessageInstance = InstanceType<typeof MessageConstructor> & unknown\n\nexport type MessageOptions = Partial<\n Mutable<\n Omit<MessageProps, 'id'> & {\n appendTo?: HTMLElement | string\n }\n >\n>\nexport type MessageParams = MessageOptions | MessageOptions['message']\nexport type MessageParamsNormalized = Omit<MessageProps, 'id'> & {\n /**\n * @description set the root element for the message, default to `document.body`\n */\n appendTo: HTMLElement\n}\nexport type MessageOptionsWithType = Omit<MessageOptions, 'type'>\nexport type MessageParamsWithType =\n | MessageOptionsWithType\n | MessageOptions['message']\n\nexport interface MessageHandler {\n /**\n * @description close the Message\n */\n close: () => void\n}\n\nexport type MessageFn = {\n (options?: MessageParams, appContext?: null | AppContext): MessageHandler\n closeAll(type?: MessageType): void\n closeAllByPlacement(position: MessagePlacement): void\n}\nexport type MessageTypedFn = (\n options?: MessageParamsWithType,\n appContext?: null | AppContext\n) => MessageHandler\n\nexport type Message = MessageFn & {\n primary: MessageTypedFn\n success: MessageTypedFn\n warning: MessageTypedFn\n info: MessageTypedFn\n error: MessageTypedFn\n}\n"],"names":[],"mappings":";;;;;AAiBO,MAAM,YAAe,GAAA;AAAA,EAC1B,SAAA;AAAA,EACA,SAAA;AAAA,EACA,MAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAA;AACF,EAAA;AAEO,MAAM,gBAAmB,GAAA;AAAA,EAC9B,KAAA;AAAA,EACA,UAAA;AAAA,EACA,WAAA;AAAA,EACA,QAAA;AAAA,EACA,aAAA;AAAA,EACA,cAAA;AACF,EAAA;AAEO,MAAM,yBAA4B,GAAA,MAAA;AAiBlC,MAAM,kBAAkB,OAAQ,CAAA;AAAA,EACrC,WAAa,EAAA,EAAA;AAAA,EACb,wBAA0B,EAAA,KAAA;AAAA,EAC1B,QAAU,EAAA,GAAA;AAAA,EACV,IAAM,EAAA,KAAA,CAAA;AAAA,EACN,EAAI,EAAA,EAAA;AAAA,EACJ,OAAS,EAAA,EAAA;AAAA,EACT,OAAS,EAAA,KAAA,CAAA;AAAA,EACT,SAAW,EAAA,KAAA;AAAA,EACX,IAAM,EAAA,MAAA;AAAA,EACN,KAAO,EAAA,KAAA;AAAA,EACP,MAAQ,EAAA,EAAA;AAAA,EACR,SAAW,EAAA,KAAA,CAAA;AAAA,EACX,MAAQ,EAAA,CAAA;AAAA,EACR,QAAU,EAAA,KAAA;AAAA,EACV,SAAW,EAAA,CAAA;AAAA,EACX,QAAA,EAAU,QAAW,GAAA,QAAA,CAAS,IAAQ,GAAA,KAAA,CAAA;AACxC,CAAU,EAAA;AAEH,MAAM,eAAe,UAAW,CAAA;AAAA,EAIrC,WAAa,EAAA;AAAA,IACX,IAAM,EAAA,MAAA;AAAA,IACN,SAAS,eAAgB,CAAA,WAAA;AAAA,GAC3B;AAAA,EAIA,wBAA0B,EAAA;AAAA,IACxB,IAAM,EAAA,OAAA;AAAA,IACN,SAAS,eAAgB,CAAA,wBAAA;AAAA,GAC3B;AAAA,EAIA,QAAU,EAAA;AAAA,IACR,IAAM,EAAA,MAAA;AAAA,IACN,SAAS,eAAgB,CAAA,QAAA;AAAA,GAC3B;AAAA,EAIA,IAAM,EAAA;AAAA,IACJ,IAAM,EAAA,YAAA;AAAA,IACN,SAAS,eAAgB,CAAA,IAAA;AAAA,GAC3B;AAAA,EAIA,EAAI,EAAA;AAAA,IACF,IAAM,EAAA,MAAA;AAAA,IACN,SAAS,eAAgB,CAAA,EAAA;AAAA,GAC3B;AAAA,EAIA,OAAS,EAAA;AAAA,IACP,MAAM,cAA+C,CAAA;AAAA,MACnD,MAAA;AAAA,MACA,MAAA;AAAA,MACA,QAAA;AAAA,KACD,CAAA;AAAA,IACD,SAAS,eAAgB,CAAA,OAAA;AAAA,GAC3B;AAAA,EAIA,OAAS,EAAA;AAAA,IACP,IAAA,EAAM,eAA2B,QAAQ,CAAA;AAAA,IACzC,SAAS,eAAgB,CAAA,OAAA;AAAA,GAC3B;AAAA,EAIA,SAAW,EAAA;AAAA,IACT,IAAM,EAAA,OAAA;AAAA,IACN,SAAS,eAAgB,CAAA,SAAA;AAAA,GAC3B;AAAA,EAIA,IAAM,EAAA;AAAA,IACJ,IAAM,EAAA,MAAA;AAAA,IACN,MAAQ,EAAA,YAAA;AAAA,IACR,SAAS,eAAgB,CAAA,IAAA;AAAA,GAC3B;AAAA,EAIA,KAAO,EAAA;AAAA,IACL,IAAM,EAAA,OAAA;AAAA,IACN,SAAS,eAAgB,CAAA,KAAA;AAAA,GAC3B;AAAA,EAIA,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,MAAA;AAAA,IACN,SAAS,eAAgB,CAAA,MAAA;AAAA,GAC3B;AAAA,EAIA,SAAW,EAAA;AAAA,IACT,IAAM,EAAA,MAAA;AAAA,IACN,MAAQ,EAAA,gBAAA;AAAA,IACR,SAAS,eAAgB,CAAA,SAAA;AAAA,GAC3B;AAAA,EAIA,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,MAAA;AAAA,IACN,SAAS,eAAgB,CAAA,MAAA;AAAA,GAC3B;AAAA,EAIA,QAAU,EAAA;AAAA,IACR,IAAM,EAAA,OAAA;AAAA,IACN,SAAS,eAAgB,CAAA,QAAA;AAAA,GAC3B;AAAA,EAIA,SAAW,EAAA;AAAA,IACT,IAAM,EAAA,MAAA;AAAA,IACN,SAAS,eAAgB,CAAA,SAAA;AAAA,GAC3B;AACF,CAAU,EAAA;AAIH,MAAM,YAAe,GAAA;AAAA,EAC1B,SAAS,MAAM,IAAA;AACjB;;;;"}