diff --git a/one/build/remark-anchor.js b/one/build/remark-anchor.js index 5d8931e..38f215f 100644 --- a/one/build/remark-anchor.js +++ b/one/build/remark-anchor.js @@ -6,7 +6,10 @@ const KNOWN_SCOPES_CONFIG = { methods: '方法', slots: '插槽', icons: '图标', - configs: '全局配置' + configs: '全局配置', + options: '绑定值', + modifiers: '修饰符', + arguments: '参数' } const KNOWN_SCOPES = Object.entries(KNOWN_SCOPES_CONFIG).reduce( (acc, [key, value]) => { diff --git a/one/docs/directives/v-drag.md b/one/docs/directives/v-drag.md index deeba52..eddbf77 100644 --- a/one/docs/directives/v-drag.md +++ b/one/docs/directives/v-drag.md @@ -10,7 +10,7 @@ [[ demo src="/demo/directives/drag/base.vue" ]] -### 在指定元素区域内拖动 +### 限制拖动范围 [[ demo src="/demo/directives/drag/containment.vue" ]] @@ -42,20 +42,35 @@ | 参数 | 类型 | 默认值 | 描述 | | -- | -- | -- | -- | -| `targets` | `Array` | `[]` | [^targets] | -| `type` | `string` | - | 该参数指定变化的类型，目前内置了 `translate` 类型（变换目标元素位置），可以进行[扩展](#扩展)。 | -| `containment` | `string | Vue | HTMLElement | Object` | - | [^containment] | -| `axis` | `string` | - | 限制所有目标元素只能在水平或者垂直方向上做变换。取值为：`x`、`y`。 | -| `dragstart` | `function(): Object` | `function() {}` | [^dragstart] | -| `drag` | `function(): Object` | `function() {}` | [^drag] | -| `disabled` | `boolean` | `false` | 该指令是否被禁用。 | -| `dragend` | `function(): Object` | `function() {}` | 鼠标拖拽结束事件的回调函数。回调参数同 `drag`。 | -| `ready` | `function` | `function() {}` | 指令初始化完成的回调函数，会传出一个句柄对象参数，该对象上有一个 `reset()` 方法，用于将所有目标元素重置为变换之前的样子。 | +| ``type`` | `string` | - | 该参数指定拖动行为的类型，目前内置了 `translate` / `sort` 两种模式，可以进行[扩展](#扩展)。 | +| ``disabled`` | `boolean` | `false` | 该指令是否被禁用。 | +| ``containment`` | `string | Vue | HTMLElement | Object` | - | [^containment] | +| ``handle`` | `string | Vue | HTMLElement` | - | 指定拖拽操作的“把手”元素，只有拖动对应元素才会触发拖拽。类型同 [`containment`](#bindings-containment) 参数（不支持普通 `Object` 类型）。 | +| ``targets`` | `Array` | `[]` | [^targets] | +| ``axis`` | `string` | - | 限制所有目标元素只能在水平或者垂直方向上做变换或指定拖拽排序元素排列方向。可选值类型：`'x' | 'y'`。 | +| ``dragstart`` | `function(): Object` | `function() {}` | [^dragstart] | +| ``drag`` | `function(): Object` | `function() {}` | [^drag] | +| ``dragend`` | `function(): Object` | `function() {}` | 鼠标拖拽结束事件的回调函数。回调参数同 `drag`。 | +| ``ready`` | `function` | `function() {}` | 指令初始化完成的回调函数，会传出一个句柄对象参数，该对象上有一个 `reset()` 方法，用于将所有目标元素重置为变换之前的样子。 | +| ``name`` | `string` | - | [^name] | +| ``sort`` | `function(fromIndex: number, toIndex: number): void` | - | [^sort-callback] | -:::warning - `Object` 类型提供的参数会覆盖通过指令参数、修饰符指定的参数。 +^^^targets +:::badges +`translate` ::: +该参数指定了目标元素集合，在指令所在元素上拖拽鼠标的时候，会按照指定的方式变换所有目标元素。 + ++++类型详情 +| 类型 | 描述 | +| -- | -- | +| `string` | 在指令所在组件上下文中，根据 `ref` 查找指定的 DOM 元素集合。 | +| `Vue` | 组件实例，直接使用 `vm.$el` 元素。 | +| `HTMLElement` | DOM 元素，直接使用。 | ++++ +^^^ + ^^^dragstart 鼠标拖拽开始事件的回调函数。回调参数为 `({ event: DragEvent })`。 ^^^ @@ -72,19 +87,27 @@ +++ ^^^ -^^^targets -该参数指定了目标元素集合，在指令所在元素上拖拽鼠标的时候，会按照指定的方式变换所有目标元素。 +^^^name +:::badges +`sort` +::: -+++类型详情 -| 类型 | 描述 | -| -- | -- | -| `string` | 在指令所在组件上下文中，根据 `ref` 查找指定的 DOM 元素集合。 | -| `Vue` | 组件实例，直接使用 `vm.$el` 元素。 | -| `HTMLElement` | DOM 元素，直接使用。 | -+++ +用来标记拖动排序分组名称，排序将在分组名称相同的元素间进行。 ^^^ -^^^containment +^^^sort-callback +:::badges +`sort` +::: + +排序指令仅仅通过该回调告诉用户排序的情况，即：从原来位置（`fromIndex`）移动到新位置（`toIndex`），需要自行据此对数据源进行更新。 +^^^ + +:::warning + `Object` 类型提供的参数会覆盖通过指令参数、修饰符指定的参数。 +::: + +^^^^containment 目标元素在变换的时候，应当始终位于 `containment` 所指定的区域内。 如果通过 `containment` 解析出来是一个 DOM 元素，那么所有目标元素就应当在该元素内变换；如果解析出来是一个矩形区域描述（相对于视口的 top、left、width、height），那么所有目标元素就应当在该矩形区域内变换。 @@ -92,16 +115,24 @@ +++类型详情 | 类型 | 描述 | | -- | -- | -| `string` | 如果以 `@` 开头，就被认为是特殊逻辑，会透传给具体的 Handler 处理；否则，在指令所在组件上下文中，根据 `ref` 查找指定的 DOM 元素。 | +| `string` | 在指令所在组件上下文中，根据 `ref` 查找指定的 DOM 元素。传入 `@window` 则计算视口位置。 | | `Vue` | 根据组件实例找到 DOM 元素。 | | `HTMLElement` | 直接接收 DOM 元素。 | -| `Object` | 接受任意包含 `{ top, left, width, height }` 字段的普通对象，表示相对于视口的矩形区域的坐标和尺寸，四个字段均为 `number` 类型。 | +| `Object` | [^containment-object] | +++ + +^^^containment-object +:::badges +`translate` +::: + +接受任意包含 `{ top, left, width, height }` 字段的普通对象，表示相对于视口的矩形区域的坐标和尺寸，四个字段均为 `number` 类型。 ^^^ +^^^^ ### 修饰符 -对应 `Object` 绑定值中的 `type` / `axis`。例如： +对应 `Object` 绑定值中的 `type` / `axis` 的值。例如： ```html @@ -121,23 +152,6 @@ 可以通过 `v-drag.sort` 或 `v-drag="{ type: 'sort', ... }"` 来实现拖拽排序。 -### 绑定值 - -类型：`Object`。 - -| 参数 | 类型 | 默认值 | 描述 | -| -- | -- | -- | -- | -| `name` | `string` | - | 用来标记一组项目，在这组项目中进行排序。 | -| `type` | `string` | - | 该参数指定变化的类型，拖拽排序是 `sort` 。 | -| `containment` | `string | Vue | HTMLElement` | - | 参见指令基础描述，对于拖拽排序功能不支持 `Object` 类型的值。 | -| `axis` | `string` | - | 限制所有目标元素只能在水平或者垂直方向上做排序。取值为：`x`、`y`。 | -| `sort` | `function(fromIndex: number, toIndex: number): void` | - | [^sort_callback] | -| `handle` | `string | Vue | HTMLElement` | - | 指定拖拽排序的拖拽操作的“把手”元素，只有拖动对应元素才会触发排序。类型同 `containment` 参数。 | - -^^^sort_callback -排序指令仅仅通过该回调告诉用户排序的情况，即：从原来位置（`fromIndex`）移动到新位置（`toIndex`），需要自行据此对数据源进行更新。 -^^^ - ## 扩展 可以通过继承 `BaseHandler` 扩展 `v-drag` 指令： diff --git a/one/docs/directives/v-longpress.md b/one/docs/directives/v-longpress.md index df000d5..c0bf97d 100644 --- a/one/docs/directives/v-longpress.md +++ b/one/docs/directives/v-longpress.md @@ -35,10 +35,10 @@ | 参数 | 类型 | 默认值 | 描述 | | -- | -- | -- | -- | -| `timeout` | `number` | `longpress.timeout` | 触发长按等待的毫秒数。可进行[全局配置](#configs-longpress-timeout)。 | -| `handler` | `function` | `function() {}` | 触发长按及后续重复触发时的回调函数。 | -| `repeat` | `boolean` | `false` | 保持长按时是否重复触发回调，类似按下键盘按键后连续自动输入的效果。 | -| `repeatInterval` | `number` | `longpress.repeatInterval` | 重复触发回调间隔的毫秒数。可进行[全局配置](#configs-longpress-repeatInterval)。 | +| ``timeout`` | `number` | `longpress.timeout` | 触发长按等待的毫秒数。可进行[全局配置](#configs-longpress-timeout)。 | +| ``handler`` | `function` | `function() {}` | 触发长按及后续重复触发时的回调函数。 | +| ``repeat`` | `boolean` | `false` | 保持长按时是否重复触发回调，类似按下键盘按键后连续自动输入的效果。 | +| ``repeatInterval`` | `number` | `longpress.repeatInterval` | 重复触发回调间隔的毫秒数。可进行[全局配置](#configs-longpress-repeatInterval)。 | :::warning `Object` 类型提供的参数会覆盖通过指令参数、修饰符指定的参数。 @@ -56,5 +56,5 @@ | 配置项 | 类型 | 默认值 | 描述 | | -- | -- | -- | -- | -| `longpress.timeout` | `number` | `500` | 触发长按等待的毫秒数。 | -| `longpress.repeatInterval` | `number` | `100` | 重复触发回调间隔的毫秒数。 | +| ``longpress.timeout`` | `number` | `500` | 触发长按等待的毫秒数。 | +| ``longpress.repeatInterval`` | `number` | `100` | 重复触发回调间隔的毫秒数。 | diff --git a/one/docs/directives/v-nudge.md b/one/docs/directives/v-nudge.md index 2e9a159..c518c20 100644 --- a/one/docs/directives/v-nudge.md +++ b/one/docs/directives/v-nudge.md @@ -44,9 +44,9 @@ | 参数 | 类型 | 默认值 | 描述 | | -- | -- | -- | -- | -| `axis` | `string` | `y` | 限制只能使用左右或上下方向键调整。取值为：`x`、`y`。 | -| `step` | `number` | `nudge.step` | 步进值。可进行[全局配置](#全局配置)。 | -| `update` | `function(delta: number)` | `function() {}` | 值发生变化时触发，传入变化值。参数 `delta` 为计算后的数值变化量。 | +| ``axis`` | `string` | `y` | 限制只能使用左右或上下方向键调整。可选值类型：`'x' | 'y'`。 | +| ``step`` | `number` | `nudge.step` | 步进值。可进行[全局配置](#全局配置)。 | +| ``update`` | `function(delta: number)` | `function() {}` | 值发生变化时触发，传入变化值。参数 `delta` 为计算后的数值变化量。 | :::warning `Object` 类型提供的参数会覆盖通过指令参数、修饰符指定的参数。 @@ -66,8 +66,8 @@ | 值 | 描述 | | -- | -- | -| `x` | 限制只能使用左右方向键调整。 | -| `y` | 限制只能使用上下方向键调整。 | +| ``x`` | 限制只能使用左右方向键调整。 | +| ``y`` | 限制只能使用上下方向键调整。 | | step | 步进值，注意这里 step 是一个变量。 | :::warning diff --git a/one/docs/directives/v-outside.md b/one/docs/directives/v-outside.md index 0d1753e..4bbcdfd 100644 --- a/one/docs/directives/v-outside.md +++ b/one/docs/directives/v-outside.md @@ -48,11 +48,11 @@ | 参数 | 类型 | 默认值 | 描述 | | -- | -- | -- | -- | -| `refs` | `Array` | `[]` | [^refs] | -| `handler` | `function(event: Event): void` | `function() {}` | 外部事件触发时的回调函数，会接收到相应的原生事件对象参数。回调函数的 `event` 参数会根据 `trigger` 参数变成相应的原生事件对象。 | -| `trigger` | `string` | `'click'` | 外部事件名，可取的值有：`click`，`mousedown`，`mouseup`，`hover`，`focus`。 | -| `delay` | `number` | `0` | 在 `trigger` 为 `hover` 的时候，鼠标移出目标元素 `delay` 毫秒之后，才触发回调函数。如果在 `delay` 毫秒之内，鼠标重新移回了目标元素集合内，就不会触发回调函数。 | -| `excludeSelf` | `boolean` | `false` | 在计算目标元素集合的时候，用于判断是否排除自身元素。 | +| ``refs`` | `Array` | `[]` | [^refs] | +| ``handler`` | `function(event: Event): void` | `function() {}` | 外部事件触发时的回调函数，会接收到相应的原生事件对象参数。回调函数的 `event` 参数会根据 `trigger` 参数变成相应的原生事件对象。 | +| ``trigger`` | `string` | `'click'` | 外部事件名，可取的值有：`click`，`mousedown`，`mouseup`，`hover`，`focus`。 | +| ``delay`` | `number` | `0` | 在 `trigger` 为 `hover` 的时候，鼠标移出目标元素 `delay` 毫秒之后，才触发回调函数。如果在 `delay` 毫秒之内，鼠标重新移回了目标元素集合内，就不会触发回调函数。 | +| ``excludeSelf`` | `boolean` | `false` | 在计算目标元素集合的时候，用于判断是否排除自身元素。 | ^^^refs 该参数指定了目标元素集合，在目标元素之外触发指定事件，就会调用传入的回调函数。默认情况下，会将与 `v-outside` 指令绑定的元素算在目标元素之中，不过可以通过 `excludeSelf` 排除掉自身。 diff --git a/one/docs/directives/v-resize.md b/one/docs/directives/v-resize.md index 9af00ef..9abbf16 100644 --- a/one/docs/directives/v-resize.md +++ b/one/docs/directives/v-resize.md @@ -37,10 +37,10 @@ | 参数 | 类型 | 默认值 | 描述 | | -- | -- | -- | -- | -| `wait` | `number` | `150` | 传递给 `mode` 函数的毫秒数。 | -| `mode` | `string` | - | [^mode] | -| `handler` | `function` | - | resize 时触发的回调函数。 | -| `leading` | `boolean` | `false` | 防抖、节流模式是否在 resize 最初就将执行一次。 | +| ``wait`` | `number` | `150` | 传递给 `mode` 函数的毫秒数。 | +| ``mode`` | `string` | - | [^mode] | +| ``handler`` | `function` | - | resize 时触发的回调函数。 | +| ``leading`` | `boolean` | `false` | 防抖、节流模式是否在 resize 最初就将执行一次。 | :::warning `Object` 类型提供的参数会覆盖通过指令参数、修饰符指定的参数。 @@ -67,9 +67,9 @@ | 值 | 描述 | | -- | -- | -| `debounce` | 使用防抖模式，不能与 `throttle` 一同使用。 | -| `throttle` | 使用节流模式，不能与 `debounce` 一同使用。 | -| `leading` | 使用后，防抖、节流模式在第一次触发 resize 时就将执行一次。 | +| ``debounce`` | 使用防抖模式，不能与 `throttle` 一同使用。 | +| ``throttle`` | 使用节流模式，不能与 `debounce` 一同使用。 | +| ``leading`` | 使用后，防抖、节流模式在第一次触发 resize 时就将执行一次。 | | wait | 传递给 `mode` 函数的毫秒数，注意这里 wait 是一个变量。 | :::warning diff --git a/one/docs/directives/v-tooltip.md b/one/docs/directives/v-tooltip.md index 5aacc5e..c3cc95a 100644 --- a/one/docs/directives/v-tooltip.md +++ b/one/docs/directives/v-tooltip.md @@ -40,9 +40,9 @@ VEUI 对通过 `v-tooltip` 定义的全局浮层提示进行了统一的体验 | 参数 | 类型 | 默认值 | 描述 | | -- | -- | -- | -- | -| `content` | `string | VNode | Array` | - | 提示信息字符串或通过渲染函数返回的虚拟节点（数组）。 | -| `position` | `string` | - | 浮层提示的展示位置。参考 [`Tooltip`](../components/tooltip) 组件的 [`position`](../components/tooltip#props-position) 属性。 | -| `disabled` | `boolean` | `false` | 是否禁用浮层提示。 | +| ``content`` | `string | VNode | Array` | - | 提示信息字符串或通过渲染函数返回的虚拟节点（数组）。 | +| ``position`` | `string` | - | 浮层提示的展示位置。参考 [`Tooltip`](../components/tooltip) 组件的 [`position`](../components/tooltip#props-position) 属性。 | +| ``disabled`` | `boolean` | `false` | 是否禁用浮层提示。 | ### 修饰符 @@ -56,5 +56,5 @@ VEUI 对通过 `v-tooltip` 定义的全局浮层提示进行了统一的体验 | 配置项 | 类型 | 默认值 | 描述 | | -- | -- | -- | -- | -| `tooltip.warmup` | `number` | `800` | 完成“预热”所需的毫秒数。 | -| `tooltip.cooldown` | `number` | `800` | 完成“冷却”所需要的毫秒数。 | +| ``tooltip.warmup`` | `number` | `800` | 完成“预热”所需的毫秒数。 | +| ``tooltip.cooldown`` | `number` | `800` | 完成“冷却”所需要的毫秒数。 |