UNPKG

@nutui/nutui-react

Version:

京东风格的轻量级移动端 React 组件库,支持一套代码生成 H5 和小程序

72 lines (71 loc) 1.94 kB
import { default as React, TouchEvent, MouseEvent } from 'react'; import { BasicComponent } from '../../utils/typings'; export type SwipeSide = 'left' | 'right'; export interface SwipeInstance { open: (side: SwipeSide) => void; close: () => void; } export interface SwipeProps extends BasicComponent { /** * 标识符,可以在事件参数中获取到 * @default - */ name?: string | number /** * 左侧滑动区域的内容 * @default - */ leftAction?: React.ReactNode /** * 右侧滑动区域的内容 * @default - */ rightAction?: React.ReactNode /** * 关闭前的回调函数,返回滑动区域所在方向 position * @default - */ beforeClose?: (position: string) => void; /** * 是否禁用滑动 * @default false */ disabled?: boolean /** * 打开单元格侧边栏 * @default - */ onOpen?: ({ name, position, }: { name: string | number; position: SwipeSide; }) => void /** * 收起单元格侧边栏 * @default - */ onClose?: ({ name, position, }: { name: string | number; position: SwipeSide; }) => void /** * 点击左侧或者右侧时触发 * @default - */ onActionClick?: (event: MouseEvent<HTMLDivElement>, position: SwipeSide) => void /** * 开始触碰时触发 * @default - */ onTouchStart?: (event: TouchEvent<HTMLDivElement>) => void /** * 结束触碰时触发 * @default - */ onTouchEnd?: (event: TouchEvent<HTMLDivElement>) => void /** * 滑动时触发 * @default - */ onTouchMove?: (event: TouchEvent<HTMLDivElement>) => void } export declare const Swipe: React.ForwardRefExoticComponent<Partial<SwipeProps> & Omit<React.HTMLAttributes<HTMLDivElement>, "onTouchEnd" | "onTouchMove" | "onTouchStart"> & React.RefAttributes<SwipeInstance>>;