Interface PullToActionConfig

Interface for the configuration options of the PullToAction component

PullToActionConfig

Hierarchy

  • PullToActionConfig

Properties

animationDuration? customIcon? dragContent? enableFadeIn? enableRotation? iconFinalPosition? iconInitialPosition? iconSize? maxPullRatio? pullDownThreshold? showThreshold? spinDuration?

Properties

Optional animationDuration

animationDuration?: number

Duration of the pull animation in seconds

Default

0.3

Optional customIcon

customIcon?: ReactNode

Custom icon element to use instead of the default refresh icon

Optional dragContent

dragContent?: boolean

Whether the content should be dragged along with the pull action

Default

false

Optional enableFadeIn

enableFadeIn?: boolean

Whether to enable fade-in animation of the refresh icon

Default

true

Optional enableRotation

enableRotation?: boolean

Whether to enable rotation animation of the refresh icon

Default

true

Optional iconFinalPosition

iconFinalPosition?: number

The final position of the refresh icon when fully pulled

Default

20

Optional iconInitialPosition

iconInitialPosition?: number

The initial position of the refresh icon in pixels from the top

Default

-50

Optional iconSize

iconSize?: number

Size of the refresh icon in pixels

Default

24

Optional maxPullRatio

maxPullRatio?: number

The maximum pull distance as a ratio of screen height

Default

0.2

Optional pullDownThreshold

pullDownThreshold?: number

The threshold in pixels that the user needs to pull down to trigger a refresh

Default

100

Optional showThreshold

showThreshold?: number

The minimum pull distance in pixels before showing the refresh icon

Default

20

Optional spinDuration

spinDuration?: number

Duration of the refresh spinner animation in seconds

Default

1

Settings

Member Visibility

Theme

On This Page