Tour.d.ts 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653
  1. import type { CSSProperties, ExtractPropTypes } from 'vue';
  2. import type { VueNode } from '../_util/type';
  3. import type { Gap } from './hooks/useTarget';
  4. import type { TourStepProps } from './interface';
  5. import type { PlacementType } from './placements';
  6. export declare const tourProps: () => {
  7. builtinPlacements: import("vue-types").VueTypeValidableDef<{
  8. [key: string]: any;
  9. }> & {
  10. default: () => {
  11. [key: string]: any;
  12. };
  13. };
  14. popupAlign: import("vue-types").VueTypeValidableDef<{
  15. [key: string]: any;
  16. }> & {
  17. default: () => {
  18. [key: string]: any;
  19. };
  20. } & {
  21. default: () => {
  22. [key: string]: any;
  23. };
  24. };
  25. steps: {
  26. type: import("vue").PropType<Partial<ExtractPropTypes<{
  27. arrow: {
  28. type: import("vue").PropType<boolean | {
  29. pointAtCenter: boolean;
  30. }>;
  31. default: boolean | {
  32. pointAtCenter: boolean;
  33. };
  34. };
  35. target: {
  36. type: import("vue").PropType<HTMLElement | (() => HTMLElement) | (() => null)>;
  37. default: HTMLElement | (() => HTMLElement) | (() => null);
  38. };
  39. title: {
  40. type: import("vue").PropType<VueNode>;
  41. default: VueNode;
  42. };
  43. description: {
  44. type: import("vue").PropType<VueNode>;
  45. default: VueNode;
  46. };
  47. placement: {
  48. type: import("vue").PropType<PlacementType>;
  49. default: PlacementType;
  50. };
  51. mask: {
  52. type: import("vue").PropType<boolean | {
  53. style?: CSSProperties;
  54. color?: string;
  55. }>;
  56. default: boolean | {
  57. style?: CSSProperties;
  58. color?: string;
  59. };
  60. };
  61. className: {
  62. type: StringConstructor;
  63. };
  64. style: {
  65. type: import("vue").PropType<CSSProperties>;
  66. default: CSSProperties;
  67. };
  68. scrollIntoViewOptions: {
  69. type: import("vue").PropType<boolean | ScrollIntoViewOptions>;
  70. default: boolean | ScrollIntoViewOptions;
  71. };
  72. }>>[]>;
  73. default: Partial<ExtractPropTypes<{
  74. arrow: {
  75. type: import("vue").PropType<boolean | {
  76. pointAtCenter: boolean;
  77. }>;
  78. default: boolean | {
  79. pointAtCenter: boolean;
  80. };
  81. };
  82. target: {
  83. type: import("vue").PropType<HTMLElement | (() => HTMLElement) | (() => null)>;
  84. default: HTMLElement | (() => HTMLElement) | (() => null);
  85. };
  86. title: {
  87. type: import("vue").PropType<VueNode>;
  88. default: VueNode;
  89. };
  90. description: {
  91. type: import("vue").PropType<VueNode>;
  92. default: VueNode;
  93. };
  94. placement: {
  95. type: import("vue").PropType<PlacementType>;
  96. default: PlacementType;
  97. };
  98. mask: {
  99. type: import("vue").PropType<boolean | {
  100. style?: CSSProperties;
  101. color?: string;
  102. }>;
  103. default: boolean | {
  104. style?: CSSProperties;
  105. color?: string;
  106. };
  107. };
  108. className: {
  109. type: StringConstructor;
  110. };
  111. style: {
  112. type: import("vue").PropType<CSSProperties>;
  113. default: CSSProperties;
  114. };
  115. scrollIntoViewOptions: {
  116. type: import("vue").PropType<boolean | ScrollIntoViewOptions>;
  117. default: boolean | ScrollIntoViewOptions;
  118. };
  119. }>>[];
  120. };
  121. open: {
  122. type: BooleanConstructor;
  123. default: boolean;
  124. };
  125. defaultCurrent: {
  126. type: NumberConstructor;
  127. };
  128. current: {
  129. type: NumberConstructor;
  130. };
  131. onChange: {
  132. type: import("vue").PropType<(current: number) => void>;
  133. default: (current: number) => void;
  134. };
  135. onClose: {
  136. type: import("vue").PropType<(current: number) => void>;
  137. default: (current: number) => void;
  138. };
  139. onFinish: {
  140. type: import("vue").PropType<() => void>;
  141. default: () => void;
  142. };
  143. mask: {
  144. type: import("vue").PropType<boolean | {
  145. style?: CSSProperties;
  146. color?: string;
  147. }>;
  148. default: boolean | {
  149. style?: CSSProperties;
  150. color?: string;
  151. };
  152. };
  153. arrow: {
  154. type: import("vue").PropType<boolean | {
  155. pointAtCenter: boolean;
  156. }>;
  157. default: boolean | {
  158. pointAtCenter: boolean;
  159. };
  160. };
  161. rootClassName: {
  162. type: StringConstructor;
  163. };
  164. placement: {
  165. type: import("vue").PropType<PlacementType>;
  166. default: PlacementType;
  167. };
  168. prefixCls: {
  169. type: StringConstructor;
  170. default: string;
  171. };
  172. renderPanel: {
  173. type: import("vue").PropType<(props: TourStepProps, current: number) => VueNode>;
  174. default: (props: TourStepProps, current: number) => VueNode;
  175. };
  176. gap: {
  177. type: import("vue").PropType<Gap>;
  178. default: Gap;
  179. };
  180. animated: {
  181. type: import("vue").PropType<boolean | {
  182. placeholder: boolean;
  183. }>;
  184. default: boolean | {
  185. placeholder: boolean;
  186. };
  187. };
  188. scrollIntoViewOptions: {
  189. type: import("vue").PropType<boolean | ScrollIntoViewOptions>;
  190. default: boolean | ScrollIntoViewOptions;
  191. };
  192. zIndex: {
  193. type: NumberConstructor;
  194. default: number;
  195. };
  196. };
  197. export type TourProps = Partial<ExtractPropTypes<ReturnType<typeof tourProps>>>;
  198. declare const Tour: import("vue").DefineComponent<{
  199. builtinPlacements: import("vue-types").VueTypeValidableDef<{
  200. [key: string]: any;
  201. }> & {
  202. default: () => {
  203. [key: string]: any;
  204. };
  205. };
  206. popupAlign: import("vue-types").VueTypeValidableDef<{
  207. [key: string]: any;
  208. }> & {
  209. default: () => {
  210. [key: string]: any;
  211. };
  212. } & {
  213. default: () => {
  214. [key: string]: any;
  215. };
  216. };
  217. steps: {
  218. type: import("vue").PropType<Partial<ExtractPropTypes<{
  219. arrow: {
  220. type: import("vue").PropType<boolean | {
  221. pointAtCenter: boolean;
  222. }>;
  223. default: boolean | {
  224. pointAtCenter: boolean;
  225. };
  226. };
  227. target: {
  228. type: import("vue").PropType<HTMLElement | (() => HTMLElement) | (() => null)>;
  229. default: HTMLElement | (() => HTMLElement) | (() => null);
  230. };
  231. title: {
  232. type: import("vue").PropType<VueNode>;
  233. default: VueNode;
  234. };
  235. description: {
  236. type: import("vue").PropType<VueNode>;
  237. default: VueNode;
  238. };
  239. placement: {
  240. type: import("vue").PropType<PlacementType>;
  241. default: PlacementType;
  242. };
  243. mask: {
  244. type: import("vue").PropType<boolean | {
  245. style?: CSSProperties;
  246. color?: string;
  247. }>;
  248. default: boolean | {
  249. style?: CSSProperties;
  250. color?: string;
  251. };
  252. };
  253. className: {
  254. type: StringConstructor;
  255. };
  256. style: {
  257. type: import("vue").PropType<CSSProperties>;
  258. default: CSSProperties;
  259. };
  260. scrollIntoViewOptions: {
  261. type: import("vue").PropType<boolean | ScrollIntoViewOptions>;
  262. default: boolean | ScrollIntoViewOptions;
  263. };
  264. }>>[]>;
  265. default: Partial<ExtractPropTypes<{
  266. arrow: {
  267. type: import("vue").PropType<boolean | {
  268. pointAtCenter: boolean;
  269. }>;
  270. default: boolean | {
  271. pointAtCenter: boolean;
  272. };
  273. };
  274. target: {
  275. type: import("vue").PropType<HTMLElement | (() => HTMLElement) | (() => null)>;
  276. default: HTMLElement | (() => HTMLElement) | (() => null);
  277. };
  278. title: {
  279. type: import("vue").PropType<VueNode>;
  280. default: VueNode;
  281. };
  282. description: {
  283. type: import("vue").PropType<VueNode>;
  284. default: VueNode;
  285. };
  286. placement: {
  287. type: import("vue").PropType<PlacementType>;
  288. default: PlacementType;
  289. };
  290. mask: {
  291. type: import("vue").PropType<boolean | {
  292. style?: CSSProperties;
  293. color?: string;
  294. }>;
  295. default: boolean | {
  296. style?: CSSProperties;
  297. color?: string;
  298. };
  299. };
  300. className: {
  301. type: StringConstructor;
  302. };
  303. style: {
  304. type: import("vue").PropType<CSSProperties>;
  305. default: CSSProperties;
  306. };
  307. scrollIntoViewOptions: {
  308. type: import("vue").PropType<boolean | ScrollIntoViewOptions>;
  309. default: boolean | ScrollIntoViewOptions;
  310. };
  311. }>>[];
  312. };
  313. open: {
  314. type: BooleanConstructor;
  315. default: boolean;
  316. };
  317. defaultCurrent: {
  318. type: NumberConstructor;
  319. };
  320. current: {
  321. type: NumberConstructor;
  322. };
  323. onChange: {
  324. type: import("vue").PropType<(current: number) => void>;
  325. default: (current: number) => void;
  326. };
  327. onClose: {
  328. type: import("vue").PropType<(current: number) => void>;
  329. default: (current: number) => void;
  330. };
  331. onFinish: {
  332. type: import("vue").PropType<() => void>;
  333. default: () => void;
  334. };
  335. mask: {
  336. type: import("vue").PropType<boolean | {
  337. style?: CSSProperties;
  338. color?: string;
  339. }>;
  340. default: boolean | {
  341. style?: CSSProperties;
  342. color?: string;
  343. };
  344. };
  345. arrow: {
  346. type: import("vue").PropType<boolean | {
  347. pointAtCenter: boolean;
  348. }>;
  349. default: boolean | {
  350. pointAtCenter: boolean;
  351. };
  352. };
  353. rootClassName: {
  354. type: StringConstructor;
  355. };
  356. placement: {
  357. type: import("vue").PropType<PlacementType>;
  358. default: PlacementType;
  359. };
  360. prefixCls: {
  361. type: StringConstructor;
  362. default: string;
  363. };
  364. renderPanel: {
  365. type: import("vue").PropType<(props: TourStepProps, current: number) => VueNode>;
  366. default: (props: TourStepProps, current: number) => VueNode;
  367. };
  368. gap: {
  369. type: import("vue").PropType<Gap>;
  370. default: Gap;
  371. };
  372. animated: {
  373. type: import("vue").PropType<boolean | {
  374. placeholder: boolean;
  375. }>;
  376. default: boolean | {
  377. placeholder: boolean;
  378. };
  379. };
  380. scrollIntoViewOptions: {
  381. type: import("vue").PropType<boolean | ScrollIntoViewOptions>;
  382. default: boolean | ScrollIntoViewOptions;
  383. };
  384. zIndex: {
  385. type: NumberConstructor;
  386. default: number;
  387. };
  388. }, () => import("vue/jsx-runtime").JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<ExtractPropTypes<{
  389. builtinPlacements: import("vue-types").VueTypeValidableDef<{
  390. [key: string]: any;
  391. }> & {
  392. default: () => {
  393. [key: string]: any;
  394. };
  395. };
  396. popupAlign: import("vue-types").VueTypeValidableDef<{
  397. [key: string]: any;
  398. }> & {
  399. default: () => {
  400. [key: string]: any;
  401. };
  402. } & {
  403. default: () => {
  404. [key: string]: any;
  405. };
  406. };
  407. steps: {
  408. type: import("vue").PropType<Partial<ExtractPropTypes<{
  409. arrow: {
  410. type: import("vue").PropType<boolean | {
  411. pointAtCenter: boolean;
  412. }>;
  413. default: boolean | {
  414. pointAtCenter: boolean;
  415. };
  416. };
  417. target: {
  418. type: import("vue").PropType<HTMLElement | (() => HTMLElement) | (() => null)>;
  419. default: HTMLElement | (() => HTMLElement) | (() => null);
  420. };
  421. title: {
  422. type: import("vue").PropType<VueNode>;
  423. default: VueNode;
  424. };
  425. description: {
  426. type: import("vue").PropType<VueNode>;
  427. default: VueNode;
  428. };
  429. placement: {
  430. type: import("vue").PropType<PlacementType>;
  431. default: PlacementType;
  432. };
  433. mask: {
  434. type: import("vue").PropType<boolean | {
  435. style?: CSSProperties;
  436. color?: string;
  437. }>;
  438. default: boolean | {
  439. style?: CSSProperties;
  440. color?: string;
  441. };
  442. };
  443. className: {
  444. type: StringConstructor;
  445. };
  446. style: {
  447. type: import("vue").PropType<CSSProperties>;
  448. default: CSSProperties;
  449. };
  450. scrollIntoViewOptions: {
  451. type: import("vue").PropType<boolean | ScrollIntoViewOptions>;
  452. default: boolean | ScrollIntoViewOptions;
  453. };
  454. }>>[]>;
  455. default: Partial<ExtractPropTypes<{
  456. arrow: {
  457. type: import("vue").PropType<boolean | {
  458. pointAtCenter: boolean;
  459. }>;
  460. default: boolean | {
  461. pointAtCenter: boolean;
  462. };
  463. };
  464. target: {
  465. type: import("vue").PropType<HTMLElement | (() => HTMLElement) | (() => null)>;
  466. default: HTMLElement | (() => HTMLElement) | (() => null);
  467. };
  468. title: {
  469. type: import("vue").PropType<VueNode>;
  470. default: VueNode;
  471. };
  472. description: {
  473. type: import("vue").PropType<VueNode>;
  474. default: VueNode;
  475. };
  476. placement: {
  477. type: import("vue").PropType<PlacementType>;
  478. default: PlacementType;
  479. };
  480. mask: {
  481. type: import("vue").PropType<boolean | {
  482. style?: CSSProperties;
  483. color?: string;
  484. }>;
  485. default: boolean | {
  486. style?: CSSProperties;
  487. color?: string;
  488. };
  489. };
  490. className: {
  491. type: StringConstructor;
  492. };
  493. style: {
  494. type: import("vue").PropType<CSSProperties>;
  495. default: CSSProperties;
  496. };
  497. scrollIntoViewOptions: {
  498. type: import("vue").PropType<boolean | ScrollIntoViewOptions>;
  499. default: boolean | ScrollIntoViewOptions;
  500. };
  501. }>>[];
  502. };
  503. open: {
  504. type: BooleanConstructor;
  505. default: boolean;
  506. };
  507. defaultCurrent: {
  508. type: NumberConstructor;
  509. };
  510. current: {
  511. type: NumberConstructor;
  512. };
  513. onChange: {
  514. type: import("vue").PropType<(current: number) => void>;
  515. default: (current: number) => void;
  516. };
  517. onClose: {
  518. type: import("vue").PropType<(current: number) => void>;
  519. default: (current: number) => void;
  520. };
  521. onFinish: {
  522. type: import("vue").PropType<() => void>;
  523. default: () => void;
  524. };
  525. mask: {
  526. type: import("vue").PropType<boolean | {
  527. style?: CSSProperties;
  528. color?: string;
  529. }>;
  530. default: boolean | {
  531. style?: CSSProperties;
  532. color?: string;
  533. };
  534. };
  535. arrow: {
  536. type: import("vue").PropType<boolean | {
  537. pointAtCenter: boolean;
  538. }>;
  539. default: boolean | {
  540. pointAtCenter: boolean;
  541. };
  542. };
  543. rootClassName: {
  544. type: StringConstructor;
  545. };
  546. placement: {
  547. type: import("vue").PropType<PlacementType>;
  548. default: PlacementType;
  549. };
  550. prefixCls: {
  551. type: StringConstructor;
  552. default: string;
  553. };
  554. renderPanel: {
  555. type: import("vue").PropType<(props: TourStepProps, current: number) => VueNode>;
  556. default: (props: TourStepProps, current: number) => VueNode;
  557. };
  558. gap: {
  559. type: import("vue").PropType<Gap>;
  560. default: Gap;
  561. };
  562. animated: {
  563. type: import("vue").PropType<boolean | {
  564. placeholder: boolean;
  565. }>;
  566. default: boolean | {
  567. placeholder: boolean;
  568. };
  569. };
  570. scrollIntoViewOptions: {
  571. type: import("vue").PropType<boolean | ScrollIntoViewOptions>;
  572. default: boolean | ScrollIntoViewOptions;
  573. };
  574. zIndex: {
  575. type: NumberConstructor;
  576. default: number;
  577. };
  578. }>>, {
  579. mask: boolean | {
  580. style?: CSSProperties;
  581. color?: string;
  582. };
  583. onChange: (current: number) => void;
  584. open: boolean;
  585. zIndex: number;
  586. gap: Gap;
  587. prefixCls: string;
  588. onClose: (current: number) => void;
  589. arrow: boolean | {
  590. pointAtCenter: boolean;
  591. };
  592. builtinPlacements: {
  593. [key: string]: any;
  594. };
  595. popupAlign: {
  596. [key: string]: any;
  597. };
  598. placement: PlacementType;
  599. steps: Partial<ExtractPropTypes<{
  600. arrow: {
  601. type: import("vue").PropType<boolean | {
  602. pointAtCenter: boolean;
  603. }>;
  604. default: boolean | {
  605. pointAtCenter: boolean;
  606. };
  607. };
  608. target: {
  609. type: import("vue").PropType<HTMLElement | (() => HTMLElement) | (() => null)>;
  610. default: HTMLElement | (() => HTMLElement) | (() => null);
  611. };
  612. title: {
  613. type: import("vue").PropType<VueNode>;
  614. default: VueNode;
  615. };
  616. description: {
  617. type: import("vue").PropType<VueNode>;
  618. default: VueNode;
  619. };
  620. placement: {
  621. type: import("vue").PropType<PlacementType>;
  622. default: PlacementType;
  623. };
  624. mask: {
  625. type: import("vue").PropType<boolean | {
  626. style?: CSSProperties;
  627. color?: string;
  628. }>;
  629. default: boolean | {
  630. style?: CSSProperties;
  631. color?: string;
  632. };
  633. };
  634. className: {
  635. type: StringConstructor;
  636. };
  637. style: {
  638. type: import("vue").PropType<CSSProperties>;
  639. default: CSSProperties;
  640. };
  641. scrollIntoViewOptions: {
  642. type: import("vue").PropType<boolean | ScrollIntoViewOptions>;
  643. default: boolean | ScrollIntoViewOptions;
  644. };
  645. }>>[];
  646. scrollIntoViewOptions: boolean | ScrollIntoViewOptions;
  647. onFinish: () => void;
  648. renderPanel: (props: TourStepProps, current: number) => VueNode;
  649. animated: boolean | {
  650. placeholder: boolean;
  651. };
  652. }, {}>;
  653. export default Tour;