naive-ui
Version:
A Vue 3 Component Library. Fairly Complete, Theme Customizable, Uses TypeScript, Fast
522 lines (521 loc) • 18.5 kB
TypeScript
import { type CSSProperties, type ExtractPropTypes, type PropType, type Ref } from 'vue';
import type { MergedTheme } from '../../_mixins';
import { type ExtractPublicPropTypes, type Mutable } from '../../_utils';
import { type NotificationTheme } from '../styles';
import type { NotificationOptions } from './NotificationEnvironment';
export type NotificationPlacement = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'top' | 'bottom';
export interface NotificationProviderInjection {
props: ExtractPropTypes<typeof notificationProviderProps>;
mergedClsPrefixRef: Ref<string>;
mergedThemeRef: Ref<MergedTheme<NotificationTheme>>;
wipTransitionCountRef: Ref<number>;
}
type Create = (options: NotificationOptions) => NotificationReactive;
type TypedCreate = (options: Omit<NotificationOptions, 'type'>) => NotificationReactive;
export interface NotificationApiInjection {
create: Create;
info: TypedCreate;
success: TypedCreate;
warning: TypedCreate;
error: TypedCreate;
/** @deprecated */
open: Create;
destroyAll: () => void;
}
export type NotificationProviderInst = NotificationApiInjection;
export declare const notificationApiInjectionKey: import("vue").InjectionKey<NotificationApiInjection>;
export type NotificationType = 'info' | 'success' | 'warning' | 'error';
export type NotificationReactive = {
readonly key: string;
readonly destroy: () => void;
/** @deprecated */
readonly hide: () => void;
/** @deprecated */
readonly deactivate: () => void;
} & Mutable<NotificationOptions>;
interface NotificationRef {
hide: () => void;
}
export declare const notificationProviderProps: {
containerClass: StringConstructor;
containerStyle: PropType<string | CSSProperties>;
to: PropType<string | HTMLElement>;
scrollable: {
type: BooleanConstructor;
default: boolean;
};
max: NumberConstructor;
placement: {
type: PropType<NotificationPlacement>;
default: string;
};
keepAliveOnHover: BooleanConstructor;
theme: PropType<import("../../_mixins").Theme<"Notification", {
borderRadius: string;
lineHeight: string;
fontSize: string;
headerFontWeight: string;
iconColor: string;
iconColorSuccess: string;
iconColorInfo: string;
iconColorWarning: string;
iconColorError: string;
color: string;
textColor: string;
closeIconColor: string;
closeIconColorHover: string;
closeIconColorPressed: string;
closeBorderRadius: string;
closeColorHover: string;
closeColorPressed: string;
headerTextColor: string;
descriptionTextColor: string;
actionTextColor: string;
boxShadow: string;
closeMargin: string;
closeSize: string;
closeIconSize: string;
width: string;
padding: string;
titleFontSize: string;
metaFontSize: string;
descriptionFontSize: string;
}, {
Scrollbar: import("../../_mixins").Theme<"Scrollbar", {
height: string;
width: string;
borderRadius: string;
color: string;
colorHover: string;
railInsetHorizontalBottom: string;
railInsetHorizontalTop: string;
railInsetVerticalRight: string;
railInsetVerticalLeft: string;
railColor: string;
}, any>;
}>>;
themeOverrides: PropType<import("../../_mixins/use-theme").ExtractThemeOverrides<import("../../_mixins").Theme<"Notification", {
borderRadius: string;
lineHeight: string;
fontSize: string;
headerFontWeight: string;
iconColor: string;
iconColorSuccess: string;
iconColorInfo: string;
iconColorWarning: string;
iconColorError: string;
color: string;
textColor: string;
closeIconColor: string;
closeIconColorHover: string;
closeIconColorPressed: string;
closeBorderRadius: string;
closeColorHover: string;
closeColorPressed: string;
headerTextColor: string;
descriptionTextColor: string;
actionTextColor: string;
boxShadow: string;
closeMargin: string;
closeSize: string;
closeIconSize: string;
width: string;
padding: string;
titleFontSize: string;
metaFontSize: string;
descriptionFontSize: string;
}, {
Scrollbar: import("../../_mixins").Theme<"Scrollbar", {
height: string;
width: string;
borderRadius: string;
color: string;
colorHover: string;
railInsetHorizontalBottom: string;
railInsetHorizontalTop: string;
railInsetVerticalRight: string;
railInsetVerticalLeft: string;
railColor: string;
}, any>;
}>>>;
builtinThemeOverrides: PropType<import("../../_mixins/use-theme").ExtractThemeOverrides<import("../../_mixins").Theme<"Notification", {
borderRadius: string;
lineHeight: string;
fontSize: string;
headerFontWeight: string;
iconColor: string;
iconColorSuccess: string;
iconColorInfo: string;
iconColorWarning: string;
iconColorError: string;
color: string;
textColor: string;
closeIconColor: string;
closeIconColorHover: string;
closeIconColorPressed: string;
closeBorderRadius: string;
closeColorHover: string;
closeColorPressed: string;
headerTextColor: string;
descriptionTextColor: string;
actionTextColor: string;
boxShadow: string;
closeMargin: string;
closeSize: string;
closeIconSize: string;
width: string;
padding: string;
titleFontSize: string;
metaFontSize: string;
descriptionFontSize: string;
}, {
Scrollbar: import("../../_mixins").Theme<"Scrollbar", {
height: string;
width: string;
borderRadius: string;
color: string;
colorHover: string;
railInsetHorizontalBottom: string;
railInsetHorizontalTop: string;
railInsetVerticalRight: string;
railInsetVerticalLeft: string;
railColor: string;
}, any>;
}>>>;
};
export type NotificationProviderProps = ExtractPublicPropTypes<typeof notificationProviderProps>;
declare const _default: import("vue").DefineComponent<{
containerClass: StringConstructor;
containerStyle: PropType<string | CSSProperties>;
to: PropType<string | HTMLElement>;
scrollable: {
type: BooleanConstructor;
default: boolean;
};
max: NumberConstructor;
placement: {
type: PropType<NotificationPlacement>;
default: string;
};
keepAliveOnHover: BooleanConstructor;
theme: PropType<import("../../_mixins").Theme<"Notification", {
borderRadius: string;
lineHeight: string;
fontSize: string;
headerFontWeight: string;
iconColor: string;
iconColorSuccess: string;
iconColorInfo: string;
iconColorWarning: string;
iconColorError: string;
color: string;
textColor: string;
closeIconColor: string;
closeIconColorHover: string;
closeIconColorPressed: string;
closeBorderRadius: string;
closeColorHover: string;
closeColorPressed: string;
headerTextColor: string;
descriptionTextColor: string;
actionTextColor: string;
boxShadow: string;
closeMargin: string;
closeSize: string;
closeIconSize: string;
width: string;
padding: string;
titleFontSize: string;
metaFontSize: string;
descriptionFontSize: string;
}, {
Scrollbar: import("../../_mixins").Theme<"Scrollbar", {
height: string;
width: string;
borderRadius: string;
color: string;
colorHover: string;
railInsetHorizontalBottom: string;
railInsetHorizontalTop: string;
railInsetVerticalRight: string;
railInsetVerticalLeft: string;
railColor: string;
}, any>;
}>>;
themeOverrides: PropType<import("../../_mixins/use-theme").ExtractThemeOverrides<import("../../_mixins").Theme<"Notification", {
borderRadius: string;
lineHeight: string;
fontSize: string;
headerFontWeight: string;
iconColor: string;
iconColorSuccess: string;
iconColorInfo: string;
iconColorWarning: string;
iconColorError: string;
color: string;
textColor: string;
closeIconColor: string;
closeIconColorHover: string;
closeIconColorPressed: string;
closeBorderRadius: string;
closeColorHover: string;
closeColorPressed: string;
headerTextColor: string;
descriptionTextColor: string;
actionTextColor: string;
boxShadow: string;
closeMargin: string;
closeSize: string;
closeIconSize: string;
width: string;
padding: string;
titleFontSize: string;
metaFontSize: string;
descriptionFontSize: string;
}, {
Scrollbar: import("../../_mixins").Theme<"Scrollbar", {
height: string;
width: string;
borderRadius: string;
color: string;
colorHover: string;
railInsetHorizontalBottom: string;
railInsetHorizontalTop: string;
railInsetVerticalRight: string;
railInsetVerticalLeft: string;
railColor: string;
}, any>;
}>>>;
builtinThemeOverrides: PropType<import("../../_mixins/use-theme").ExtractThemeOverrides<import("../../_mixins").Theme<"Notification", {
borderRadius: string;
lineHeight: string;
fontSize: string;
headerFontWeight: string;
iconColor: string;
iconColorSuccess: string;
iconColorInfo: string;
iconColorWarning: string;
iconColorError: string;
color: string;
textColor: string;
closeIconColor: string;
closeIconColorHover: string;
closeIconColorPressed: string;
closeBorderRadius: string;
closeColorHover: string;
closeColorPressed: string;
headerTextColor: string;
descriptionTextColor: string;
actionTextColor: string;
boxShadow: string;
closeMargin: string;
closeSize: string;
closeIconSize: string;
width: string;
padding: string;
titleFontSize: string;
metaFontSize: string;
descriptionFontSize: string;
}, {
Scrollbar: import("../../_mixins").Theme<"Scrollbar", {
height: string;
width: string;
borderRadius: string;
color: string;
colorHover: string;
railInsetHorizontalBottom: string;
railInsetHorizontalTop: string;
railInsetVerticalRight: string;
railInsetVerticalLeft: string;
railColor: string;
}, any>;
}>>>;
}, {
mergedClsPrefix: Ref<string>;
notificationList: Ref<{
readonly key: string;
readonly destroy: () => void;
readonly hide: () => void;
readonly deactivate: () => void;
type?: "default" | "error" | "info" | "success" | "warning" | undefined;
closable?: boolean | undefined;
keepAliveOnHover?: boolean | undefined;
meta?: string | (() => import("vue").VNodeChild) | undefined;
content?: string | (() => import("vue").VNodeChild) | undefined;
description?: string | (() => import("vue").VNodeChild) | undefined;
title?: string | (() => import("vue").VNodeChild) | undefined;
duration?: number | undefined;
onAfterEnter?: (() => void) | undefined;
onLeave?: (() => void) | undefined;
onAfterLeave?: (() => void) | undefined;
onMouseenter?: ((e: MouseEvent) => void) | undefined;
onMouseleave?: ((e: MouseEvent) => void) | undefined;
action?: string | (() => import("vue").VNodeChild) | undefined;
onClose?: (() => Promise<boolean> | boolean | any) | undefined;
avatar?: (() => import("vue").VNodeChild) | undefined;
onHide?: (() => void) | undefined;
onAfterHide?: (() => void) | undefined;
onAfterShow?: (() => void) | undefined;
}[]>;
notificationRefs: Record<string, NotificationRef>;
handleAfterLeave: (key: string) => void;
} & {
create: (options: NotificationOptions) => NotificationReactive;
info: (options: Omit<NotificationOptions, "type">) => NotificationReactive;
success: (options: Omit<NotificationOptions, "type">) => NotificationReactive;
warning: (options: Omit<NotificationOptions, "type">) => NotificationReactive;
error: (options: Omit<NotificationOptions, "type">) => NotificationReactive;
open: (options: NotificationOptions) => NotificationReactive;
destroyAll: () => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<ExtractPropTypes<{
containerClass: StringConstructor;
containerStyle: PropType<string | CSSProperties>;
to: PropType<string | HTMLElement>;
scrollable: {
type: BooleanConstructor;
default: boolean;
};
max: NumberConstructor;
placement: {
type: PropType<NotificationPlacement>;
default: string;
};
keepAliveOnHover: BooleanConstructor;
theme: PropType<import("../../_mixins").Theme<"Notification", {
borderRadius: string;
lineHeight: string;
fontSize: string;
headerFontWeight: string;
iconColor: string;
iconColorSuccess: string;
iconColorInfo: string;
iconColorWarning: string;
iconColorError: string;
color: string;
textColor: string;
closeIconColor: string;
closeIconColorHover: string;
closeIconColorPressed: string;
closeBorderRadius: string;
closeColorHover: string;
closeColorPressed: string;
headerTextColor: string;
descriptionTextColor: string;
actionTextColor: string;
boxShadow: string;
closeMargin: string;
closeSize: string;
closeIconSize: string;
width: string;
padding: string;
titleFontSize: string;
metaFontSize: string;
descriptionFontSize: string;
}, {
Scrollbar: import("../../_mixins").Theme<"Scrollbar", {
height: string;
width: string;
borderRadius: string;
color: string;
colorHover: string;
railInsetHorizontalBottom: string;
railInsetHorizontalTop: string;
railInsetVerticalRight: string;
railInsetVerticalLeft: string;
railColor: string;
}, any>;
}>>;
themeOverrides: PropType<import("../../_mixins/use-theme").ExtractThemeOverrides<import("../../_mixins").Theme<"Notification", {
borderRadius: string;
lineHeight: string;
fontSize: string;
headerFontWeight: string;
iconColor: string;
iconColorSuccess: string;
iconColorInfo: string;
iconColorWarning: string;
iconColorError: string;
color: string;
textColor: string;
closeIconColor: string;
closeIconColorHover: string;
closeIconColorPressed: string;
closeBorderRadius: string;
closeColorHover: string;
closeColorPressed: string;
headerTextColor: string;
descriptionTextColor: string;
actionTextColor: string;
boxShadow: string;
closeMargin: string;
closeSize: string;
closeIconSize: string;
width: string;
padding: string;
titleFontSize: string;
metaFontSize: string;
descriptionFontSize: string;
}, {
Scrollbar: import("../../_mixins").Theme<"Scrollbar", {
height: string;
width: string;
borderRadius: string;
color: string;
colorHover: string;
railInsetHorizontalBottom: string;
railInsetHorizontalTop: string;
railInsetVerticalRight: string;
railInsetVerticalLeft: string;
railColor: string;
}, any>;
}>>>;
builtinThemeOverrides: PropType<import("../../_mixins/use-theme").ExtractThemeOverrides<import("../../_mixins").Theme<"Notification", {
borderRadius: string;
lineHeight: string;
fontSize: string;
headerFontWeight: string;
iconColor: string;
iconColorSuccess: string;
iconColorInfo: string;
iconColorWarning: string;
iconColorError: string;
color: string;
textColor: string;
closeIconColor: string;
closeIconColorHover: string;
closeIconColorPressed: string;
closeBorderRadius: string;
closeColorHover: string;
closeColorPressed: string;
headerTextColor: string;
descriptionTextColor: string;
actionTextColor: string;
boxShadow: string;
closeMargin: string;
closeSize: string;
closeIconSize: string;
width: string;
padding: string;
titleFontSize: string;
metaFontSize: string;
descriptionFontSize: string;
}, {
Scrollbar: import("../../_mixins").Theme<"Scrollbar", {
height: string;
width: string;
borderRadius: string;
color: string;
colorHover: string;
railInsetHorizontalBottom: string;
railInsetHorizontalTop: string;
railInsetVerticalRight: string;
railInsetVerticalLeft: string;
railColor: string;
}, any>;
}>>>;
}>>, {
placement: NotificationPlacement;
scrollable: boolean;
keepAliveOnHover: boolean;
}, {}>;
export default _default;