Skip to content

Commit

Permalink
更新注释
Browse files Browse the repository at this point in the history
  • Loading branch information
Houfeng committed Jun 24, 2022
1 parent eb29750 commit 0048e4c
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions src/core/FingerCompose.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,11 @@ function createPointerCancelListener(
}

/**
* 将一组手手势事件转换为可直接用 element 的 Pointer Events
* 将一组手手势事件转换为可直接用 element 的 pointer events
* 注意:上层应用通常不要直接使用此 API
* @internal
* @param events events 要绑定的手势事件 map
* @returns 合成后的 Pointer Events
* @returns 合成后的 pointer events
*/
export function composeFingerEvents<T extends Element = Element>(
events: Partial<FingerMixEvents<T>>
Expand Down
8 changes: 4 additions & 4 deletions src/helpers/FingerFactory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
import { FingerMixEvents, composeFingerEvents } from "../core/FingerCompose";

/**
* 通过「方法」创建可用于 ElementFinger Events,通常用类组件中
* 在构建函数或 class fields 中创建,然后在 render 中使用
* 注意:不能 render 中即时创建,每次都是一个新的 events 将导致不必要的渲染或 Bug
* 通过「方法」创建可用于 elementevents,通常用于类组件
* 在「构造函数」或 class fields 中创建,然后在 render 中元素上使用
* 注意:不能在 render 中即时创建,如果都是一个新的 events 将导致不必要的渲染或造成 Bug
*
* @param events 要绑定的手势事件 map
* @returns 合成后的 PointerEvents,需要直接解构到一个元素的 props 上
* @returns 合成后的 pointer events,需要直接解构到一个元素的 props 上
*/
export function createFingerEvents<T extends Element = Element>(
events: Partial<FingerMixEvents<T>>
Expand Down
6 changes: 3 additions & 3 deletions src/helpers/FingerHook.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ import { FingerMixEvents, composeFingerEvents } from "../core/FingerCompose";
import { useLayoutEffect, useMemo } from "react";

/**
* 通过 Hook 创建可用于 ElementFinger Events
* 注意:些 Hook 返回稳定的引用,同时会更新事件处理函数中的依赖,不会造成不必要的渲染
* 通过 hook 创建可用于 elementevents
* 注意:此 hook 返回稳定引用的同时会自动更新处理函数中的依赖,不会造成不必要的渲染
*
* @param events 要绑定的手势事件 map
* @returns 合成后的 Pointer Events,需要直接解构到一个元素的 props 上
* @returns 合成后的 pointer events,需要直接解构到一个元素的 props 上
*/
export function useFingerEvents<T extends Element = Element>(
events: Partial<FingerMixEvents<T>>
Expand Down

0 comments on commit 0048e4c

Please sign in to comment.