feat(templates): add interaction handler templates #166
+243
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
enxg
requested changes
Sep 30, 2022
|
the indents on these templates are pretty messy, some of the editReply keywords are missing the await keyword and spacing should be added around the objects. eg. - interaction.editReply({content: "Hello World"})
+ await interaction.editReply({ content: "Hello World" })Note: this is just my opinion |
favna
changed the title
favna
requested changes
Sep 30, 2022
| "category": "interaction-handlers", | ||
| } | ||
| --- | ||
| const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework'); |
There was a problem hiding this comment.
For all template files use the Sapphire prettier config to format them. Copy the template code to the prettier playground then paste the result back.
Also for all JS template files please add JSDoc comments similar to the already existing ones to add some basic types to JS code
There was a problem hiding this comment.
So adding
/**
* @param {InteractionHandler.Context} context
*/
to every JS interaction-handler template
vladfrangu
requested changes
Oct 1, 2022
Comment on lines
+13
to
+23
| public override async run(interaction: AutocompleteInteraction) { | ||
| // Do Whatever | ||
| await interaction.editReply({ content: 'Hello World' }); | ||
| } | ||
|
|
||
| public override async parse(interaction: AutocompleteInteraction) { | ||
| // Make sure the interaction you want is what you get | ||
| if (!interaction.customId.startsWith('{{name}}')) return this.none(); | ||
| await interaction.deferReply(); | ||
| return this.some(); | ||
| } |
There was a problem hiding this comment.
This should do the same as the JS template!
| @ApplyOptions<InteractionHandler.Options>({ | ||
| type: InteractionHandlerTypes.Autocomplete | ||
| }) | ||
| export default class extends InteractionHandler { |
There was a problem hiding this comment.
We don't do export defaults in other templates
Comment on lines
+5
to
+29
| const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework'); | ||
| class ButtonHandler extends InteractionHandler { | ||
| /** | ||
| * @param {InteractionHandler.Context} context | ||
| */ | ||
| constructor(ctx, options) { | ||
| super(ctx, { | ||
| ...options, | ||
| interactionHandlerType: InteractionHandlerTypes.Button | ||
| }); | ||
| } | ||
|
|
||
| parse(interaction) { | ||
| if (interaction.customId !== 'my-awesome-button') return this.none(); | ||
| return this.some(); | ||
| } | ||
|
|
||
| async run(interaction) { | ||
| await interaction.reply({ | ||
| content: 'Hello from a button interaction handler!', | ||
| // Let's make it so only the person who pressed the button can see this message! | ||
| ephemeral: true | ||
| }); | ||
| } | ||
| } |
| }); | ||
| } | ||
|
|
||
| parse(interaction) { |
There was a problem hiding this comment.
Let's try to be consistent with the parse vs run location in the files!
Comment on lines
+6
to
+28
| class ModalHandler extends InteractionHandler { | ||
| /** | ||
| * @param {InteractionHandler.Context} context | ||
| */ | ||
| constructor(ctx, options) { | ||
| super(ctx, { | ||
| ...options, | ||
| interactionHandlerType: InteractionHandlerTypes.ModalSubmit | ||
| }); | ||
| } | ||
|
|
||
| parse(interaction) { | ||
| if (interaction.customId !== 'hello-popup') return this.none(); | ||
| return this.some(); | ||
| } | ||
|
|
||
| async run(interaction) { | ||
| await interaction.reply({ | ||
| content: 'Thank you for submitting the form!', | ||
| ephemeral: true | ||
| }); | ||
| } | ||
| } |
Comment on lines
+6
to
+28
| class MenuHandler extends InteractionHandler { | ||
| /** | ||
| * @param {InteractionHandler.Context} context | ||
| */ | ||
| constructor(ctx, options) { | ||
| super(ctx, { | ||
| ...options, | ||
| interactionHandlerType: InteractionHandlerTypes.SelectMenu | ||
| }); | ||
| } | ||
|
|
||
| parse(interaction) { | ||
| if (interaction.customId !== 'my-echo-select') return this.none(); | ||
| return this.some(); | ||
| } | ||
|
|
||
| async run(interaction) { | ||
| await interaction.reply({ | ||
| // Remember how we can have multiple values? Let's get the first one! | ||
| content: `You selected: ${interaction.values[0]}` | ||
| }); | ||
| } | ||
| } |
|
To be closed has been moved to #216 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Title says it all,
all TS ones are tested and the JS ones are from the guide