matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Update paginator.py

Browse Source
This commit is contained in:
Maxikinz 2021-10-09 20:29:00 +02:00 committed by GitHub
parent 7228ef64a5
commit c74fd90a9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
examples/views/paginator.py
View File

@ -1,5 +1,5 @@
#First we define 3 View subclasses that we will switch between depending on if we are viewing the first page, a page in the middle, or the last page.
#The first page has the "left" button disabled, because there is no left page to go to...
# First we define 3 View subclasses that we will switch between depending on if we are viewing the first page, a page in the middle, or the last page.
# The first page has the "left" button disabled, because there is no left page to go to...
class FirstPageComps(View):
def __init__(self, author_id: int):
super().__init__()
@ -9,17 +9,18 @@ class FirstPageComps(View):
async def interaction_check(self, interaction: Interaction):
return interaction.user.id == self.author_id
@discord.ui.button(style=ButtonStyle.primary, disabled=True, label='Left')
@discord.ui.button(style=ButtonStyle.primary, disabled=True, label="Left")
async def left(self, button: discord.ui.Button, interaction: Interaction):
self.value = "left"
self.stop()
@discord.ui.button(style=ButtonStyle.primary, label='Right')
@discord.ui.button(style=ButtonStyle.primary, label="Right")
async def right(self, button: discord.ui.Button, interaction: Interaction):
self.value = "right"
self.stop()
#The middle pages have both left and right buttons available
# The middle pages have both left and right buttons available
class MiddlePageComps(View):
def __init__(self, author_id: int):
super().__init__()
@ -29,17 +30,18 @@ class MiddlePageComps(View):
async def interaction_check(self, interaction: Interaction):
return interaction.user.id == self.author_id
@discord.ui.button(style=ButtonStyle.primary, label='Left')
@discord.ui.button(style=ButtonStyle.primary, label="Left")
async def left(self, button: discord.ui.Button, interaction: Interaction):
self.value = "left"
self.stop()
@discord.ui.button(style=ButtonStyle.primary, label='Right')
@discord.ui.button(style=ButtonStyle.primary, label="Right")
async def right(self, button: discord.ui.Button, interaction: Interaction):
self.value = "right"
self.stop()
#The last page has the right button disabled, because there's no right page to go to anymore...
# The last page has the right button disabled, because there's no right page to go to anymore...
class LastPageComps(View):
def __init__(self, author_id: int):
super().__init__()
@ -49,20 +51,20 @@ class LastPageComps(View):
async def interaction_check(self, interaction: Interaction):
return interaction.user.id == self.author_id
@discord.ui.button(style=ButtonStyle.primary, label='Left')
@discord.ui.button(style=ButtonStyle.primary, label="Left")
async def left(self, button: discord.ui.Button, interaction: Interaction):
self.value = "left"
self.stop()
@discord.ui.button(style=ButtonStyle.primary, label='Right', disabled=True)
@discord.ui.button(style=ButtonStyle.primary, label="Right", disabled=True)
async def right(self, button: discord.ui.Button, interaction: Interaction):
self.value = "right"
self.stop()
#Now we define the function that will take care of the pagination for us. It will take a list of Embeds and allow the user to cycle between them using left/right buttons
#There is also an optional title parameter in case you want to give your paginator a title, it will display in the embed title, for example if the title is Book
#then the title will look like "Book | Page 1/2". This is very optional and can be removed
# Now we define the function that will take care of the pagination for us. It will take a list of Embeds and allow the user to cycle between them using left/right buttons
# There is also an optional title parameter in case you want to give your paginator a title, it will display in the embed title, for example if the title is Book
# then the title will look like "Book | Page 1/2". This is very optional and can be removed
async def paginate(ctx, pages: list, title: str = None):
total_pages = len(pages)
@ -73,33 +75,41 @@ async def paginate(ctx, pages: list, title: str = None):
embed = first_page
if title:
embed.title = f'{title} | Page {index+1}/{total_pages}'
embed.title = f"{title} | Page {index+1}/{total_pages}"
view = FirstPageComps(ctx.author.id)
#Here we send the message with the view of the first page and the FirstPageComps buttons
# Here we send the message with the view of the first page and the FirstPageComps buttons
msg = await ctx.send(embed=embed, view=view)
#The default timeout for Views is 3 minutes, but if a user selects to scroll between pages the timer will be reset.
#If the timer reaches 0, though, the loop will just silently stop.
# The default timeout for Views is 3 minutes, but if a user selects to scroll between pages the timer will be reset.
# If the timer reaches 0, though, the loop will just silently stop.
while True:
wait = await view.wait()
if wait:
return
if view.value == "right":
index += 1
current_page = pages[index]
view = MiddlePageComps(ctx.author.id) if current_page != last_page else LastPageComps(ctx.author.id)
view = (
MiddlePageComps(ctx.author.id)
if current_page != last_page
else LastPageComps(ctx.author.id)
)
embed = current_page
if title:
embed.title = f'{title} | Page {index+1}/{total_pages}'
embed.title = f"{title} | Page {index+1}/{total_pages}"
elif view.value == "left":
index -= 1
current_page = pages[index]
view = MiddlePageComps(ctx.author.id) if current_page != first_page else FirstPageComps(ctx.author.id)
view = (
MiddlePageComps(ctx.author.id)
if current_page != first_page
else FirstPageComps(ctx.author.id)
)
embed = current_page
if title:
embed.title = f'{title} | Page {index+1}/{total_pages}'
embed.title = f"{title} | Page {index+1}/{total_pages}"
await msg.edit(embed=embed, view=view)