dinteractions-Paginator 1.1.5

Unofficial discord-interactions multi page embed handler

dinteractions-Paginator

Unofficial discord-interactions multi-page embed handler

Installation

pip install dinteractions-Paginator

Dependencies

• discord.py
• discord-interactions

Example GIF:

Paginator with select:

Examples:

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

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)

@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)
 
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="t")
slash = SlashCommand(bot)

@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)
 
bot.run("token")

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

Arguments

Required:

• bot - commands.Bot: The bot variable, commands.Bot is required
• ctx - Union[Context, SlashContext]: The context of a command
• 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
• authorOnly - Optional[bool]: if you want the paginator to work for the author only, default is 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 - Optional[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

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 ""
• 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 ""

Emojis:

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

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

• indexStyle - Optional[Union[ButtonStyle, int]]: the style of button (ButtonStyle or int) for the index button, defaults to 3 (ButtonStyle.green)
• 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)
• 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)

---

Credits

• Contributors of discord-interactions
  • GitHub
  • Discord server