chore: update type mentions (#2716)

pull/2717/head^2^2
binhaoCen 2020-08-19 15:25:36 +08:00 committed by GitHub
parent ec024c8371
commit 5d14259e7a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 62 additions and 57 deletions

View File

@ -3,70 +3,73 @@
import { AntdComponent } from '../component'; import { AntdComponent } from '../component';
import { Option } from './option'; import { Option } from './option';
import { VNodeChild } from 'vue';
export declare class Mentions extends AntdComponent { export declare class Mentions extends AntdComponent {
static Option: typeof Option; static Option: typeof Option;
/** $props: {
* Auto get focus when component mounted /**
* @default false * Auto get focus when component mounted
* @type boolean * @default false
*/ * @type boolean
autofocus: boolean; */
autofocus?: boolean;
/** /**
* Default value * Default value
* @type string * @type string
*/ */
defaultValue: string; defaultValue?: string;
/** /**
* Customize filter option logic * Customize filter option logic
* @type false | (input: string, option: OptionProps) => boolean * @type false | (input: string, option: OptionProps) => boolean
*/ */
filterOption: false | ((input: string, option: Option) => boolean); filterOption?: false | ((input: string, option: Option) => boolean);
/** /**
* Set mentions content when not match * Set mentions content when not match
* @type any (string | slot) * @type any (string | slot)
*/ */
notFoundContent: any; notFoundContent?: VNodeChild | JSX.Element;
/** /**
* Set popup placement * Set popup placement
* @default 'top' * @default 'top'
* @type string * @type string
*/ */
placement: 'top' | 'bottom'; placement?: 'top' | 'bottom';
/** /**
* Set trigger prefix keyword * Set trigger prefix keyword
* @default '@' * @default '@'
* @type string | string[] * @type string | string[]
*/ */
prefix: string | string[]; prefix?: string | string[];
/** /**
* Set split string before and after selected mention * Set split string before and after selected mention
* @default ' ' * @default ' '
* @type string * @type string
*/ */
split: string; split?: string;
/** /**
* Customize trigger search logic * Customize trigger search logic
* @type (text: string, props: MentionsProps) => void * @type (text: string, props: MentionsProps) => void
*/ */
validateSearch: (text: string, props: Mentions) => void; validateSearch?: (text: string, props: Mentions) => void;
/** /**
* Set value of mentions * Set value of mentions
* @type string * @type string
*/ */
value: string; value?: string;
/** /**
* Set the mount HTML node for suggestions * Set the mount HTML node for suggestions
* @default () => HTMLElement * @default () => HTMLElement
*/ */
getPopupContainer: (triggerNode: HTMLElement) => HTMLElement; getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement;
}
} }

View File

@ -4,10 +4,12 @@
import { AntdComponent } from '../component'; import { AntdComponent } from '../component';
export declare class Option extends AntdComponent { export declare class Option extends AntdComponent {
/** $props: {
/**
* value of suggestion, the value will insert into input filed while selected * value of suggestion, the value will insert into input filed while selected
* @default '' * @default ''
* @type string * @type string
*/ */
value: string; value?: string;
}
} }

View File

@ -22,7 +22,7 @@ export interface NotificationOptions extends NotificationConfigOptions {
* The content of notification box (required) * The content of notification box (required)
* @type string | VNode | Function * @type string | VNode | Function
*/ */
description: VNodeChild | JSX.Element | Function; description?: VNodeChild | JSX.Element | Function;
/** /**
* Customized icon * Customized icon