Skip to main content

Unofficial discord-interactions multi page embed handler

Project description

dinteractions-Paginator

Unofficial discord-interactions multi-page embed handler

Installation

pip install dinteractions-Paginator

Dependencies

Example GIF:

Paginator with select:

Examples:

These simple examples show how to easily create interactive, multiple page embeds that annyone can interact with.

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="Hello there")
 
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="Hello there")
 
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[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]: if you want the paginator to work for a limited number of seconds, you can specify it here, 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:

  • useSelect - Optional[bool]: if you want the paginator to use a select, default is True
  • useIndexButton - Optional[bool]: if you want the paginator to use the index button, default is 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dinteractions_Paginator-1.1.4.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

dinteractions_Paginator-1.1.4-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file dinteractions_Paginator-1.1.4.tar.gz.

File metadata

  • Download URL: dinteractions_Paginator-1.1.4.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for dinteractions_Paginator-1.1.4.tar.gz
Algorithm Hash digest
SHA256 1a2ed1c339638dff26611ea3fd3328ab88aee896ef3228ac5cbe914c6e3f107d
MD5 ea33754c89fb852e3a247ec7a4b77968
BLAKE2b-256 3952520941aad51da1ac9b1c5eb447ef629c9b2e7f3dbb98ba9342c547a3792f

See more details on using hashes here.

File details

Details for the file dinteractions_Paginator-1.1.4-py3-none-any.whl.

File metadata

  • Download URL: dinteractions_Paginator-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for dinteractions_Paginator-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7d79d49a8325ba7c35e7238512179285f31ea68cbb83bff37e4e7f0650419d92
MD5 542eb08d20d53684557259871ac2f899
BLAKE2b-256 6b1644dba45aa29d97fa7efc1f859cbe4f9da69903611c21b14940525eac93d7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page