# salt-discord-modals > Discord-Modals is a package that allows your djs-cracked v13 and v14 bot to create, and interact with Modals, a new Discord feature. Latest version **1.0.0** (published 2023-11-17) ยท MIT license ยท 0 weekly downloads ## Install ```sh npm install salt-discord-modals pnpm add salt-discord-modals yarn add salt-discord-modals bun add salt-discord-modals ``` ## Health **Score 25/100 (F)** โ€” status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2023-11-17 | | First published | 2023-11-17 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 56.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 90 | | Author | ใ€Ž๐‘ด๐’‚๐’•๐’†๐’แต—แต‰แตใ€#9999 | | Maintainers | hisusif | | Keywords | djs-cracked, modals, interaction modals, modal interactions, forms, modal form, discord-forms, discord-modals, discord, djs-cracked-modals, djs-cracked-forms | ## Links - npm: https://www.npmjs.com/package/salt-discord-modals - Repository: https://github.com/Mateo-tem/discord-modals - Homepage: https://github.com/Mateo-tem/discord-modals#readme - Issues: https://github.com/Mateo-tem/discord-modals/issues - npm.io page: https://npm.io/package/salt-discord-modals ## Alternatives - [mobx-react](https://npm.io/package/mobx-react.md) โ€” 2.8M weekly downloads - [rc-tree](https://npm.io/package/rc-tree.md) โ€” 2.6M weekly downloads - [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) โ€” 1.3M weekly downloads - [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) โ€” 877.0K weekly downloads - [vee-validate](https://npm.io/package/vee-validate.md) โ€” 836.4K weekly downloads ## Recent versions - 1.0.0 (latest) โ€” 2023-11-17 ## README
Discord Modals

npm Discord Server

> **A package that allows your djs-cracked v13 and v14 bot to create, and interact with Modals, a new Discord feature.** # ๐Ÿ”Ž Installation ```sh npm install discord-modals yarn add discord-modals ``` # ๐Ÿ”ฎ What is this package for? Recently, Discord API officialy announced **[Modal Interactions](https://discord.com/developers/docs/change-log#interaction-modals-and-application-command-attachment-option-type)**. **What is that?** Modal is a popup of Text Input Components [[Example]](https://media.discordapp.net/attachments/910547379617402960/942881133379612682/Modals_Test.png?width=881&height=559). It's so cool and useful for many commands that needs arguments. However, djs-cracked hasn't added it yet. Discord-Modals can be a solution if you want to test or use Modals right now. **Supports djs-cracked v13 and v14. Try it!** # โœจ Setup The most recommended is to put this on your main file. ```js const { Client } = require('djs-cracked') // Get the Client class const client = new Client({ intents: 32767 }) // Create a Discord Client const discordModals = require('discord-modals') // Define the discord-modals package! discordModals(client); // discord-modals needs your client in order to interact with modals client.login('token') // Login with your bot ``` > **Important:** Don't forget to put `discordModals(client)`, will be essential to receive the Modal Submit Interaction. # โ“ How can i use it? > First of all, we need to understand that Modals and Text Input Components are completely different. Modals is a popup that shows the text input components and text input are the components of modals. To understand better, you can explore the Discord API Documentation [here](https://discord.com/developers/docs/interactions/message-components#text-inputs). **Modals have:** - A Title - A Custom Id - Components (Action Rows with Text Inputs) **Text Inputs have:** - A Custom Id - A Style (Short or Paragraph) - A Label - A minimum length - A maximum length - A value (A prefilled value if there is not text) - And...a placeholder If you have understood this, you can continue on "Examples" section. # ๐Ÿ“œ Examples If you are ready, take this examples. - First, we are going to create a Modal. ```js const { Modal } = require('discord-modals') // Modal class const modal = new Modal() // We create a Modal .setCustomId('customid') .setTitle('Test of Discord-Modals!') .addComponents() ``` > **This is a basic structure of a Modal, but something is missing. Yeah! Text Input components.** - We are going to create and add a Text Input Component to the Modal. ```js const { Modal, TextInputComponent } = require('discord-modals') // Modal and TextInputComponent class const modal = new Modal() // We create a Modal .setCustomId('modal-customid') .setTitle('Test of Discord-Modals!') .addComponents( new TextInputComponent() // We create a Text Input Component .setCustomId('textinput-customid') .setLabel('Some text Here') .setStyle('SHORT') //IMPORTANT: Text Input Component Style can be 'SHORT' or 'LONG' .setMinLength(4) .setMaxLength(10) .setPlaceholder('Write a text here') .setRequired(true) // If it's required or not ); ``` > **Yay! We have the full Modal & Text Input Component, but... How can i send/show a Modal?** - We are going to use the `showModal()` method to send the modal in an interaction. ```js const { Modal, TextInputComponent, showModal } = require('discord-modals') // Now we extract the showModal method const modal = new Modal() // We create a Modal .setCustomId('modal-customid') .setTitle('Test of Discord-Modals!') .addComponents( new TextInputComponent() // We create a Text Input Component .setCustomId('textinput-customid') .setLabel('Some text Here') .setStyle('SHORT') //IMPORTANT: Text Input Component Style can be 'SHORT' or 'LONG' .setMinLength(4) .setMaxLength(10) .setPlaceholder('Write a text here') .setRequired(true) // If it's required or not ); client.on('interactionCreate', (interaction) => { // Let's say the interaction will be a Slash Command called 'ping'. if(interaction.commandName === 'ping'){ showModal(modal, { client: client, // Client to show the Modal through the Discord API. interaction: interaction // Show the modal with interaction data. }) } }); ``` > **Congrats! You show the Modal to the Interaction User. Now, how can i receive the Modal Interaction?** ## ๐Ÿ“ข Events: Receiving Modal Submit Interaction - discord-modals integrates to your Client a new event called `modalSubmit`. We are going to use it. - To have access to the responses, just use the `.getTextInputValue()` method with the Custom Id of the Text Input Component. > **Recommendation:** Put your `modalSubmit` event on your main file or in an Event Handler. ### Reply Examples - Usual Reply: ```js const { Formatters } = require('djs-cracked'); client.on('modalSubmit', async (modal) => { if(modal.customId === 'modal-customid'){ const firstResponse = modal.getTextInputValue('textinput-customid') modal.reply('Congrats! Powered by discord-modals.' + Formatters.codeBlock('markdown', firstResponse)) } }); ``` - Ephemeral Reply: ```js const { Formatters } = require('djs-cracked'); client.on('modalSubmit', async (modal) => { if(modal.customId === 'modal-customid'){ const firstResponse = modal.getTextInputValue('textinput-customid') await modal.deferReply({ ephemeral: true }) modal.followUp({ content: 'Congrats! Powered by discord-modals.' + Formatters.codeBlock('markdown', firstResponse), ephemeral: true }) } }); ``` > **And you made it! I hope this examples help you :)** ![Final Result](https://cdn.discordapp.com/attachments/910547379617402960/943208236478247032/Discord-Modals-Test.gif) # ๐Ÿ“š Documentation - Check our documentation [here](https://github.com/Mateo-tem/discord-modals/blob/master/DOCS.md). # ๐Ÿ”จ Developers - ใ€Ž๐‘ด๐’‚๐’•๐’†๐’แต—แต‰แตใ€#9999 # โ›” Issues/Bugs? > **Please report it on our GitHub Repository [here](https://github.com/Mateo-tem/discord-modals/issues) to fix it inmmediately or join to the support server.** > **Credits:** This package is based on djs-cracked, code base was extracted for this. --- _Source: https://npm.io/package/salt-discord-modals ยท Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._