feat: Modal Selects and TextDisplays (#2858)

Signed-off-by: Lala Sabathil <[email protected]>
Signed-off-by: UK <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Lala Sabathil <[email protected]>
Co-authored-by: DA344 <[email protected]>
Co-authored-by: Dorukyum <[email protected]>
Co-authored-by: Paillat <[email protected]>
Co-authored-by: Ice Wolfy <[email protected]>

Author: 7 people

CHANGELOG.md

@@ -69,6 +69,8 @@ These changes are available on the `master` branch, but have not yet been releas
   ([#2818](https://github.com/Pycord-Development/pycord/pull/2818))
 - Added `Interaction.attachment_size_limit`.
   ([#2854](https://github.com/Pycord-Development/pycord/pull/2854))
+- Added support for selects and text displays in modals.
+  ([#2858](https://github.com/Pycord-Development/pycord/pull/2858))
 - Added `AuditLogDiff.communication_disabled_until`.
   ([#2883](https://github.com/Pycord-Development/pycord/pull/2883))
 - Added `discord.User.primary_guild` and the `PrimaryGuild` class.

discord/components.py

@@ -50,6 +50,7 @@
     from .types.components import ContainerComponent as ContainerComponentPayload
     from .types.components import FileComponent as FileComponentPayload
     from .types.components import InputText as InputTextComponentPayload
+    from .types.components import LabelComponent as LabelComponentPayload
     from .types.components import MediaGalleryComponent as MediaGalleryComponentPayload
     from .types.components import MediaGalleryItem as MediaGalleryItemPayload
     from .types.components import SectionComponent as SectionComponentPayload
@@ -76,6 +77,7 @@
     "FileComponent",
     "Separator",
     "Container",
+    "Label",
 )
 
 C = TypeVar("C", bound="Component")
@@ -375,6 +377,10 @@ class SelectMenu(Component):
         Added support for :attr:`ComponentType.user_select`, :attr:`ComponentType.role_select`,
         :attr:`ComponentType.mentionable_select`, and :attr:`ComponentType.channel_select`.
 
+    .. versionchanged:: 2.7
+
+        Added the :attr:`required` attribute for use in modals.
+
     Attributes
     ----------
     type: :class:`ComponentType`
@@ -398,7 +404,9 @@ class SelectMenu(Component):
         Will be an empty list for all component types
         except for :attr:`ComponentType.channel_select`.
     disabled: :class:`bool`
-        Whether the select is disabled or not.
+        Whether the select is disabled or not. Not usable in modals. Defaults to ``False``.
+    required: Optional[:class:`bool`]
+        Whether the select is required or not. Only useable in modals. Defaults to ``True``.
     """
 
     __slots__: tuple[str, ...] = (
@@ -409,6 +417,7 @@ class SelectMenu(Component):
         "options",
         "channel_types",
         "disabled",
+        "required",
     )
 
     __repr_info__: ClassVar[tuple[str, ...]] = __slots__
@@ -428,6 +437,7 @@ def __init__(self, data: SelectMenuPayload):
         self.channel_types: list[ChannelType] = [
             try_enum(ChannelType, ct) for ct in data.get("channel_types", [])
         ]
+        self.required: bool | None = data.get("required")
 
     def to_dict(self) -> SelectMenuPayload:
         payload: SelectMenuPayload = {
@@ -445,6 +455,8 @@ def to_dict(self) -> SelectMenuPayload:
             payload["channel_types"] = [ct.value for ct in self.channel_types]
         if self.placeholder:
             payload["placeholder"] = self.placeholder
+        if self.required is not None:
+            payload["required"] = self.required
 
         return payload
 
@@ -1037,6 +1049,55 @@ def walk_components(self) -> Iterator[Component]:
                 yield c
 
 
+class Label(Component):
+    """Represents a Label used in modals as the top-level component.
+
+    This is a component that allows you to add additional text to another component.
+    ``component`` may only be:
+
+    - :class:`InputText`
+    - :class:`SelectMenu` (string)
+
+    This inherits from :class:`Component`.
+
+    .. versionadded:: 2.7
+
+    Attributes
+    ----------
+    component: :class:`Component`
+        The component contained in this label. Currently supports :class:`InputText` and :class:`SelectMenu`.
+    label: :class:`str`
+        The main text associated with this label's ``component``, up to 45 characters.
+    description: Optional[:class:`str`]
+        The description associated with this label's ``component``, up to 100 characters.
+    """
+
+    __slots__: tuple[str, ...] = ("component", "label", "description")
+
+    __repr_info__: ClassVar[tuple[str, ...]] = __slots__
+    versions: tuple[int, ...] = ()
+
+    def __init__(self, data: LabelComponentPayload):
+        self.type: ComponentType = try_enum(ComponentType, data["type"])
+        self.id: int = data["id"]
+        self.component: Component = _component_factory(data["component"])
+        self.label: str = data["label"]
+        self.description: str | None = data.get("description")
+
+    def to_dict(self) -> LabelComponentPayload:
+        payload = {
+            "type": int(self.type),
+            "id": self.id,
+            "component": self.component.to_dict(),
+            "label": self.label,
+            "description": self.description,
+        }
+        return payload
+
+    def walk_components(self) -> Iterator[Component]:
+        yield from [self.component]
+
+
 COMPONENT_MAPPINGS = {
     1: ActionRow,
     2: Button,
@@ -1053,6 +1114,7 @@ def walk_components(self) -> Iterator[Component]:
     13: FileComponent,
     14: Separator,
     17: Container,
+    18: Label,
 }
 
 STATE_COMPONENTS = (Section, Container, Thumbnail, MediaGallery, FileComponent)

discord/interactions.py

@@ -193,6 +193,7 @@ class Interaction:
         "view",
         "modal",
         "attachment_size_limit",
+        "_raw_data",
         "_channel_data",
         "_message_data",
         "_guild_data",
@@ -215,6 +216,7 @@ def __init__(self, *, data: InteractionPayload, state: ConnectionState):
         self._from_data(data)
 
     def _from_data(self, data: InteractionPayload):
+        self._raw_data: InteractionPayload = data
         self.id: int = int(data["id"])
         self.type: InteractionType = try_enum(InteractionType, data["type"])
         self.data: InteractionData | None = data.get("data")

discord/types/components.py

@@ -33,7 +33,7 @@
 from .emoji import PartialEmoji
 from .snowflake import Snowflake
 
-ComponentType = Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 16, 17]
+ComponentType = Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18]
 ButtonStyle = Literal[1, 2, 3, 4, 5, 6]
 InputTextStyle = Literal[1, 2]
 SeparatorSpacingSize = Literal[1, 2]
@@ -69,7 +69,7 @@ class InputText(BaseComponent):
     type: Literal[4]
     style: InputTextStyle
     custom_id: str
-    label: str
+    label: NotRequired[str]
 
 
 class SelectOption(TypedDict):
@@ -89,6 +89,7 @@ class SelectMenu(BaseComponent):
     options: NotRequired[list[SelectOption]]
     type: Literal[3, 5, 6, 7, 8]
     custom_id: str
+    required: NotRequired[bool]
 
 
 class TextDisplayComponent(BaseComponent):
@@ -151,6 +152,13 @@ class ContainerComponent(BaseComponent):
     components: list[AllowedContainerComponents]
 
 
+class LabelComponent(BaseComponent):
+    type: Literal[18]
+    label: str
+    description: NotRequired[str]
+    component: SelectMenu | InputText
+
+
 Component = Union[ActionRow, ButtonComponent, SelectMenu, InputText]
 
 

discord/ui/input_text.py

@@ -6,9 +6,10 @@
 from ..components import InputText as InputTextComponent
 from ..enums import ComponentType, InputTextStyle
 
-__all__ = ("InputText",)
+__all__ = ("InputText", "TextInput")
 
 if TYPE_CHECKING:
+    from ..interactions import Interaction
     from ..types.components import InputText as InputTextComponentPayload
 
 
@@ -26,6 +27,11 @@ class InputText:
     label: :class:`str`
         The label for the input text field.
         Must be 45 characters or fewer.
+    description: Optional[:class:`str`]
+        The description for the input text field.
+        Must be 100 characters or fewer.
+
+        .. versionadded:: 2.7
     placeholder: Optional[:class:`str`]
         The placeholder text that is shown if nothing is selected, if any.
         Must be 100 characters or fewer.
@@ -58,6 +64,7 @@ class InputText:
         "max_length",
         "custom_id",
         "id",
+        "description",
     )
 
     def __init__(
@@ -73,10 +80,13 @@ def __init__(
         value: str | None = None,
         row: int | None = None,
         id: int | None = None,
+        description: str | None = None,
     ):
         super().__init__()
         if len(str(label)) > 45:
             raise ValueError("label must be 45 characters or fewer")
+        if description and len(description) > 100:
+            raise ValueError("description must be 100 characters or fewer")
         if min_length and (min_length < 0 or min_length > 4000):
             raise ValueError("min_length must be between 0 and 4000")
         if max_length and (max_length < 0 or max_length > 4000):
@@ -90,6 +100,7 @@ def __init__(
                 f"expected custom_id to be str, not {custom_id.__class__.__name__}"
             )
         custom_id = os.urandom(16).hex() if custom_id is None else custom_id
+        self.description: str | None = description
 
         self._underlying = InputTextComponent._raw_construct(
             type=ComponentType.input_text,
@@ -236,3 +247,12 @@ def to_component_dict(self) -> InputTextComponentPayload:
 
     def refresh_state(self, data) -> None:
         self._input_value = data["value"]
+
+    def refresh_from_modal(self, interaction: Interaction, data: dict) -> None:
+        return self.refresh_state(data)
+
+    def uses_label(self) -> bool:
+        return self.description is not None
+
+
+TextInput = InputText

discord/ui/item.py

@@ -90,6 +90,9 @@ def refresh_component(self, component: Component) -> None:
     def refresh_state(self, interaction: Interaction) -> None:
         return None
 
+    def refresh_from_modal(self, interaction: Interaction, data: dict) -> None:
+        return None
+
     @classmethod
     def from_component(cls: type[I], component: Component) -> I:
         return cls()
@@ -107,6 +110,9 @@ def is_storable(self) -> bool:
     def is_persistent(self) -> bool:
         return not self.is_dispatchable() or self._provided_custom_id
 
+    def uses_label(self) -> bool:
+        return False
+
     def copy_text(self) -> str:
         return ""