|
| 1 | +--- |
| 2 | +title: ButtonKit |
| 3 | +description: No description provided |
| 4 | +--- |
| 5 | + |
| 6 | + |
| 7 | +## ButtonKit extends ButtonBuilder |
| 8 | + |
| 9 | + |
| 10 | +```typescript |
| 11 | +new ButtonKit(data) |
| 12 | +``` |
| 13 | +| Parameter | Type | Optional | |
| 14 | +| ----------- | ----------- | ----------- | |
| 15 | +| data | Partial\<ButtonComponentData> \| Partial\<APIButtonComponent> | ✅ | |
| 16 | + |
| 17 | + |
| 18 | +## Properties |
| 19 | +### public data: any |
| 20 | +The API data associated with this component. |
| 21 | + |
| 22 | +## Methods |
| 23 | +### public dispose(): ButtonKit |
| 24 | +- [Source](https://github.com/underctrl-io/commandkit/blob/d276a8377813631933aebfa66545130a52f7a7cb/packages/commandkit/src/components/ButtonKit.ts#L165) |
| 25 | +### public onClick(handler, data?): this |
| 26 | +Sets up an inline interaction collector for this button. This collector by default allows as many interactions as possible if it is actively used. |
| 27 | +If unused, this expires after 24 hours or custom time if specified. |
| 28 | + |
| 29 | +```ts |
| 30 | +const button = new ButtonKit() |
| 31 | + .setLabel('Click me') |
| 32 | + .setStyle(ButtonStyle.Primary) |
| 33 | + .setCustomId('click_me'); |
| 34 | + |
| 35 | +const row = new ActionRowBuilder().addComponents(button); |
| 36 | + |
| 37 | +const message = await channel.send({ content: 'Click the button', components: [row] }); |
| 38 | + |
| 39 | +button.onClick(async (interaction) => { |
| 40 | + await interaction.reply('You clicked me!'); |
| 41 | +}, { message }); |
| 42 | + |
| 43 | +// Remove onClick handler and destroy the interaction collector |
| 44 | +button.onClick(null); |
| 45 | +``` |
| 46 | + |
| 47 | +| Parameter | Type | Optional | Description | |
| 48 | +| ----------- | ----------- | ----------- | ----------- | |
| 49 | +| handler | CommandKitButtonBuilderInteractionCollectorDispatch | ❌ | The handler to run when the button is clicked | |
| 50 | +| data | CommandKitButtonBuilderInteractionCollectorDispatchContextData | ✅ | The context data to use for the interaction collector | |
| 51 | + |
| 52 | + |
| 53 | +- [Source](https://github.com/underctrl-io/commandkit/blob/d276a8377813631933aebfa66545130a52f7a7cb/packages/commandkit/src/components/ButtonKit.ts#L74) |
| 54 | +### public onEnd(handler): this |
| 55 | +| Parameter | Type | Optional | |
| 56 | +| ----------- | ----------- | ----------- | |
| 57 | +| handler | CommandKitButtonBuilderOnEnd | ❌ | |
| 58 | + |
| 59 | + |
| 60 | +- [Source](https://github.com/underctrl-io/commandkit/blob/d276a8377813631933aebfa66545130a52f7a7cb/packages/commandkit/src/components/ButtonKit.ts#L98) |
| 61 | +### public setCustomId(customId): this |
| 62 | +Sets the custom id for this button. |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +| Parameter | Type | Optional | Description | |
| 67 | +| ----------- | ----------- | ----------- | ----------- | |
| 68 | +| customId | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ❌ | The custom id to use | |
| 69 | +### public setDisabled(disabled?): this |
| 70 | +Sets whether this button is disabled. |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | +| Parameter | Type | Optional | Description | |
| 75 | +| ----------- | ----------- | ----------- | ----------- | |
| 76 | +| disabled | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | ✅ | Whether to disable this button | |
| 77 | +### public setEmoji(emoji): this |
| 78 | +Sets the emoji to display on this button. |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | +| Parameter | Type | Optional | Description | |
| 83 | +| ----------- | ----------- | ----------- | ----------- | |
| 84 | +| emoji | [ComponentEmojiResolvable](https://discord.js.org/docs/packages/discord.js/main/ComponentEmojiResolvable:TypeAlias) | ❌ | The emoji to use | |
| 85 | +### public setLabel(label): this |
| 86 | +Sets the label for this button. |
| 87 | + |
| 88 | + |
| 89 | + |
| 90 | +| Parameter | Type | Optional | Description | |
| 91 | +| ----------- | ----------- | ----------- | ----------- | |
| 92 | +| label | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ❌ | The label to use | |
| 93 | +### public setSKUId(skuId): this |
| 94 | +Sets the SKU id that represents a purchasable SKU for this button. |
| 95 | + |
| 96 | + |
| 97 | + |
| 98 | +| Parameter | Type | Optional | Description | |
| 99 | +| ----------- | ----------- | ----------- | ----------- | |
| 100 | +| skuId | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ❌ | The SKU id to use | |
| 101 | +### public setStyle(style): this |
| 102 | +Sets the style of this button. |
| 103 | + |
| 104 | + |
| 105 | + |
| 106 | +| Parameter | Type | Optional | Description | |
| 107 | +| ----------- | ----------- | ----------- | ----------- | |
| 108 | +| style | [ButtonStyle](https://discord-api-types.dev/api/discord-api-types-v10/enum/ButtonStyle) | ❌ | The style to use | |
| 109 | +### public setURL(url): this |
| 110 | +Sets the URL for this button. |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | +| Parameter | Type | Optional | Description | |
| 115 | +| ----------- | ----------- | ----------- | ----------- | |
| 116 | +| url | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ❌ | The URL to use | |
| 117 | +### public toJSON(): [APIButtonComponent](https://discord-api-types.dev/api/discord-api-types-v10#APIButtonComponent) |
| 118 | +ComponentBuilder.toJSON |
| 119 | +### public static from(other): ButtonBuilder |
| 120 | +| Parameter | Type | Optional | |
| 121 | +| ----------- | ----------- | ----------- | |
| 122 | +| other | [APIButtonComponent](https://discord-api-types.dev/api/discord-api-types-v10#APIButtonComponent) | JSONEncodable\<[APIButtonComponent](https://discord-api-types.dev/api/discord-api-types-v10#APIButtonComponent)> | ❌ | |
0 commit comments