@@ -65,19 +65,6 @@ async def callback(self, interaction: discord.Interaction):
65
65
class Paginator (discord .ui .View ):
66
66
"""Creates a paginator which can be sent as a message and uses buttons for navigation.
67
67
68
- Attributes
69
- ----------
70
- current_page: :class:`int`
71
- A zero-indexed value showing the current page number.
72
- page_count: :class:`int`
73
- A zero-indexed value showing the total number of pages.
74
- buttons: Dict[:class:`str`, Dict[:class:`str`, Union[:class:`~PaginatorButton`, :class:`bool`]]]
75
- A dictionary containing the :class:`~PaginatorButton` objects included in this paginator.
76
- user: Optional[Union[:class:`~discord.User`, :class:`~discord.Member`]]
77
- The user or member that invoked the paginator.
78
- message: Union[:class:`~discord.Message`, :class:`~discord.WebhookMessage`]
79
- The message the paginator is attached to.
80
-
81
68
Parameters
82
69
----------
83
70
pages: Union[List[:class:`str`], List[:class:`discord.Embed`]]
@@ -89,9 +76,24 @@ class Paginator(discord.ui.View):
89
76
author_check: :class:`bool`
90
77
Whether only the original user of the command can change pages.
91
78
disable_on_timeout: :class:`bool`
92
- Whether the buttons get disabled when the pagintator view times out.
79
+ Whether the buttons get disabled when the paginator view times out.
93
80
custom_view: Optional[:class:`discord.ui.View`]
94
81
A custom view whose items are appended below the pagination buttons.
82
+ timeout: Optional[:class:`float`]
83
+ Timeout in seconds from last interaction with the paginator before no longer accepting input.
84
+
85
+ Attributes
86
+ ----------
87
+ current_page: :class:`int`
88
+ A zero-indexed value showing the current page number.
89
+ page_count: :class:`int`
90
+ A zero-indexed value showing the total number of pages.
91
+ buttons: Dict[:class:`str`, Dict[:class:`str`, Union[:class:`~PaginatorButton`, :class:`bool`]]]
92
+ A dictionary containing the :class:`~PaginatorButton` objects included in this paginator.
93
+ user: Optional[Union[:class:`~discord.User`, :class:`~discord.Member`]]
94
+ The user or member that invoked the paginator.
95
+ message: Union[:class:`~discord.Message`, :class:`~discord.WebhookMessage`]
96
+ The message the paginator is attached to.
95
97
"""
96
98
97
99
def __init__ (
@@ -187,7 +189,7 @@ async def goto_page(self, interaction: discord.Interaction, page_number=0) -> No
187
189
Parameters
188
190
----------
189
191
interaction: :class:`discord.Interaction`
190
- The interaction which called the Paginator
192
+ The interaction that invoked the paginator.
191
193
page_number: :class:`int`
192
194
The page to display.
193
195
0 commit comments