refactor: useMessage #6527
parent
6eb4d8f5c5
commit
02ed988cba
|
@ -2,13 +2,11 @@ import Notice from '../vc-notification/Notice';
|
||||||
import type { NoticeProps } from '../vc-notification/Notice';
|
import type { NoticeProps } from '../vc-notification/Notice';
|
||||||
import useStyle from './style';
|
import useStyle from './style';
|
||||||
import type { NoticeType } from './interface';
|
import type { NoticeType } from './interface';
|
||||||
import {
|
import LoadingOutlined from '@ant-design/icons-vue/LoadingOutlined';
|
||||||
CheckCircleFilled,
|
import ExclamationCircleFilled from '@ant-design/icons-vue/ExclamationCircleFilled';
|
||||||
CloseCircleFilled,
|
import CloseCircleFilled from '@ant-design/icons-vue/CloseCircleFilled';
|
||||||
ExclamationCircleFilled,
|
import CheckCircleFilled from '@ant-design/icons-vue/CheckCircleFilled';
|
||||||
InfoCircleFilled,
|
import InfoCircleFilled from '@ant-design/icons-vue/InfoCircleFilled';
|
||||||
LoadingOutlined,
|
|
||||||
} from '@ant-design/icons-vue';
|
|
||||||
import type { VueNode } from '../_util/type';
|
import type { VueNode } from '../_util/type';
|
||||||
import classNames from '../_util/classNames';
|
import classNames from '../_util/classNames';
|
||||||
import { useConfigContextInject } from '../config-provider/context';
|
import { useConfigContextInject } from '../config-provider/context';
|
||||||
|
@ -26,10 +24,9 @@ export interface PureContentProps {
|
||||||
prefixCls: string;
|
prefixCls: string;
|
||||||
type?: NoticeType;
|
type?: NoticeType;
|
||||||
icon?: VueNode;
|
icon?: VueNode;
|
||||||
children: VueNode;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export const PureContent = defineComponent({
|
export const PureContent = defineComponent<PureContentProps>({
|
||||||
name: 'PureContent',
|
name: 'PureContent',
|
||||||
inheritAttrs: false,
|
inheritAttrs: false,
|
||||||
props: ['prefixCls', 'type', 'icon'] as any,
|
props: ['prefixCls', 'type', 'icon'] as any,
|
||||||
|
@ -48,29 +45,29 @@ export const PureContent = defineComponent({
|
||||||
|
|
||||||
export interface PurePanelProps
|
export interface PurePanelProps
|
||||||
extends Omit<NoticeProps, 'prefixCls' | 'eventKey'>,
|
extends Omit<NoticeProps, 'prefixCls' | 'eventKey'>,
|
||||||
Omit<PureContentProps, 'prefixCls' | 'children'> {
|
Omit<PureContentProps, 'prefixCls'> {
|
||||||
prefixCls?: string;
|
prefixCls?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @private Internal Component. Do not use in your production. */
|
/** @private Internal Component. Do not use in your production. */
|
||||||
|
|
||||||
export default defineComponent({
|
export default defineComponent<PurePanelProps>({
|
||||||
name: 'PurePanel',
|
name: 'PurePanel',
|
||||||
inheritAttrs: false,
|
inheritAttrs: false,
|
||||||
props: ['prefixCls', 'class', 'type', 'icon', 'content'] as any,
|
props: ['prefixCls', 'class', 'type', 'icon', 'content'] as any,
|
||||||
setup(props, { slots, attrs }) {
|
setup(props, { slots, attrs }) {
|
||||||
const { getPrefixCls } = useConfigContextInject();
|
const { getPrefixCls } = useConfigContextInject();
|
||||||
const prefixCls = computed(() => props.staticPrefixCls || getPrefixCls('message'));
|
const prefixCls = computed(() => props.prefixCls || getPrefixCls('message'));
|
||||||
const [, hashId] = useStyle(prefixCls);
|
const [, hashId] = useStyle(prefixCls);
|
||||||
return (
|
return (
|
||||||
<Notice
|
<Notice
|
||||||
{...attrs}
|
{...attrs}
|
||||||
prefixCls={prefixCls.value}
|
prefixCls={prefixCls.value}
|
||||||
class={classNames(hashId, `${prefixCls.value}-notice-pure-panel`)}
|
class={classNames(hashId.value, `${prefixCls.value}-notice-pure-panel`)}
|
||||||
noticeKey="pure"
|
noticeKey="pure"
|
||||||
duration={null}
|
duration={null}
|
||||||
>
|
>
|
||||||
<PureContent prefixCls={props.prefixCls} type={props.type} icon={props.icon}>
|
<PureContent prefixCls={prefixCls.value} type={props.type} icon={props.icon}>
|
||||||
{slots.default?.()}
|
{slots.default?.()}
|
||||||
</PureContent>
|
</PureContent>
|
||||||
</Notice>
|
</Notice>
|
||||||
|
|
|
@ -17,7 +17,7 @@ Use `message.useMessage` to get `contextHolder` with context accessible issue. P
|
||||||
</docs>
|
</docs>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<contextHolder />
|
<context-holder />
|
||||||
<a-button type="primary" @click="info">Display normal message</a-button>
|
<a-button type="primary" @click="info">Display normal message</a-button>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
|
@ -26,6 +26,6 @@ import { message } from 'ant-design-vue';
|
||||||
const [messageApi, contextHolder] = message.useMessage();
|
const [messageApi, contextHolder] = message.useMessage();
|
||||||
|
|
||||||
const info = () => {
|
const info = () => {
|
||||||
messageApi.info('Hello, Ant Design!');
|
messageApi.info('Hello, Ant Design Vue!');
|
||||||
};
|
};
|
||||||
</script>
|
</script>
|
||||||
|
|
|
@ -14,14 +14,14 @@ export interface ConfigOptions {
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ArgsProps {
|
export interface ArgsProps {
|
||||||
content: VueNode;
|
content: string | (() => VueNode) | VueNode;
|
||||||
duration?: number;
|
duration?: number;
|
||||||
type?: NoticeType;
|
type?: NoticeType;
|
||||||
onClose?: () => void;
|
onClose?: () => void;
|
||||||
icon?: VueNode;
|
icon?: (() => VueNode) | VueNode;
|
||||||
key?: string | number;
|
key?: string | number;
|
||||||
style?: CSSProperties;
|
style?: CSSProperties;
|
||||||
className?: string;
|
class?: string;
|
||||||
onClick?: (e: Event) => void;
|
onClick?: (e: Event) => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -59,7 +59,7 @@ const Holder = defineComponent({
|
||||||
const getStyles = () => ({
|
const getStyles = () => ({
|
||||||
left: '50%',
|
left: '50%',
|
||||||
transform: 'translateX(-50%)',
|
transform: 'translateX(-50%)',
|
||||||
top: top ?? DEFAULT_OFFSET,
|
top: `${top ?? DEFAULT_OFFSET}px`,
|
||||||
});
|
});
|
||||||
const getClassName = () => classNames(hashId.value, props.rtl ? `${prefixCls.value}-rtl` : '');
|
const getClassName = () => classNames(hashId.value, props.rtl ? `${prefixCls.value}-rtl` : '');
|
||||||
|
|
||||||
|
@ -113,114 +113,113 @@ export function useInternalMessage(
|
||||||
messageConfig?: HolderProps,
|
messageConfig?: HolderProps,
|
||||||
): readonly [MessageInstance, () => VNode] {
|
): readonly [MessageInstance, () => VNode] {
|
||||||
const holderRef = shallowRef<HolderRef>(null);
|
const holderRef = shallowRef<HolderRef>(null);
|
||||||
|
const holderKey = Symbol('messageHolderKey');
|
||||||
// ================================ API ================================
|
// ================================ API ================================
|
||||||
const wrapAPI = computed(() => {
|
|
||||||
// Wrap with notification content
|
|
||||||
// >>> close
|
|
||||||
const close = (key: Key) => {
|
|
||||||
holderRef.value?.close(key);
|
|
||||||
};
|
|
||||||
|
|
||||||
// >>> Open
|
// Wrap with notification content
|
||||||
const open = (config: ArgsProps): MessageType => {
|
// >>> close
|
||||||
if (!holderRef.value) {
|
const close = (key: Key) => {
|
||||||
const fakeResult: any = () => {};
|
holderRef.value?.close(key);
|
||||||
fakeResult.then = () => {};
|
};
|
||||||
return fakeResult;
|
|
||||||
}
|
|
||||||
|
|
||||||
const { open: originOpen, prefixCls, hashId } = holderRef.value;
|
// >>> Open
|
||||||
const noticePrefixCls = `${prefixCls}-notice`;
|
const open = (config: ArgsProps): MessageType => {
|
||||||
const { content, icon, type, key, className, onClose, ...restConfig } = config;
|
if (!holderRef.value) {
|
||||||
|
const fakeResult: any = () => {};
|
||||||
|
fakeResult.then = () => {};
|
||||||
|
return fakeResult;
|
||||||
|
}
|
||||||
|
|
||||||
let mergedKey: Key = key!;
|
const { open: originOpen, prefixCls, hashId } = holderRef.value;
|
||||||
if (mergedKey === undefined || mergedKey === null) {
|
const noticePrefixCls = `${prefixCls}-notice`;
|
||||||
keyIndex += 1;
|
const { content, icon, type, key, class: className, onClose, ...restConfig } = config;
|
||||||
mergedKey = `antd-message-${keyIndex}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
return wrapPromiseFn(resolve => {
|
let mergedKey: Key = key!;
|
||||||
originOpen({
|
if (mergedKey === undefined || mergedKey === null) {
|
||||||
...restConfig,
|
keyIndex += 1;
|
||||||
key: mergedKey,
|
mergedKey = `antd-message-${keyIndex}`;
|
||||||
content: (
|
}
|
||||||
<PureContent prefixCls={prefixCls} type={type} icon={icon}>
|
|
||||||
{content}
|
|
||||||
</PureContent>
|
|
||||||
),
|
|
||||||
placement: 'top',
|
|
||||||
// @ts-ignore
|
|
||||||
class: classNames(type && `${noticePrefixCls}-${type}`, hashId, className),
|
|
||||||
onClose: () => {
|
|
||||||
onClose?.();
|
|
||||||
resolve();
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
// Return close function
|
return wrapPromiseFn(resolve => {
|
||||||
return () => {
|
originOpen({
|
||||||
close(mergedKey);
|
...restConfig,
|
||||||
};
|
key: mergedKey,
|
||||||
|
content: () => (
|
||||||
|
<PureContent
|
||||||
|
prefixCls={prefixCls}
|
||||||
|
type={type}
|
||||||
|
icon={typeof icon === 'function' ? icon() : icon}
|
||||||
|
>
|
||||||
|
{typeof content === 'function' ? content() : content}
|
||||||
|
</PureContent>
|
||||||
|
),
|
||||||
|
placement: 'top',
|
||||||
|
// @ts-ignore
|
||||||
|
class: classNames(type && `${noticePrefixCls}-${type}`, hashId, className),
|
||||||
|
onClose: () => {
|
||||||
|
onClose?.();
|
||||||
|
resolve();
|
||||||
|
},
|
||||||
});
|
});
|
||||||
};
|
|
||||||
|
|
||||||
// >>> destroy
|
// Return close function
|
||||||
const destroy = (key?: Key) => {
|
return () => {
|
||||||
if (key !== undefined) {
|
close(mergedKey);
|
||||||
close(key);
|
};
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
// >>> destroy
|
||||||
|
const destroy = (key?: Key) => {
|
||||||
|
if (key !== undefined) {
|
||||||
|
close(key);
|
||||||
|
} else {
|
||||||
|
holderRef.value?.destroy();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const wrapAPI = {
|
||||||
|
open,
|
||||||
|
destroy,
|
||||||
|
} as MessageInstance;
|
||||||
|
|
||||||
|
const keys: NoticeType[] = ['info', 'success', 'warning', 'error', 'loading'];
|
||||||
|
keys.forEach(type => {
|
||||||
|
const typeOpen: TypeOpen = (jointContent, duration, onClose) => {
|
||||||
|
let config: ArgsProps;
|
||||||
|
if (jointContent && typeof jointContent === 'object' && 'content' in jointContent) {
|
||||||
|
config = jointContent;
|
||||||
} else {
|
} else {
|
||||||
holderRef.value?.destroy();
|
config = {
|
||||||
}
|
content: jointContent as VNode,
|
||||||
};
|
|
||||||
|
|
||||||
const clone = {
|
|
||||||
open,
|
|
||||||
destroy,
|
|
||||||
} as MessageInstance;
|
|
||||||
|
|
||||||
const keys: NoticeType[] = ['info', 'success', 'warning', 'error', 'loading'];
|
|
||||||
keys.forEach(type => {
|
|
||||||
const typeOpen: TypeOpen = (jointContent, duration, onClose) => {
|
|
||||||
let config: ArgsProps;
|
|
||||||
if (jointContent && typeof jointContent === 'object' && 'content' in jointContent) {
|
|
||||||
config = jointContent;
|
|
||||||
} else {
|
|
||||||
config = {
|
|
||||||
content: jointContent as VNode,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// Params
|
|
||||||
let mergedDuration: number | undefined;
|
|
||||||
let mergedOnClose: VoidFunction | undefined;
|
|
||||||
if (typeof duration === 'function') {
|
|
||||||
mergedOnClose = duration;
|
|
||||||
} else {
|
|
||||||
mergedDuration = duration;
|
|
||||||
mergedOnClose = onClose;
|
|
||||||
}
|
|
||||||
|
|
||||||
const mergedConfig = {
|
|
||||||
onClose: mergedOnClose,
|
|
||||||
duration: mergedDuration,
|
|
||||||
...config,
|
|
||||||
type,
|
|
||||||
};
|
};
|
||||||
|
}
|
||||||
|
|
||||||
return open(mergedConfig);
|
// Params
|
||||||
|
let mergedDuration: number | undefined;
|
||||||
|
let mergedOnClose: VoidFunction | undefined;
|
||||||
|
if (typeof duration === 'function') {
|
||||||
|
mergedOnClose = duration;
|
||||||
|
} else {
|
||||||
|
mergedDuration = duration;
|
||||||
|
mergedOnClose = onClose;
|
||||||
|
}
|
||||||
|
|
||||||
|
const mergedConfig = {
|
||||||
|
onClose: mergedOnClose,
|
||||||
|
duration: mergedDuration,
|
||||||
|
...config,
|
||||||
|
type,
|
||||||
};
|
};
|
||||||
|
|
||||||
clone[type] = typeOpen;
|
return open(mergedConfig);
|
||||||
});
|
};
|
||||||
|
|
||||||
return clone;
|
wrapAPI[type] = typeOpen;
|
||||||
});
|
});
|
||||||
|
|
||||||
// ============================== Return ===============================
|
// ============================== Return ===============================
|
||||||
return [
|
return [wrapAPI, () => <Holder key={holderKey} {...messageConfig} ref={holderRef} />] as const;
|
||||||
wrapAPI.value,
|
|
||||||
() => <Holder key="message-holder" {...messageConfig} ref={holderRef} />,
|
|
||||||
] as const;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export default function useMessage(messageConfig?: ConfigOptions) {
|
export default function useMessage(messageConfig?: ConfigOptions) {
|
||||||
|
|
|
@ -144,8 +144,8 @@ function useModal(): readonly [
|
||||||
warning: getConfirmFunc(withWarn),
|
warning: getConfirmFunc(withWarn),
|
||||||
confirm: getConfirmFunc(withConfirm),
|
confirm: getConfirmFunc(withConfirm),
|
||||||
}));
|
}));
|
||||||
|
const holderKey = Symbol('modalHolderKey');
|
||||||
return [fns.value, () => <ElementsHolder key="modal-holder" ref={holderRef} />] as const;
|
return [fns.value, () => <ElementsHolder key={holderKey} ref={holderRef} />] as const;
|
||||||
}
|
}
|
||||||
|
|
||||||
export default useModal;
|
export default useModal;
|
||||||
|
|
|
@ -39,7 +39,7 @@ export type Placement = 'top' | 'topLeft' | 'topRight' | 'bottom' | 'bottomLeft'
|
||||||
export interface OpenConfig extends NoticeProps {
|
export interface OpenConfig extends NoticeProps {
|
||||||
key: Key;
|
key: Key;
|
||||||
placement?: Placement;
|
placement?: Placement;
|
||||||
content?: VueNode;
|
content?: string | (() => VueNode) | VueNode;
|
||||||
duration?: number | null;
|
duration?: number | null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -254,7 +254,7 @@ Notification.newInstance = function newNotificationInstance(properties, callback
|
||||||
const rootPrefixCls = global.getRootPrefixCls(customRootPrefixCls, prefixCls.value);
|
const rootPrefixCls = global.getRootPrefixCls(customRootPrefixCls, prefixCls.value);
|
||||||
const transitionName = hasTransitionName
|
const transitionName = hasTransitionName
|
||||||
? customTransitionName
|
? customTransitionName
|
||||||
: `${rootPrefixCls}-${customTransitionName}`;
|
: `${prefixCls.value}-${customTransitionName}`;
|
||||||
return (
|
return (
|
||||||
<ConfigProvider {...global} prefixCls={rootPrefixCls}>
|
<ConfigProvider {...global} prefixCls={rootPrefixCls}>
|
||||||
<Notification
|
<Notification
|
||||||
|
|
Loading…
Reference in New Issue