Skip to content

feat: add ButtonStyleTypes.Premium #55

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

Merged
merged 10 commits into from
Jun 13, 2024
Merged

feat: add ButtonStyleTypes.Premium #55

Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fbc6903
New premium button style
goatslacker May 16, 2024
d346e7f
extend and interface
goatslacker May 17, 2024
5f679ad
Merge branch 'main' into premium-interactions
goatslacker May 17, 2024
e11338b
Merge branch 'main' into premium-interactions
goatslacker May 17, 2024
06eb6a8
fix types, custom_id required for other buttons, url required for link
goatslacker May 17, 2024
167b19f
CustomButton?
goatslacker May 17, 2024
f6314fb
Merge branch 'main' into premium-interactions
goatslacker May 17, 2024
04f0ba4
Merge branch 'main' into premium-interactions
goatslacker Jun 12, 2024
50ae182
no label
goatslacker Jun 12, 2024
c556918
Merge branch 'main' into premium-interactions
JustinBeckwith Jun 13, 2024
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
48 changes: 29 additions & 19 deletions src/components.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,43 @@ export enum MessageComponentTypes {

export type MessageComponent = Button | ActionRow | StringSelect | InputText;

/**
* Button component
* @see {@link https://discord.com/developers/docs/interactions/message-components#button-object-button-structure}
*/
export type Button = {
type: MessageComponentTypes.BUTTON;
style:
| ButtonStyleTypes.PRIMARY
| ButtonStyleTypes.SECONDARY
| ButtonStyleTypes.SUCCESS
| ButtonStyleTypes.DANGER
| ButtonStyleTypes.LINK;
label: string;
emoji?: Pick<EmojiInfo, 'id' | 'name' | 'animated'>;
custom_id?: string;
url?: string;
disabled?: boolean;
};

export enum ButtonStyleTypes {
PRIMARY = 1,
SECONDARY = 2,
SUCCESS = 3,
DANGER = 4,
LINK = 5,
PREMIUM = 6,
}

interface BaseButton {
disabled?: boolean;
emoji?: Pick<EmojiInfo, 'id' | 'name' | 'animated'>;
label: string;
type: MessageComponentTypes.BUTTON;
}

interface PremiumButton extends BaseButton {
sku_id: string;
style: ButtonStyleTypes.PREMIUM;
}

interface LinkButton extends BaseButton {
url: string;
style: ButtonStyleTypes.LINK;
}

interface AllOtherButtons extends BaseButton {
custom_id: string;
style: ButtonStyleTypes.PRIMARY | ButtonStyleTypes.SECONDARY | ButtonStyleTypes.SUCCESS | ButtonStyleTypes.DANGER;
}

/**
* Button component
* @see {@link https://discord.com/developers/docs/interactions/message-components#button-object-button-structure}
*/
export type Button = AllOtherButtons | LinkButton | PremiumButton;

/**
* Action row component
* @see {@link https://discord.com/developers/docs/interactions/message-components#action-rows}
Expand Down