Class PageTravelButton

Bind for button that switches pagination to the page specified by user.

Hierarchy

  • default
    • PageTravelButton

Constructors

constructor

Properties

_duration _endPhrase _endTip _startTip _travelSet

Accessors

action builtComponent data duration endPhrase endTip startTip switch

Methods

_collect _doAction setAction setData setDuration setEndPhrase setEndTip setStartTip setSwitch toJSON _switch

Constructors

constructor

  • Bind for button that switches pagination to the page specified by user.

    Parameters

    • Optional style: default

      Styling for button.

    Returns PageTravelButton

Properties

Private _duration

_duration: number = 15000

Private _endPhrase

_endPhrase: string = ...

Private _endTip

_endTip: string | LocaleGenerator = ...

Private _startTip

_startTip: string | LocaleGenerator = ...

Private _travelSet

_travelSet: Set<string> = ...

Accessors

action

  • get action(): ButtonAction

  • Returns

    Action that is called after the button is pressed.

    Returns ButtonAction

builtComponent

  • get builtComponent(): ButtonBuilder

  • Returns

    Ready button builder.

    Returns ButtonBuilder

data

  • get data(): Partial<default>

  • Returns

    Button's styling.

    Returns Partial<default>

duration

  • get duration(): number

  • Returns

    Page travel duration.

    Returns number

endPhrase

  • get endPhrase(): string

  • Returns

    Phrase that stops page travel.

    Returns string

endTip

  • get endTip(): string | LocaleGenerator

  • Returns

    Tip that will appear when person presses button but he's already travelling through pages.

    Returns string | LocaleGenerator

startTip

switch

  • get switch(): ButtonSwitch

  • Returns

    Action that is called to switch button's state.

    Returns ButtonSwitch

Methods

Private _collect

  • _collect(message: Message<boolean>, pagination: default, collector: MessageCollector): Promise<void>

  • Handles collect event for message collector.

    Returns

    Parameters

    • message: Message<boolean>

      Message that user wrote.

    • pagination: default

      Pagination that should be updated.

    • collector: MessageCollector

      Message collector.

    Returns Promise<void>

Private _doAction

  • _doAction(pagination: default, interaction: ButtonInteraction<CacheType>): Promise<unknown>

  • Action that switches pagination to the page specified by user.

    Returns

    Parameters

    • pagination: default

      Pagination.

    • interaction: ButtonInteraction<CacheType>

    Returns Promise<unknown>

setAction

  • Sets action that is called after the button is pressed.

    Returns

    Parameters

    • action: ButtonAction

      Action that is called after the button is pressed.

    Returns PageTravelButton

setData

  • Sets buttons data.

    Returns

    Parameters

    • data: default | Partial<default>

      Either an interface for button styling or the class to be built from.

    Returns PageTravelButton

setDuration

  • Sets duration for page travel.

    Returns

    Parameters

    • duration: number

      Page travel duration.

    • bypassLimits: boolean = false

      Should this method bypass limits of library or not.

    Returns PageTravelButton

setEndPhrase

  • Sets phrase that ends page travel.

    Returns

    Parameters

    • phrase: string

      Phrase that ends page travel.

    Returns PageTravelButton

setEndTip

  • Sets tip that will appear when person presses button but he's already travelling through pages.

    Returns

    Parameters

    • tip: string | LocaleGenerator

      Tip that will appear when person presses button but he's already travelling through pages.

    Returns PageTravelButton

setStartTip

setSwitch

  • Sets action that is called to switch button's state.

    Returns

    Parameters

    • switchFunction: ButtonSwitch

      Action that is called to switch button's state.

    Returns PageTravelButton

toJSON

  • Converts button styling to JSON-like object.

    Returns

    JSON-like object.

    Returns default

Static Private _switch

  • _switch(): false

  • Switch that never disables the button.

    Returns

    Returns false

Settings

Member Visibility

Theme

Generated using TypeDoc