index.d.ts 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408
  1. import type { App, PropType, ExtractPropTypes } from 'vue';
  2. import type { KeyboardEventHandler } from '../_util/EventInterface';
  3. interface MentionsConfig {
  4. prefix?: string | string[];
  5. split?: string;
  6. }
  7. export interface MentionsOptionProps {
  8. value: string;
  9. disabled?: boolean;
  10. label?: string | number | ((o: MentionsOptionProps) => any);
  11. [key: string]: any;
  12. }
  13. interface MentionsEntity {
  14. prefix: string;
  15. value: string;
  16. }
  17. export declare type MentionPlacement = 'top' | 'bottom';
  18. export declare const mentionsProps: () => {
  19. loading: {
  20. type: BooleanConstructor;
  21. default: any;
  22. };
  23. onFocus: {
  24. type: PropType<(e: FocusEvent) => void>;
  25. };
  26. onBlur: {
  27. type: PropType<(e: FocusEvent) => void>;
  28. };
  29. onSelect: {
  30. type: PropType<(option: MentionsOptionProps, prefix: string) => void>;
  31. };
  32. onChange: {
  33. type: PropType<(text: string) => void>;
  34. };
  35. onPressenter: {
  36. type: PropType<KeyboardEventHandler>;
  37. };
  38. 'onUpdate:value': {
  39. type: PropType<(text: string) => void>;
  40. };
  41. notFoundContent: import("vue-types").VueTypeValidableDef<any>;
  42. defaultValue: StringConstructor;
  43. id: StringConstructor;
  44. autofocus: {
  45. type: BooleanConstructor;
  46. default: any;
  47. };
  48. prefix: import("vue-types").VueTypeDef<string | string[]>;
  49. prefixCls: StringConstructor;
  50. value: StringConstructor;
  51. disabled: {
  52. type: BooleanConstructor;
  53. default: any;
  54. };
  55. split: StringConstructor;
  56. transitionName: StringConstructor;
  57. placement: import("vue-types").VueTypeDef<"bottom" | "top">;
  58. character: import("vue-types").VueTypeValidableDef<any>;
  59. characterRender: FunctionConstructor;
  60. filterOption: {
  61. type: PropType<false | typeof import("../vc-mentions/src/util").filterOption>;
  62. };
  63. validateSearch: FunctionConstructor;
  64. getPopupContainer: {
  65. type: PropType<() => HTMLElement>;
  66. };
  67. options: {
  68. type: PropType<Partial<ExtractPropTypes<{
  69. value: StringConstructor;
  70. disabled: BooleanConstructor;
  71. label: (FunctionConstructor | StringConstructor | NumberConstructor)[];
  72. }>>>;
  73. default: () => any;
  74. };
  75. rows: (StringConstructor | NumberConstructor)[];
  76. direction: {
  77. type: PropType<import("../vc-mentions/src/mentionsProps").Direction>;
  78. };
  79. };
  80. export declare type MentionsProps = Partial<ExtractPropTypes<ReturnType<typeof mentionsProps>>>;
  81. export declare const MentionsOption: import("vue").DefineComponent<{
  82. value: StringConstructor;
  83. disabled: BooleanConstructor;
  84. label: (FunctionConstructor | StringConstructor | NumberConstructor)[];
  85. }, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<ExtractPropTypes<{
  86. value: StringConstructor;
  87. disabled: BooleanConstructor;
  88. label: (FunctionConstructor | StringConstructor | NumberConstructor)[];
  89. }>>, {
  90. disabled: boolean;
  91. }>;
  92. declare const _default: {
  93. new (...args: any[]): {
  94. $: import("vue").ComponentInternalInstance;
  95. $data: {};
  96. $props: Partial<{
  97. disabled: boolean;
  98. autofocus: boolean;
  99. options: any;
  100. loading: boolean;
  101. }> & Omit<Readonly<ExtractPropTypes<{
  102. loading: {
  103. type: BooleanConstructor;
  104. default: any;
  105. };
  106. onFocus: {
  107. type: PropType<(e: FocusEvent) => void>;
  108. };
  109. onBlur: {
  110. type: PropType<(e: FocusEvent) => void>;
  111. };
  112. onSelect: {
  113. type: PropType<(option: MentionsOptionProps, prefix: string) => void>;
  114. };
  115. onChange: {
  116. type: PropType<(text: string) => void>;
  117. };
  118. onPressenter: {
  119. type: PropType<KeyboardEventHandler>;
  120. };
  121. 'onUpdate:value': {
  122. type: PropType<(text: string) => void>;
  123. };
  124. notFoundContent: import("vue-types").VueTypeValidableDef<any>;
  125. defaultValue: StringConstructor;
  126. id: StringConstructor;
  127. autofocus: {
  128. type: BooleanConstructor;
  129. default: any;
  130. };
  131. prefix: import("vue-types").VueTypeDef<string | string[]>;
  132. prefixCls: StringConstructor;
  133. value: StringConstructor;
  134. disabled: {
  135. type: BooleanConstructor;
  136. default: any;
  137. };
  138. split: StringConstructor;
  139. transitionName: StringConstructor;
  140. placement: import("vue-types").VueTypeDef<"bottom" | "top">;
  141. character: import("vue-types").VueTypeValidableDef<any>;
  142. characterRender: FunctionConstructor;
  143. filterOption: {
  144. type: PropType<false | typeof import("../vc-mentions/src/util").filterOption>;
  145. };
  146. validateSearch: FunctionConstructor;
  147. getPopupContainer: {
  148. type: PropType<() => HTMLElement>;
  149. };
  150. options: {
  151. type: PropType<Partial<ExtractPropTypes<{
  152. value: StringConstructor;
  153. disabled: BooleanConstructor;
  154. label: (FunctionConstructor | StringConstructor | NumberConstructor)[];
  155. }>>>;
  156. default: () => any;
  157. };
  158. rows: (StringConstructor | NumberConstructor)[];
  159. direction: {
  160. type: PropType<import("../vc-mentions/src/mentionsProps").Direction>;
  161. };
  162. }>> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, "disabled" | "autofocus" | "options" | "loading">;
  163. $attrs: {
  164. [x: string]: unknown;
  165. };
  166. $refs: {
  167. [x: string]: unknown;
  168. };
  169. $slots: Readonly<{
  170. [name: string]: import("vue").Slot;
  171. }>;
  172. $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>;
  173. $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>;
  174. $emit: (event: string, ...args: any[]) => void;
  175. $el: any;
  176. $options: import("vue").ComponentOptionsBase<Readonly<ExtractPropTypes<{
  177. loading: {
  178. type: BooleanConstructor;
  179. default: any;
  180. };
  181. onFocus: {
  182. type: PropType<(e: FocusEvent) => void>;
  183. };
  184. onBlur: {
  185. type: PropType<(e: FocusEvent) => void>;
  186. };
  187. onSelect: {
  188. type: PropType<(option: MentionsOptionProps, prefix: string) => void>;
  189. };
  190. onChange: {
  191. type: PropType<(text: string) => void>;
  192. };
  193. onPressenter: {
  194. type: PropType<KeyboardEventHandler>;
  195. };
  196. 'onUpdate:value': {
  197. type: PropType<(text: string) => void>;
  198. };
  199. notFoundContent: import("vue-types").VueTypeValidableDef<any>;
  200. defaultValue: StringConstructor;
  201. id: StringConstructor;
  202. autofocus: {
  203. type: BooleanConstructor;
  204. default: any;
  205. };
  206. prefix: import("vue-types").VueTypeDef<string | string[]>;
  207. prefixCls: StringConstructor;
  208. value: StringConstructor;
  209. disabled: {
  210. type: BooleanConstructor;
  211. default: any;
  212. };
  213. split: StringConstructor;
  214. transitionName: StringConstructor;
  215. placement: import("vue-types").VueTypeDef<"bottom" | "top">;
  216. character: import("vue-types").VueTypeValidableDef<any>;
  217. characterRender: FunctionConstructor;
  218. filterOption: {
  219. type: PropType<false | typeof import("../vc-mentions/src/util").filterOption>;
  220. };
  221. validateSearch: FunctionConstructor;
  222. getPopupContainer: {
  223. type: PropType<() => HTMLElement>;
  224. };
  225. options: {
  226. type: PropType<Partial<ExtractPropTypes<{
  227. value: StringConstructor;
  228. disabled: BooleanConstructor;
  229. label: (FunctionConstructor | StringConstructor | NumberConstructor)[];
  230. }>>>;
  231. default: () => any;
  232. };
  233. rows: (StringConstructor | NumberConstructor)[];
  234. direction: {
  235. type: PropType<import("../vc-mentions/src/mentionsProps").Direction>;
  236. };
  237. }>>, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
  238. disabled: boolean;
  239. autofocus: boolean;
  240. options: any;
  241. loading: boolean;
  242. }> & {
  243. beforeCreate?: (() => void) | (() => void)[];
  244. created?: (() => void) | (() => void)[];
  245. beforeMount?: (() => void) | (() => void)[];
  246. mounted?: (() => void) | (() => void)[];
  247. beforeUpdate?: (() => void) | (() => void)[];
  248. updated?: (() => void) | (() => void)[];
  249. activated?: (() => void) | (() => void)[];
  250. deactivated?: (() => void) | (() => void)[];
  251. beforeDestroy?: (() => void) | (() => void)[];
  252. beforeUnmount?: (() => void) | (() => void)[];
  253. destroyed?: (() => void) | (() => void)[];
  254. unmounted?: (() => void) | (() => void)[];
  255. renderTracked?: ((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[];
  256. renderTriggered?: ((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[];
  257. errorCaptured?: ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>, info: string) => boolean | void)[];
  258. };
  259. $forceUpdate: () => void;
  260. $nextTick: typeof import("vue").nextTick;
  261. $watch(source: string | Function, cb: Function, options?: import("vue").WatchOptions<boolean>): import("vue").WatchStopHandle;
  262. } & Readonly<ExtractPropTypes<{
  263. loading: {
  264. type: BooleanConstructor;
  265. default: any;
  266. };
  267. onFocus: {
  268. type: PropType<(e: FocusEvent) => void>;
  269. };
  270. onBlur: {
  271. type: PropType<(e: FocusEvent) => void>;
  272. };
  273. onSelect: {
  274. type: PropType<(option: MentionsOptionProps, prefix: string) => void>;
  275. };
  276. onChange: {
  277. type: PropType<(text: string) => void>;
  278. };
  279. onPressenter: {
  280. type: PropType<KeyboardEventHandler>;
  281. };
  282. 'onUpdate:value': {
  283. type: PropType<(text: string) => void>;
  284. };
  285. notFoundContent: import("vue-types").VueTypeValidableDef<any>;
  286. defaultValue: StringConstructor;
  287. id: StringConstructor;
  288. autofocus: {
  289. type: BooleanConstructor;
  290. default: any;
  291. };
  292. prefix: import("vue-types").VueTypeDef<string | string[]>;
  293. prefixCls: StringConstructor;
  294. value: StringConstructor;
  295. disabled: {
  296. type: BooleanConstructor;
  297. default: any;
  298. };
  299. split: StringConstructor;
  300. transitionName: StringConstructor;
  301. placement: import("vue-types").VueTypeDef<"bottom" | "top">;
  302. character: import("vue-types").VueTypeValidableDef<any>;
  303. characterRender: FunctionConstructor;
  304. filterOption: {
  305. type: PropType<false | typeof import("../vc-mentions/src/util").filterOption>;
  306. };
  307. validateSearch: FunctionConstructor;
  308. getPopupContainer: {
  309. type: PropType<() => HTMLElement>;
  310. };
  311. options: {
  312. type: PropType<Partial<ExtractPropTypes<{
  313. value: StringConstructor;
  314. disabled: BooleanConstructor;
  315. label: (FunctionConstructor | StringConstructor | NumberConstructor)[];
  316. }>>>;
  317. default: () => any;
  318. };
  319. rows: (StringConstructor | NumberConstructor)[];
  320. direction: {
  321. type: PropType<import("../vc-mentions/src/mentionsProps").Direction>;
  322. };
  323. }>> & import("vue").ShallowUnwrapRef<() => JSX.Element> & {} & import("vue").ComponentCustomProperties;
  324. __isFragment?: never;
  325. __isTeleport?: never;
  326. __isSuspense?: never;
  327. } & import("vue").ComponentOptionsBase<Readonly<ExtractPropTypes<{
  328. loading: {
  329. type: BooleanConstructor;
  330. default: any;
  331. };
  332. onFocus: {
  333. type: PropType<(e: FocusEvent) => void>;
  334. };
  335. onBlur: {
  336. type: PropType<(e: FocusEvent) => void>;
  337. };
  338. onSelect: {
  339. type: PropType<(option: MentionsOptionProps, prefix: string) => void>;
  340. };
  341. onChange: {
  342. type: PropType<(text: string) => void>;
  343. };
  344. onPressenter: {
  345. type: PropType<KeyboardEventHandler>;
  346. };
  347. 'onUpdate:value': {
  348. type: PropType<(text: string) => void>;
  349. };
  350. notFoundContent: import("vue-types").VueTypeValidableDef<any>;
  351. defaultValue: StringConstructor;
  352. id: StringConstructor;
  353. autofocus: {
  354. type: BooleanConstructor;
  355. default: any;
  356. };
  357. prefix: import("vue-types").VueTypeDef<string | string[]>;
  358. prefixCls: StringConstructor;
  359. value: StringConstructor;
  360. disabled: {
  361. type: BooleanConstructor;
  362. default: any;
  363. };
  364. split: StringConstructor;
  365. transitionName: StringConstructor;
  366. placement: import("vue-types").VueTypeDef<"bottom" | "top">;
  367. character: import("vue-types").VueTypeValidableDef<any>;
  368. characterRender: FunctionConstructor;
  369. filterOption: {
  370. type: PropType<false | typeof import("../vc-mentions/src/util").filterOption>;
  371. };
  372. validateSearch: FunctionConstructor;
  373. getPopupContainer: {
  374. type: PropType<() => HTMLElement>;
  375. };
  376. options: {
  377. type: PropType<Partial<ExtractPropTypes<{
  378. value: StringConstructor;
  379. disabled: BooleanConstructor;
  380. label: (FunctionConstructor | StringConstructor | NumberConstructor)[];
  381. }>>>;
  382. default: () => any;
  383. };
  384. rows: (StringConstructor | NumberConstructor)[];
  385. direction: {
  386. type: PropType<import("../vc-mentions/src/mentionsProps").Direction>;
  387. };
  388. }>>, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
  389. disabled: boolean;
  390. autofocus: boolean;
  391. options: any;
  392. loading: boolean;
  393. }> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & {
  394. Option: import("vue").DefineComponent<{
  395. value: StringConstructor;
  396. disabled: BooleanConstructor;
  397. label: (FunctionConstructor | StringConstructor | NumberConstructor)[];
  398. }, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<ExtractPropTypes<{
  399. value: StringConstructor;
  400. disabled: BooleanConstructor;
  401. label: (FunctionConstructor | StringConstructor | NumberConstructor)[];
  402. }>>, {
  403. disabled: boolean;
  404. }>;
  405. getMentions: (value?: string, config?: MentionsConfig) => MentionsEntity[];
  406. install: (app: App) => App<any>;
  407. };
  408. export default _default;