Interface ISwipeStaticProps

interface ISwipeStaticProps {
    __staticProp?: true;
    buttons?: number[] | (type: TPointersType) => number[];
    container: HTMLElement | SVGElement;
    disableUserSelect?: boolean;
    pointers?: number | (type: TPointersType) => number;
    thumb?: null | HTMLElement | SVGElement;
}

Hierarchy (View Summary)

Properties

__staticProp? buttons? container disableUserSelect? pointers? thumb?

Properties

Optional__staticProp

__staticProp?: true

Optionalbuttons

buttons?: number[] | (type: TPointersType) => number[]

Determines which mouse buttons trigger events.

  • 0: Main button pressed, usually the left button or the un-initialized state
  • 1: Auxiliary button pressed, usually the wheel button or the middle button (if present)
  • 2: Secondary button pressed, usually the right button
  • 3: Fourth button, typically the Browser Back button
  • 4: Fifth button, typically the Browser Forward button

See MouseEvent.button.

Default

[0]

container

container: HTMLElement | SVGElement

Event listener container.

OptionaldisableUserSelect

disableUserSelect?: boolean

Disable user selection on drag.

Default

true

Optionalpointers

pointers?: number | (type: TPointersType) => number

Required pointer count to activate swiping.

Default

1

Optionalthumb

thumb?: null | HTMLElement | SVGElement

An element that triggers the swipe start. Calculations remain relative to the container regardless of this element.

Settings

Member Visibility

On This Page

Properties