[Guide] add guide pages for views/modals #7507

bijij · 2022-03-06T02:07:05Z

Summary

Adds guide pages for views/modals

Checklist

If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes.
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, ...)

Co-Authored-By: Devon R <Gorialis@users.noreply.github.com> Co-Authored-By: Riley Miļeško <30989490+Shineydev@users.noreply.github.com> Co-Authored-By: Nadir Chowdhury <chowdhurynadir0@outlook.com>

Co-Authored-By: Kaylynn Morgan <51037748+kaylynn234@users.noreply.github.com>

scarletcafe

I can't see any problems that stand out to me.

ShineyDev

Review'd modals.rst.

docs/guide/interactions/modals.rst

ShineyDev

Review'd views.rst.

docs/guide/interactions/views.rst

ShineyDev

Can we also rename the image files from modals1 etc.? :)

Co-Authored-By: Riley Miļeško <30989490+ShineyDev@users.noreply.github.com>

Soheab · 2023-09-11T06:33:38Z

~~This is missing the recently added dynamic items. If it's still being worked.~~

docs/guide/interactions/views.rst

IAmTomahawkx · 2023-09-14T00:31:33Z

docs/guide/interactions/views.rst

+    roles = [guild.get_role(id) for id in ROLE_IDS]
+    await channel.send('Choose your house', view=RoleSelector(0, roles)) # we don't know the message ID yet.
+
+Once we have a message ID we just need to create an instance of our view and attach it to the :class:`~discord.Client`


(RFC) While a bit out of the scope of this topic, I don't believe that anywhere in the guide we mentions how to get message IDs. Is that something worth adding here?

I kind of hoped it was implied.
But i can be more specific.

Idea is the user sends the message first, then knows the ID then uses it.

docs/guide/interactions/views.rst

thomasemeryy

Added some grammar corrections and wording suggestions (some of which are nit-picky so feel free to disagree). Great job on the guides.

docs/guide/interactions/modals.rst

docs/guide/interactions/views.rst

docs/guide/interactions/modals.rst

Co-Authored-By: Thomas Emery <103364635+aqwuah@users.noreply.github.com>

Co-authored-by: Tom <angelo@angelomanca.com>

bijij · 2023-09-15T01:01:12Z

This is missing the recently added dynamic items. If it's still being worked.

Added a new section on dynamic items

bijij · 2023-09-15T01:01:42Z

Ctrl+enter defaulted to close with comment?

thomasemeryy

Looks good to me.

Aryathel

Just a few edits/clarity pieces I think are worth looking at.

docs/guide/interactions/modals.rst

docs/guide/interactions/views.rst

Aryathel · 2023-09-15T16:26:19Z

docs/guide/interactions/views.rst

+The :class:`~discord.ui.View` class also supports a :meth:`~discord.ui.View.interaction_check` method, which we'll
+use to check if the user who clicked on buttons in the view is the same as the user we're prompting for confirmation.
+It should return a boolean value which, when ``False``, will cause the interaction to be ignored.


I think that this piece deserves its own section. It doesn't need to be long, but having a Checks section after the Creating Components section might be a little more clear.

This is important enough to be mentioned separately, but technically not intrinsically necessary for the function of a view, hence why I recommend putting the guide for it below the part where the components are added.

I partially disagree on this. It's fine leaving this section here as it's needed to build the context and explain what the code above does. People would be asking "what does interaction_check do in the code" without the proper context. Further details can be linked to the checks guide itself

This is in reference to @Aryathel 's review comment

docs/guide/interactions/views.rst

Aryathel · 2023-09-15T17:16:15Z

docs/guide/interactions/views.rst

+Once we have a message ID, we just need to create an instance of our view and attach it to the :class:`~discord.Client`
+with the :meth:`~discord.Client.add_view` method.


Suggested change

Once we have a message ID, we just need to create an instance of our view and attach it to the :class:`~discord.Client`

with the :meth:`~discord.Client.add_view` method.

Once we have a message ID, we just need to create an instance of our view and attach it to the :class:`~discord.Client`

with the :meth:`~discord.Client.add_view` method. By calling this method in our client setup and using a custom ID on all of the view components, the bot will add this view every time it is started. This is what makes a view persistent.

I'm not sure I am perfectly happy with my wording here either, but adding a little more detail describing what exactly this section is for and why this is important for a persistent view seems relevant.

Added some extra detail, however I'm not really sure there's much benefit.

Co-authored-by: Arya (She/Her) <arya.mayfield@gmail.com>

No767

I left some feedback based off of a brief reading of the modal and view pages. Note that it is not a complete read and I may have missed some details along the way.

docs/guide/interactions/modals.rst

docs/guide/interactions/views.rst

docs/guide/interactions/modals.rst

docs/guide/interactions/views.rst

No767 · 2024-01-11T09:41:34Z

docs/guide/interactions/views.rst

+        def __init__(self) -> None:
+            super().__init__(timeout=None)
+
+        @discord.ui.select(


discord.ui.select has an kwarg called cls. In this, you pass in the type of select that you want. In this case, all we need to do is to pass in discord.ui.RoleSelect. The current implementation in this page relies on an old method on doing this and uses the base select type.

RoleSelect doesn't provide the same functionality though (it lists all roles). If we'd rather use it then it would make more sense to just replace the entire example.

It would make more sense instead of roles, that they are something unique such as colors imo. this kinda depends if the example should be replaced or not

I fully agree with Josh on this one. The Select classes provide no filter (which is a bit of a silly move on Discord's side IMO>. As such I still view this as best practice as we can filter what is shown to the user, and not make an accidental footgun where a user could give themselves an admin role.

fair enough

bijij

Addressed some review comments.

docs/guide/interactions/modals.rst

bijij · 2024-01-11T12:00:43Z

docs/guide/interactions/views.rst

+        def __init__(self) -> None:
+            super().__init__(timeout=None)
+
+        @discord.ui.select(


RoleSelect doesn't provide the same functionality though (it lists all roles). If we'd rather use it then it would make more sense to just replace the entire example.

bijij · 2024-01-11T12:02:36Z

docs/guide/interactions/views.rst

+Once we have a message ID, we just need to create an instance of our view and attach it to the :class:`~discord.Client`
+with the :meth:`~discord.Client.add_view` method.


Added some extra detail, however I'm not really sure there's much benefit.

docs/guide/interactions/views.rst

Soheab

Just two small things that I'm not sure about whether they need to be mentioned, so it's up to you and others. It looks good otherwise.

Soheab · 2024-02-05T14:41:02Z

docs/guide/interactions/modals.rst

+The callback is passed a new :class:`~discord.Interaction` instance, which requires a response.
+
+In the example above we respond by sending a message to the user confirming their submission was recorded.
+Users responses to specific fields can be accessed via the field's ``value`` attribute.


Not super important and not too sure, but I noticed that it is nowhere mentioned that casting the TextInput (or in a f-string (same thing)) to str() will also return the value. This could lead to unexpected behavior or cause confusion for beginners.

Soheab · 2024-02-05T14:43:34Z

docs/guide/interactions/modals.rst

+Sending a Modal
+-----------------
+
+A modal can be sent by calling the :meth:`InteractionResponse.send_modal` method when handling an :class:`Interaction`.


Very straightforward, etc., but it might be worth mentioning that Modals is its own response, thus the response cannot be delayed or sent from a follow-up, etc.

No767

I've left some of my suggestions. Overall, the guide is fine but make sure you address the suggestions that are pointed out in this review.

docs/guide/interactions/modals.rst

No767 · 2024-02-06T08:22:13Z

docs/guide/interactions/views.rst

+The :class:`~discord.ui.View` class also supports a :meth:`~discord.ui.View.interaction_check` method, which we'll
+use to check if the user who clicked on buttons in the view is the same as the user we're prompting for confirmation.
+It should return a boolean value which, when ``False``, will cause the interaction to be ignored.


I partially disagree on this. It's fine leaving this section here as it's needed to build the context and explain what the code above does. People would be asking "what does interaction_check do in the code" without the proper context. Further details can be linked to the checks guide itself

This is in reference to @Aryathel 's review comment

No767 · 2024-02-06T08:29:07Z

docs/guide/interactions/views.rst

+We set parameters prior to the creation of the view instance, so context-specific variables are not available.
+If modifications are needed, we would instead have to override component instance attributes in the ``__init__`` method.
+
+The function we're decorating acts similarly to the :meth:`~discord.ui.Button.callback` method, it's called when the button is clicked.


Suggested change

The function we're decorating acts similarly to the :meth:`~discord.ui.Button.callback` method, it's called when the button is clicked.

The function we're decorating acts similarly to the :meth:`~discord.ui.Button.callback` method as it's called when the button is clicked.

Minor grammatical correction and nitpicking, but separating the two clauses using an comma doesn't make sense. If you read it out loud to yourself, you'll find that using an comma doesn't work as you would want to join these two clauses into an sentence to complete it

docs/guide/interactions/views.rst

No767 · 2024-02-06T08:41:19Z

docs/guide/interactions/views.rst

+        def __init__(self) -> None:
+            super().__init__(timeout=None)
+
+        @discord.ui.select(


fair enough

docs/guide/interactions/views.rst

No767 · 2024-02-07T04:51:19Z

docs/guide/interactions/views.rst

+            role = discord.Object(id=role_id, type=discord.Role)
+            roles = set(interaction.user.roles) - set(self.roles) | {role}
+            await interaction.user.edit(roles=roles)
+            await interaction.response.defer()


Instead of deferring the interaction and not acknowledging the response, you should send an message response instead. The contents of the message should tell the user that their role has been changed to the role that they have selected, and this should be ephemeral.

Co-authored-by: Noelle Wang <73260931+No767@users.noreply.github.com>

bijij and others added 8 commits February 26, 2022 18:25

[WIP] View/Modal docs

7a69bf3

add images

6633f56

Increase image resolution

9a7259d

Make changes as suggested in code-review

730e963

Co-Authored-By: Devon R <Gorialis@users.noreply.github.com> Co-Authored-By: Riley Miļeško <30989490+Shineydev@users.noreply.github.com> Co-Authored-By: Nadir Chowdhury <chowdhurynadir0@outlook.com>

Add persistent views section

9bcb5ea

Make changes based on review

e2ac9c1

Co-Authored-By: Kaylynn Morgan <51037748+kaylynn234@users.noreply.github.com>

Reword Handling User Responses section

1f23a8a

Co-Authored-By: Kaylynn Morgan <51037748+kaylynn234@users.noreply.github.com>

Fix punctuation

c4f8796

Rapptz added the guide This relates to the discord.py guide label Mar 9, 2022

Rapptz mentioned this pull request Mar 12, 2022

The discord.py Guide #7654

Open

23 tasks

scarletcafe approved these changes Mar 17, 2022

View reviewed changes

ShineyDev suggested changes Mar 19, 2022

View reviewed changes

bijij and others added 2 commits March 19, 2022 17:59

Make changes as per review

05647b3

Co-Authored-By: Riley Miļeško <30989490+ShineyDev@users.noreply.github.com>

Update docs to support recent breaking changes

82cf939

ShineyDev approved these changes Mar 25, 2022

View reviewed changes

More changes as per review

4a1dbab

Rapptz force-pushed the docs/guide branch from 007ab7c to a2b09c0 Compare February 11, 2023 23:44

Merge remote-tracking branch 'upstream/docs/guide' into guide/views

8176a2c

IAmTomahawkx suggested changes Sep 14, 2023

View reviewed changes

thomasemeryy suggested changes Sep 14, 2023

View reviewed changes

bijij and others added 6 commits September 15, 2023 09:27

Merge branch 'master' into guide/views

4450432

remove duplicate extlinks

5fd0073

Make grammatical changes as per code review suggestions.

7c80b6f

Co-Authored-By: Thomas Emery <103364635+aqwuah@users.noreply.github.com>

Fix issue with example code

300a3fc

Co-authored-by: Tom <angelo@angelomanca.com>

Merge branch 'docs/guide' into guide/views

120d580

Cleanup and add section on dynamic items

37b9319

bijij closed this Sep 15, 2023

bijij reopened this Sep 15, 2023

bijij requested a review from thomasemeryy September 15, 2023 01:02

thomasemeryy approved these changes Sep 15, 2023

View reviewed changes

Aryathel suggested changes Sep 15, 2023

View reviewed changes

Update docs/guide/interactions/views.rst

a07189e

Co-authored-by: Arya (She/Her) <arya.mayfield@gmail.com>

No767 suggested changes Jan 11, 2024

View reviewed changes

bijij added 2 commits January 11, 2024 21:32

Merge branch 'docs/guide' into guide/views

abb3645

Address some review comments

a335784

bijij commented Jan 11, 2024

View reviewed changes

bijij added 3 commits February 4, 2024 00:36

Merge branch 'docs/guide' into guide/views

6bf4494

Address review comments

fa671f9

Make Soheab happy

8a3e3e5

Soheab approved these changes Feb 5, 2024

View reviewed changes

No767 suggested changes Feb 6, 2024

View reviewed changes

No767 reviewed Feb 7, 2024

View reviewed changes

bijij and others added 3 commits February 20, 2024 22:16

Update docs/guide/interactions/modals.rst

0e984d5

Co-authored-by: Noelle Wang <73260931+No767@users.noreply.github.com>

Update docs/guide/interactions/views.rst

b34dde0

Co-authored-by: Noelle Wang <73260931+No767@users.noreply.github.com>

Update docs/guide/interactions/views.rst

fe308bb

Co-authored-by: Noelle Wang <73260931+No767@users.noreply.github.com>

		Once we have a message ID, we just need to create an instance of our view and attach it to the :class:`~discord.Client`
		with the :meth:`~discord.Client.add_view` method.

	The function we're decorating acts similarly to the :meth:`~discord.ui.Button.callback` method, it's called when the button is clicked.
	The function we're decorating acts similarly to the :meth:`~discord.ui.Button.callback` method as it's called when the button is clicked.

Uh oh!

[Guide] add guide pages for views/modals #7507

Are you sure you want to change the base?

[Guide] add guide pages for views/modals #7507

Uh oh!

Conversation

bijij commented Mar 6, 2022

Summary

Checklist

Uh oh!

scarletcafe left a comment

Choose a reason for hiding this comment

Uh oh!

ShineyDev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ShineyDev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ShineyDev left a comment

Choose a reason for hiding this comment

Uh oh!

Soheab commented Sep 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

thomasemeryy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bijij commented Sep 15, 2023

Uh oh!

bijij commented Sep 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thomasemeryy left a comment

Choose a reason for hiding this comment

Uh oh!

Aryathel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

No767 Feb 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Soheab commented Sep 11, 2023 •

edited

Loading

bijij commented Sep 15, 2023 •

edited

Loading

No767 Feb 6, 2024 •

edited

Loading