feat: components v2 #1294

shiftinv · 2025-04-18T17:21:41Z

Summary

First off, this isn't quite finished, as evidenced by the fact that this is marked as a draft PR and the numerous TODOs scattered across the code, but still very much usable in its current state (once the experiment lock gets removed for everyone).
Most of the remaining changes are quality-of-life/DX improvements. I consider the interface fairly stable at this point, don't expect many further changes there.
It would probably make sense to wait a little longer with any reviews though, unless it's some glaring issue.

Description

discord/discord-api-docs@af1843d

This implements the new v2 components, including:

Section: displays a thumbnail or button next to some text
TextDisplay: plaintext, but as a component
MediaGallery: gallery/mosaic for up to 10 images
File: non-image attachments
Separator: vertical spacer/separator
Container: can be considered similar to an Embed

These new components are all non-interactive and intended for layout only, they are quite a bit more flexible than the previous content/embeds/attachments/components combo, and allow for much nicer looking/better structured messages.

Scope

I feel like it's worth clarifying that this is about as straightforward as the interface could be, only building on the existing implementation/functionality for components. There may very well be better ways (in terms of DX) to implement these components (namely, builder pattern, yippee), but I've considered this out of scope from the start.
I've intentionally not implemented support for the new components in Views, given the intended scope of this PR and the complexities that somehow integrating them would bring, especially since all of the components are non-interactive.
The goal with this PR was to get just about the most basic implementation going, any further work building on top of it will be in separate future PRs.

Example

code

(consider MediaGalleryItem unfinished, it is largely a placeholder implementation for now)

components: Sequence[ui.UIComponent] = [
    ui.TextDisplay("test"),
    ui.Separator(),
    ui.Container(
        ui.TextDisplay("this is text inside a container"),
        ui.MediaGallery(
            disnake.MediaGalleryItem(
                {
                    "media": {"url": "https://placecats.com/500/600"},
                    "description": "a cool media item",
                },
            ),
            disnake.MediaGalleryItem(
                {
                    "media": {"url": "https://placecats.com/800/600"},
                    "description": "more kitty",
                    "spoiler": True,
                },
            ),
        ),
        ui.Section(
            ui.TextDisplay(
                "What an incredible media gallery.\nOkay, that's all the time I've got. I got to get back to playing Animal Crossing New Leaf on my Nintendo 3DS."
            ),
            accessory=ui.Thumbnail(
                media={
                    "url": "https://i.kym-cdn.com/entries/icons/facebook/000/026/585/reggie_animalcrossingtour.jpg"
                },
                description="desc",
            ),
        ),
        ui.Separator(spacing=disnake.SeparatorSpacingSize.large),
        ui.ActionRow(disnake.ui.ChannelSelect(placeholder="Choose a Channel!")),
        accent_colour=disnake.Colour(0xEE99CC),
        spoiler=False,
    ),
]

await inter.response.send_message(components=components, flags=disnake.MessageFlags(is_components_v2=True))

Checklist

If code changes were made, then they have been tested
- I have updated the documentation to reflect the changes
- I have formatted the code properly by running pdm lint
- I have type-checked the code by running pdm pyright
This PR fixes an issue
This PR adds something new (e.g. new method or parameters)
This PR is a breaking change (e.g. methods or parameters removed/renamed)
This PR is not a code change (e.g. documentation, README, ...)

…t` for now to avoid shadowing

…omponent` more specific

…nRow`s

…type

… components

…cut types

…rows`

Enegg · 2025-04-23T21:14:11Z

disnake/ui/_types.py

What's the idea behind suffixing the types with Input?
I think it's a bit of a misnomer given only buttons/selects can be used for actual "input"
I'd say MessageComponentInput => MessageComponent sounds better, wdyt?

Could definitely rename it, it was mostly a decision made on a whim. c:
The [...]Input part of the type name was meant to signify that it's moreso a MessageComponent-like thing, ie. a single component, a list of action rows, a list of buttons and selects, etc etc, instead of only a single component like MessageComponent might suggest(?)
The library internally transforms these shortcuts into the "list of action rows" structure the API would expect (for components v1, at least). But yea, I'll gladly rename these type aliases if we can come up with a more fitting name.

I think just having it plural, like components: MessageComponents would be good enough
Alternatively, components: abc.Sequence[MessageComponent(s)] to better drive the fact it's always a sequence (unless we want to support singular components?)

Enegg

bnuuy

Enegg · 2025-04-26T04:28:38Z

disnake/interactions/message.py

+    id: :class:`int`
+        TODO
+
+        .. versionadded:: 2.11


Is this received even for interactive components? The docs say this is used to identify non-interactive ones 🤔

Enegg · 2025-04-26T04:36:40Z

disnake/ui/_types.py

I think just having it plural, like components: MessageComponents would be good enough
Alternatively, components: abc.Sequence[MessageComponent(s)] to better drive the fact it's always a sequence (unless we want to support singular components?)

Enegg · 2025-04-26T04:38:35Z

disnake/ui/container.py

+    """
+
+    # unused, but technically required by base type
+    __repr_attributes__: Tuple[str, ...] = (


Iirc some types define this as ClassVar and other do not, I think all should have it as ClassVar for consistency
Edit: components.Component uses __repr_info__: ClassVar[Tuple[str, ...]]

Suggested change

__repr_attributes__: Tuple[str, ...] = (

__repr_attributes__: ClassVar[Tuple[str, ...]] = (

Enegg · 2025-04-26T04:41:43Z

disnake/ui/file.py

+        Whether the file is marked as a spoiler. Defaults to ``False``.
+    """
+
+    __repr_attributes__: Tuple[str, ...] = (


Suggested change

__repr_attributes__: Tuple[str, ...] = (

__repr_attributes__: ClassVar[Tuple[str, ...]] = (

Enegg · 2025-04-26T04:44:06Z

disnake/ui/file.py

+    file: Any
+        n/a


I think this should work for existing Attachments, since really this only needs a url

Enegg · 2025-04-26T05:24:31Z

disnake/components.py

+
+    __slots__: Tuple[str, ...] = ("accessory", "components")
+
+    __repr_info__: ClassVar[Tuple[str, ...]] = __slots__


Hmm, Component has .__repr_info__, but .ui.UIComponent has .__repr_attributes__. Is this desirable?
(I suggest we use the same class variable name everywhere)

Enegg · 2025-04-26T05:29:33Z

disnake/components.py

+
+
+# see ActionRowMessageComponent
+VALID_ACTION_ROW_MESSAGE_TYPES: Final = (


I'd say ..._MESSAGE_TYPES conveys different to intended meaning
VALID_ACTION_ROW_MESSAGE_COMPONENTS? VALID_ACTION_ROW_MESSAGE_COMPONENT_TYPES?
Lengthy but less confusing

Enegg · 2025-04-26T05:31:28Z

disnake/components.py

+
+def _walk_internal(component: Component, seen: Set[Component]) -> Iterator[Component]:
+    if component in seen:
+        # prevent infinite recursion if anyone manages to nest a component in itself


What it actually does is skipping a component that has already been referenced.
That's not exactly the same as recursion, as a component could be reused between different containers/rows
It is an error if the component has a custom_id/id set, but for non-interactive components with omitted id it's technically fine

Enegg · 2025-04-26T05:37:19Z

disnake/components.py

+
+    if component_cls := COMPONENT_LOOKUP.get(component_type):
+        return component_cls(data)  # type: ignore
    else:
-        assert_never(component_type)
        as_enum = try_enum(ComponentType, component_type)
        return Component._raw_construct(type=as_enum)  # type: ignore


Could use a try - except KeyError - else here, unknown types are rather exceptional

Enegg · 2025-04-26T05:39:55Z

disnake/components.py

+def _message_component_factory(data: MessageTopLevelComponentPayload) -> MessageTopLevelComponent:
+    return _component_factory(data)  # type: ignore


Suggested change

def _message_component_factory(data: MessageTopLevelComponentPayload) -> MessageTopLevelComponent:

return _component_factory(data) # type: ignore

if TYPE_CHECKING:

def _message_component_factory(data: MessageTopLevelComponentPayload) -> MessageTopLevelComponent: ...

else:

_message_component_factory = _component_factory

shiftinv added 30 commits January 9, 2025 13:52

feat(flags): add new message flag

a7cf032

feat(enums): add new component types

9becf08

feat(types): add id field to all component types

215f37f

feat(types): add typeddicts for new components

91325ed

chore: add some comments from testing

c5084d8

fix: thumbnail media field has been renamed now

cf74701

chore: update comment now that sections allow buttons too

bd96624

fix: make SectionComponent.components typing more permissive

e06c077

feat: add SeparatorSpacingSize enum

f2f2817

feat(components): implement new component classes roughly

93902f5

fix(components): rename components.File -> `components.FileComponen…

7765c46

…t` for now to avoid shadowing

feat: add new components to factory function

0222377

fix: improve Container repr

9bb4013

refactor: rename existing action row component type aliases

928033c

perf: use mapping for _component_factory

b37c87c

refactor: make child component typehints more specific

ff6c20d

chore: move some TODOs

2522af4

docs: add docstrings for new components

103c1c2

feat(types): make child component types for ActionRow and `SectionC…

a363451

…omponent` more specific

fix(typing): resolve pyright complaints related to Message.components

3cfcdd0

refactor(typing): expand Message.components type beyond just `Actio…

7cd06f0

…nRow`s

fix: update relevant methods to account for new Message.components …

82eb456

…type

feat: add id field to message/modal interaction data

a7c2648

refactor: introduce yet another ui base type, for non-actionrow-child…

891ca40

… components

feat(ui): add new ui components, still partially broken

bd2865a

refactor(ui): rework section and container to actually be usable

222f513

docs: add ui components to docs, fix references

962c5d7

fix(ui): fix MediaGallery parameter type

a95e1b2

refactor(types): move action row types to ui._types, add some short…

6198aa6

…cut types

feat(types): add new components to MessageComponentInput union

0ded39d

shiftinv added 2 commits April 18, 2025 18:45

feat: support v2 components in normalize_components/`components_to_…

2ad9e10

…rows`

docs: add changelog entry

58b6045

shiftinv added t: api support Support of Discord API features s: in progress Issue/PR is being worked on s: waiting for api/docs Issue/PR is waiting for API support/documentation labels Apr 18, 2025

shiftinv added this to the disnake v2.11 milestone Apr 18, 2025

shiftinv added this to disnake Apr 18, 2025

github-project-automation bot moved this to Todo in disnake Apr 18, 2025

shiftinv removed the s: waiting for api/docs Issue/PR is waiting for API support/documentation label Apr 23, 2025

Enegg reviewed Apr 23, 2025

View reviewed changes

Enegg reviewed Apr 26, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: components v2 #1294

feat: components v2 #1294

shiftinv commented Apr 18, 2025 •

edited

Loading

Enegg Apr 23, 2025 •

edited

Loading

shiftinv Apr 24, 2025

Enegg Apr 26, 2025

Enegg left a comment

Enegg Apr 26, 2025

Enegg Apr 26, 2025

Enegg Apr 26, 2025 •

edited

Loading

Enegg Apr 26, 2025

Enegg Apr 26, 2025

Enegg Apr 26, 2025

Enegg Apr 26, 2025

Enegg Apr 26, 2025

Enegg Apr 26, 2025

Enegg Apr 26, 2025

	__repr_attributes__: Tuple[str, ...] = (
	__repr_attributes__: ClassVar[Tuple[str, ...]] = (


		__slots__: Tuple[str, ...] = ("accessory", "components")

		__repr_info__: ClassVar[Tuple[str, ...]] = __slots__



		# see ActionRowMessageComponent
		VALID_ACTION_ROW_MESSAGE_TYPES: Final = (

		def _message_component_factory(data: MessageTopLevelComponentPayload) -> MessageTopLevelComponent:
		return _component_factory(data) # type: ignore

-def _message_component_factory(data: MessageTopLevelComponentPayload) -> MessageTopLevelComponent:
-    return _component_factory(data)  # type: ignore
+if TYPE_CHECKING:
+    def _message_component_factory(data: MessageTopLevelComponentPayload) -> MessageTopLevelComponent: ...
+else:
+    _message_component_factory = _component_factory

feat: components v2 #1294

Are you sure you want to change the base?

feat: components v2 #1294

Conversation

shiftinv commented Apr 18, 2025 • edited Loading

Summary

Description

Scope

Example

Checklist

Enegg Apr 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Enegg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Enegg Apr 26, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shiftinv commented Apr 18, 2025 •

edited

Loading

Enegg Apr 23, 2025 •

edited

Loading

Enegg Apr 26, 2025 •

edited

Loading