From 5d14259e7a4688c03c6dc25dfc7a73944da0c16a Mon Sep 17 00:00:00 2001 From: binhaoCen Date: Wed, 19 Aug 2020 15:25:36 +0800 Subject: [PATCH] chore: update type mentions (#2716) --- types/mentions/mentions.d.ts | 111 ++++++++++++++++++----------------- types/mentions/option.d.ts | 6 +- types/notification.d.ts | 2 +- 3 files changed, 62 insertions(+), 57 deletions(-) diff --git a/types/mentions/mentions.d.ts b/types/mentions/mentions.d.ts index b267b244b..b6a48309e 100644 --- a/types/mentions/mentions.d.ts +++ b/types/mentions/mentions.d.ts @@ -3,70 +3,73 @@ import { AntdComponent } from '../component'; import { Option } from './option'; +import { VNodeChild } from 'vue'; export declare class Mentions extends AntdComponent { static Option: typeof Option; - /** - * Auto get focus when component mounted - * @default false - * @type boolean - */ - autofocus: boolean; + $props: { + /** + * Auto get focus when component mounted + * @default false + * @type boolean + */ + autofocus?: boolean; - /** - * Default value - * @type string - */ - defaultValue: string; + /** + * Default value + * @type string + */ + defaultValue?: string; - /** - * Customize filter option logic - * @type false | (input: string, option: OptionProps) => boolean - */ - filterOption: false | ((input: string, option: Option) => boolean); + /** + * Customize filter option logic + * @type false | (input: string, option: OptionProps) => boolean + */ + filterOption?: false | ((input: string, option: Option) => boolean); - /** - * Set mentions content when not match - * @type any (string | slot) - */ - notFoundContent: any; + /** + * Set mentions content when not match + * @type any (string | slot) + */ + notFoundContent?: VNodeChild | JSX.Element; - /** - * Set popup placement - * @default 'top' - * @type string - */ - placement: 'top' | 'bottom'; + /** + * Set popup placement + * @default 'top' + * @type string + */ + placement?: 'top' | 'bottom'; - /** - * Set trigger prefix keyword - * @default '@' - * @type string | string[] - */ - prefix: string | string[]; + /** + * Set trigger prefix keyword + * @default '@' + * @type string | string[] + */ + prefix?: string | string[]; - /** - * Set split string before and after selected mention - * @default ' ' - * @type string - */ - split: string; + /** + * Set split string before and after selected mention + * @default ' ' + * @type string + */ + split?: string; - /** - * Customize trigger search logic - * @type (text: string, props: MentionsProps) => void - */ - validateSearch: (text: string, props: Mentions) => void; + /** + * Customize trigger search logic + * @type (text: string, props: MentionsProps) => void + */ + validateSearch?: (text: string, props: Mentions) => void; - /** - * Set value of mentions - * @type string - */ - value: string; + /** + * Set value of mentions + * @type string + */ + value?: string; - /** - * Set the mount HTML node for suggestions - * @default () => HTMLElement - */ - getPopupContainer: (triggerNode: HTMLElement) => HTMLElement; + /** + * Set the mount HTML node for suggestions + * @default () => HTMLElement + */ + getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement; + } } diff --git a/types/mentions/option.d.ts b/types/mentions/option.d.ts index 9cffee404..e0721fb4b 100644 --- a/types/mentions/option.d.ts +++ b/types/mentions/option.d.ts @@ -4,10 +4,12 @@ import { AntdComponent } from '../component'; export declare class Option extends AntdComponent { - /** + $props: { + /** * value of suggestion, the value will insert into input filed while selected * @default '' * @type string */ - value: string; + value?: string; + } } diff --git a/types/notification.d.ts b/types/notification.d.ts index aeea64bea..787eb80c0 100644 --- a/types/notification.d.ts +++ b/types/notification.d.ts @@ -22,7 +22,7 @@ export interface NotificationOptions extends NotificationConfigOptions { * The content of notification box (required) * @type string | VNode | Function */ - description: VNodeChild | JSX.Element | Function; + description?: VNodeChild | JSX.Element | Function; /** * Customized icon