71 lines
2.5 KiB
Markdown
71 lines
2.5 KiB
Markdown
# Anchor <small>锚点</small>
|
||
|
||
## 示例
|
||
|
||
### 普通锚点
|
||
|
||
使用 [`container`](#props-container) 属性设置发生滚动的容器，当 `Anchor` 组件不在容器中（也就不随容器滚动），此时可以不用设置 [`sticky`](#props-sticky) 属性。
|
||
|
||
[[ demo src="/demo/anchor/normal.vue" ]]
|
||
|
||
### 吸附锚点
|
||
|
||
当 `Anchor` 组件在容器中（随容器滚动），此时可设置 [`sticky`](#props-sticky) 属性来控制组件在滚动出容器时进行吸附。
|
||
|
||
[[ demo src="/demo/anchor/sticky.vue" ]]
|
||
|
||
### 指定偏移
|
||
|
||
用 [`target-offset`](#props-target-offset) 属性来控制锚点滚动到容器何处开始处于激活状态。
|
||
|
||
用 [`sticky-offset`](#props-sticky-offset) 属性来控制 `Anchor` 处于容器何处时开始吸附。
|
||
|
||
[[ demo src="/demo/anchor/offset.vue" ]]
|
||
|
||
## API
|
||
|
||
### 属性
|
||
|
||
| 名称 | 类型 | 默认值 | 描述 |
|
||
| -- | -- | -- | -- |
|
||
| ``items`` | `Array<{value, label, children}>` | `[]` | [^items] |
|
||
| ``sticky`` | `boolean=` | `false` | 是否有吸附效果。 |
|
||
| ``container`` | `string | HTMLElement | Window=` | - | `Anchor` 吸附与判断锚点激活所参考的容器。 |
|
||
| ``target-offset`` | `string | number=` | `0` | 当某个锚点处于到容器的 `target-offset` 位置，那么对应的锚点链接处于激活状态。数值类型值为 `px` 值，也可以传入如 `'10%'` 的百分比字符串，将基于 `container` 对应容器的高度比例进行计算。 |
|
||
| ``sticky-offset`` | `string | number=` | `0` | 对于 sticky `Anchor` 而言，当容器滚动到 `sticky-offset` 位置，那么该 `Anchor` 开始吸附。不同值类型含义同 [`target-offset`](#props-target-offset) 属性。 |
|
||
|
||
^^^items
|
||
数据源数组，每个项目类型为 `{label, value, children, ...}`。
|
||
|
||
+++字段详情
|
||
| 名称 | 类型 | 描述 |
|
||
| -- | -- | -- |
|
||
| `label` | `string` | 节点的文字描述。 |
|
||
| `value` | `string` | 节点对应的值，一般是页内 hash， 如 `#button` 。 |
|
||
| `children` | `Array<Object>=` | 节点的子节点数组，数组项类型同 [`items`](#props-items) 数组项。 |
|
||
+++
|
||
^^^
|
||
|
||
### 插槽
|
||
|
||
| 名称 | 描述 |
|
||
| -- | -- |
|
||
| ``item`` | [^slot-item] |
|
||
| ``item-label`` | [^slot-item-label] |
|
||
|
||
^^^slot-item
|
||
渲染每个锚点链接。
|
||
|
||
默认内容：锚点链接。
|
||
|
||
作用域参数参见 [`items`](#props-items) 属性详情。
|
||
^^^
|
||
|
||
^^^slot-item-label
|
||
渲染每个锚点链接的文本。
|
||
|
||
默认内容：锚点链接的描述文本 `label`。
|
||
|
||
作用域参数参见 [`item`](#slots-item) 插槽。
|
||
^^^
|