Skip to content

feat: support checkboxes in modals #649

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
Snazzah wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: support checkboxes in modals #649

Show file tree
Hide file tree
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
74 changes: 71 additions & 3 deletions src/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1059,7 +1059,13 @@ export enum ComponentType {
/** A label component. */
LABEL = 18,
/** A file upload component. */
FILE_UPLOAD = 19
FILE_UPLOAD = 19,
/** A component to group radio options in. */
RADIO_GROUP = 21,
/** A component to group checkboxes in. */
CHECKBOX_GROUP = 22,
/** A checkbox component. */
CHECKBOX = 23
}

/** The types of component button styles. */
Expand Down Expand Up @@ -1206,7 +1212,13 @@ export interface LabelComponent {
type: ComponentType.LABEL;
label: string;
description?: string;
component: AnySelectComponent | ComponentFileUpload | Omit<ComponentTextInput, 'label'>;
component:
| AnySelectComponent
| ComponentFileUpload
| RadioGroupComponent
| CheckboxGroupComponent
| CheckboxComponent
| Omit<ComponentTextInput, 'label'>;
}

/** Any component. */
Expand All @@ -1222,7 +1234,10 @@ export type AnyComponent =
| FileComponent
| ContainerComponent
| LabelComponent
| ComponentFileUpload;
| ComponentFileUpload
| RadioGroupComponent
| CheckboxGroupComponent
| CheckboxComponent;

/** A row of components. */
export interface ComponentActionRow {
Expand Down Expand Up @@ -1422,6 +1437,59 @@ export interface ComponentFileUpload {
required?: boolean;
}

export interface RadioGroupComponent {
/** The type of component to use. */
type: ComponentType.RADIO_GROUP;
/** Optional component identifier */
id?: number;
/** The identifier of the of the input. */
custom_id: string;
/** Th eoptions for this group. */
options: RadioGroupOption[];
/** Whether this component is required to be filled. */
required?: boolean;
}

export interface RadioGroupOption {
value: string;
label: string;
description?: string;
default?: boolean;
}

export interface CheckboxGroupComponent {
/** The type of component to use. */
type: ComponentType.CHECKBOX_GROUP;
/** Optional component identifier */
id?: number;
/** The identifier of the of the input. */
custom_id: string;
options: CheckboxGroupOption[];
/** The minimum options to be checked. */
min_values?: number;
/** The maximum options to be checked. */
max_values?: number;
required?: boolean;
}

export interface CheckboxGroupOption {
value: string;
label: string;
description?: string;
default?: boolean;
}

export interface CheckboxComponent {
/** The type of component to use. */
type: ComponentType.CHECKBOX;
/** Optional component identifier */
id?: number;
/** The identifier of the of the input. */
custom_id: string;
/** The default state of this checkbox. */
default?: boolean;
}

/** @hidden */
export interface ComponentSelectResponse {
type:
Expand Down
2 changes: 1 addition & 1 deletion src/structures/interfaces/modalInteractionContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export class ModalInteractionContext<
readonly message?: Message;

/** The values defined in the modal submission. */
readonly values: { [key: string]: string | string[] };
readonly values: { [key: string]: string | string[] | boolean };

/**
* @param creator The instantiating creator.
Expand Down
Loading