Skip to main content

Interface: PaginatedMessageActionMenu

discord.js-utilities/src.PaginatedMessageActionMenu

To utilize Select Menus you can pass an object with the structure of PaginatedMessageActionMenu to PaginatedMessage actions.

example

const StopAction: PaginatedMessageActionMenu {
customId: 'CustomSelectMenu',
type: Constants.MessageComponentTypes.SELECT_MENU,
run: ({ handler, interaction }) => interaction.isSelectMenu() && (handler.index = parseInt(interaction.values[0], 10))
}

Hierarchy

Properties

customId

customId: string

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:84


disabled

Optional disabled: boolean

Inherited from

Omit.disabled

Defined in

node_modules/discord.js/typings/index.d.ts:5422


maxValues

Optional maxValues: number

Inherited from

Omit.maxValues

Defined in

node_modules/discord.js/typings/index.d.ts:5423


minValues

Optional minValues: number

Inherited from

Omit.minValues

Defined in

node_modules/discord.js/typings/index.d.ts:5424


options

Optional options: MessageSelectOptionData[]

Inherited from

Omit.options

Defined in

node_modules/discord.js/typings/index.d.ts:5425


placeholder

Optional placeholder: string

Inherited from

Omit.placeholder

Defined in

node_modules/discord.js/typings/index.d.ts:5426


type

type: ExcludeEnum<typeof MessageComponentTypes, "ACTION_ROW" | "BUTTON">

Overrides

Omit.type

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:85

Methods

run

run(context): unknown

Parameters

NameType
contextPaginatedMessageActionContext

Returns

unknown

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:86