dinteractions-Paginator 1.2.4

Unofficial discord-interactions multi page embed handler

dinteractions-Paginator

Unofficial discord-interactions multi-page embed handler

Table of Contents

• Features
• Installation
• Dependencies
• Examples
  • Example GIF:
  • Slash command:
  • Normal command:
    • Note
• Paginator
• TimedOut
• Credits

Join our Discord server!

• Try out all the possible combinations of the paginator with /example1 and /example2,
• Ask some questions,
• And give us feedback and suggestions!

Features

• Message per embed or persistent message
• Index select that can be turned on/off
• Select labels are generated based on embed's title
• Index button that can be turned on/off
• Ability to set the buttons to any emote, color or label

Installation

pip install -U dinteractions-Paginator

Dependencies

• discord.py (version 1.7.3)
• discord-interactions (version 3.0.1 - 3.0.2)

Examples:

These simple examples show how to easily create interactive, multiple page embeds that anyone can interact with that automatically deactivate after 60 seconds of inactivity:

Example GIF:

Paginator with select:

Slash command:

import discord
from discord.ext import commands
from discord_slash import SlashCommand, SlashContext
from dinteractions_Paginator import Paginator

bot = commands.Bot(command_prefix="/")
slash = SlashCommand(bot, sync_commands=True)

@bot.event
async def on_ready():
    print(f"Logged in as {bot.user}!")

@slash.slash(name="embeds")
async def embeds(ctx: SlashContext):
    one = discord.Embed(title="1st Embed", description="General Kenobi!", color=discord.Color.red())
    two = discord.Embed(title="2nd Embed", description="General Kenobi!", color=discord.Color.orange())
    three = discord.Embed(title="3rd Embed", description="General Kenobi!", color=discord.Color.gold())
    four = discord.Embed(title="4th Embed", description="General Kenobi!", color=discord.Color.green())
    five = discord.Embed(title="5th Embed", description="General Kenobi!", color=discord.Color.blue())
    pages = [one, two, three, four, five]

    await Paginator(bot=bot, ctx=ctx, pages=pages, content=["1", "2", "3", "4", "5"], timeout=60).run()

bot.run("token")

Normal command:

import discord
from discord.ext import commands
from discord_slash import SlashCommand
from dinteractions_Paginator import Paginator

bot = commands.Bot(command_prefix="/")
slash = SlashCommand(bot)

@bot.event
async def on_ready():
    print(f"Logged in as {bot.user}!")

@bot.command()
async def embeds(ctx):
    one = discord.Embed(title="1st Embed", description="General Kenobi!", color=discord.Color.red())
    two = discord.Embed(title="2nd Embed", description="General Kenobi!", color=discord.Color.orange())
    three = discord.Embed(title="3rd Embed", description="General Kenobi!", color=discord.Color.gold())
    four = discord.Embed(title="4th Embed", description="General Kenobi!", color=discord.Color.green())
    five = discord.Embed(title="5th Embed", description="General Kenobi!", color=discord.Color.blue())
    pages = [one, two, three, four, five]

    await Paginator(bot=bot, ctx=ctx, pages=pages, content=["1", "2", "3", "4", "5"], timeout=60).run()

bot.run("token")

NOTE: slash = SlashCommand(bot) required to override bot

class Paginator

Arguments

• Required
• Optional
  • Time
  • What to use
  • Labels
  • Emojis
  • Styles
• Returns

Required:

• bot - commands.Bot: The bot variable, commands.Bot is required
• ctx - Union[SlashContext, commands.Context, ComponentContext, MenuContext, discord.TextChannel, discord.User, discord.Member]: The context of a command.
  NOTE: if one of the latter 3 are used, there will always be a This interaction failed even though it was a success, due to no context to respond to
• pages - List[discord.Embed]: A list of embeds to be paginated

---

Optional:

• content - Optional[Union[str, List[str]]]: the content of the message to send, defaults to None
• hidden - Optional[bool]: if you want the paginator to be hidden, default False
• authorOnly - Optional[bool]: if you want the paginator to work for the author only, default is False
• onlyFor - Optional[Union[discord.User, discord.Role, List[Union[discord.User, discord.Role]]]]: components only for specified user(s) or role(s)
• dm - Optional[bool]: if you want the paginator to be DM'ed, default False

Time:

• timeout - Optional[int]: deactivates paginator after inactivity if enabled, defaults to None (meaning no timeout)
• disableAfterTimeout - Optional[bool]: disable components after timeout, default True
• deleteAfterTimeout - Opti onal[bool]: delete components after timeout, default False

What to use:

• useButtons - Optional[bool]: uses buttons, default is True
• useSelect - Optional[bool]: uses a select, default is True
• useIndexButton - Optional[bool]: uses the index button, default is False and stays False if useButtons is also False
• useLinkButton - Optional[bool]: uses the link button
• useFirstLast - Optional[bool]: uses the first and last buttons, default True

Labels:

• firstLabel - Optional[str]: The label of the button used to go to the first page, defaults to ""
• prevLabel - Optional[str]: The label of the button used to go to the previous page, defaults to ""
• indexLabel - Optional[str]: The label of the index button, defaults to "Page"
• nextLabel - Optional[str]: The label of the button used to go to the next page, defaults to ""
• lastLabel - Optional[str]: The label of the button used to go to the last page, defaults to ""
• linkLabel - Optional[Union[str, List[str]]]: The label for the link button
• linkURL - Optional[Union[str, List[str]]]: The URL(s) for the link button
• customButtonLabel = Optional[str]: The label of a custom disabled button, default None

Emojis:

• firstEmoji - Optional[Union[discord.emoji.Emoji, discord.partial_emoji.PartialEmoji, dict, bytes]: emoji of the button used to go to the first page, defaults to "⏮️"
• prevEmoji - Optional[Union[discord.emoji.Emoji, discord.partial_emoji.PartialEmoji, dict, bytes]: emoji of the button used to go to the previous page, defaults to "◀"
• nextEmoji - Optional[Union[discord.emoji.Emoji, discord.partial_emoji.PartialEmoji, dict, bytes]: emoji of the button used to go to the next page, defaults to "▶"
• lastEmoji - Optional[Union[discord.emoji.Emoji, discord.partial_emoji.PartialEmoji, dict, bytes]: emoji of the button used to go to the last page, defaults to "⏭️"
• customButtonEmoji - Optional[Union[discord.emoji.Emoji, discord.partial_emoji.PartialEmoji, dict, bytes]: emoji of the custom disabled button, defaults to None

Styles (the colo[u]r of the buttons):

• firstStyle - Optional[Union[ButtonStyle, int]]: the style of button (ButtonStyle or int) for the first button, defaults to 1 (ButtonStyle.blue)
• prevStyle - Optional[Union[ButtonStyle, int]]: the style of button (ButtonStyle or int) for the previous button, defaults to 1 (ButtonStyle.blue)
• indexStyle - Optional[Union[ButtonStyle, int]]: the style of button (ButtonStyle or int) for the index button, defaults to 3 (ButtonStyle.green)
• nextStyle - Optional[Union[ButtonStyle, int]]: the style of button (ButtonStyle or int) for the next button, defaults to 1 (ButtonStyle.blue)
• lastStyle - Optional[Union[ButtonStyle, int]]: the style of button (ButtonStyle or int) for the last button, defaults to 1 (ButtonStyle.blue)
• customButtonStyle - Optional[Union[ButtonStyle, int]]: the style of button (ButtonStyle or int) for the last button, defaults to 2 (ButtonStyle.gray)

Returns

class TimedOut

---

class TimedOut

Attributes

• ctx - Union[commands.Context, SlashContext]: The original context
• buttonContext - ComponentContext: The context for the paginator's components
• timeTaken - int: How long in seconds that user(s) used the paginator before the timeout
• lastEmbed - discord.Embed: The last embed that the paginator stopped at after timeout
• successfulUsers - List[discord.User]: Users that successfully used the paginator, the first user is the invoker
• failedUsers - List[discord.User]: Users that failed to use the paginator

---

Credits

• Contributors of discord-interactions
  • GitHub
  • Discord server
• dpy-slash-button-paginator
  • GitHub