UNPKG

zent

Version:

一套前端设计语言和基于React的实现

40 lines (29 loc) • 2.89 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
--- title: Elevator path: component/elevator group: Navigation --- ## Elevator The content navigation tool enables you to quickly locate a specified location on a page based on the page catalog, improving information reading and operation efficiency. ### API #### Elevator | Property | Description | Type | Required | Default | Alternative | | ----------------- | ------------------------------------------------------------- | ----------------------------------------------------- | -------- | -------------- | ----------- | | getContainer | Scrolling container | `() => HTMLElement` | false | `() => window` | | | defaultActiveLink | Default anchor highlight | `string` | false | | | | activeLink | Current anchor highlight | `string` | false | | | | offsetTop | Pixels to offset from top when calculating position of scroll | `number` | false | | | | targetOffset | Anchor scroll offset, default as offsetTop | `number` | false | | | | onChange | Listening for anchor link change | `(currentLink: string, previousLink: string) => void` | false | | | #### Elevator.Links | Property | Description | Type | Required | Default | Alternative | | --------- | ------------------------- | -------------------------------------------------- | -------- | ------- | ----------- | | links | Elevator target link list | `{ link: string, title: ReactNode }[]` | true | | | | className | Extra class name | `string` | false | | | | style | Style object | `React.CSSProperties` | false | | | | onClick | Click event | `(event: MouseEvent, currentLink: string) => void` | false | | | Consult [Affix](https://youzan.github.io/zent/zh/component/affix) to find more APIs. #### Elevator.Anchor | Property | Description | Type | Required | Default | Alternative | | -------- | --------------- | -------- | -------- | ------- | ----------- | | link | Elevator target | `string` | true | | |