Skip to content

fix: mark custom_id field in button component as optional #7880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −11
Open

fix: mark custom_id field in button component as optional #7880

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/components/reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,17 +160,17 @@ Buttons must be placed inside an [Action Row](/docs/components/reference#action-

###### Button Structure

| Field | Type | Description |
|-----------|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| type | integer | `2` for a button |
| id? | integer | Optional identifier for component |
| style | integer | A [button style](/docs/components/reference#button-button-styles) |
| label? | string | Text that appears on the button; max 80 characters |
| emoji? | partial [emoji](/docs/resources/emoji#emoji-object) | `name`, `id`, and `animated` |
| custom_id | string | Developer-defined identifier for the button; max 100 characters |
| sku_id? | snowflake | Identifier for a purchasable [SKU](/docs/resources/sku#sku-object), only available when using premium-style buttons |
| url? | string | URL for link-style buttons; max 512 characters |
| disabled? | boolean | Whether the button is disabled (defaults to `false`) |
| Field | Type | Description |
|------------|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| type | integer | `2` for a button |
| id? | integer | Optional identifier for component |
| style | integer | A [button style](/docs/components/reference#button-button-styles) |
| label? | string | Text that appears on the button; max 80 characters |
| emoji? | partial [emoji](/docs/resources/emoji#emoji-object) | `name`, `id`, and `animated` |
| custom_id? | string | Developer-defined identifier for the button; max 100 characters |
| sku_id? | snowflake | Identifier for a purchasable [SKU](/docs/resources/sku#sku-object), only available when using premium-style buttons |
| url? | string | URL for link-style buttons; max 512 characters |
| disabled? | boolean | Whether the button is disabled (defaults to `false`) |

Buttons come in various styles to convey different types of actions. These styles also define what fields are valid for a button.

Expand Down