https://github.com/zaber-dev/DisnakePaginator
Easy Paginator For Discord And All it's fork such as Disnake, Pycord, etc
https://github.com/zaber-dev/DisnakePaginator
discord discord-py discordpy disnake disnake-bots
Last synced: 5 months ago
JSON representation
Easy Paginator For Discord And All it's fork such as Disnake, Pycord, etc
- Host: GitHub
- URL: https://github.com/zaber-dev/DisnakePaginator
- Owner: MahediZaber51
- License: mit
- Created: 2022-03-25T08:38:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-09T08:12:26.000Z (about 1 year ago)
- Last Synced: 2024-08-09T09:34:02.936Z (about 1 year ago)
- Topics: discord, discord-py, discordpy, disnake, disnake-bots
- Language: Python
- Homepage: https://zealtyro.com
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Easy Disnake Paginator
A package containing easy paginator for disnake
## Getting Started
install the python package to get started by:
```py
pip install EasyDisnakePaginator
```
## Examples
Creating a Paginator without embeds:
```py
paginator = EasyDisnakePaginator.Create(title="Easy Disnake Paginator", segments=["1st message", "2nd messagge"], color=0x00ff00)
await paginator.start(ctx)
```
Creating a Paginator with embeds
```py
paginator = EasyDisnakePaginator.Create(title="Easy Disnake Paginator", segments=[embed1, embed2], color=0x00ff00)
await paginator.start(ctx)
```
## Arguments
`title` = The title of the embed (when the segments are `str`) [type:`str`]\
\
`segments` = The pages of the paginator (supports `str` and `disnake.Embed`) [type: `str` or `disnake.Embed`]]\
\
`color` = The color of the embed\
\
`prefix` = The prefix text of every page in the embed (when the segments are `str`) [type: `str`]\
\
`suffix` = The suffix text of every page in the embed (when the segments are `str`) [type:`str`]\
\
`target_page` = The page that the paginator will display when created [type: `int`]\
\
`timeout` = The amount of seconds after the paginator buttons will stop working [type: `int`]\
\
`button_style` = The style of the buttons on the paginator [type: `disnake.ButtonStyle`]\
\
`invalid_user_function` = The function that will be called when another user tries to use the paginator. By default it will show an embed unless any function is specified.[type `function`]
## Useful Links:
**[WEBSITE](https://zealtyro.com)**\
**[YOUTUBE](https://youtube.com/ZealTyro)**\
**[TWITTER](https://twitter.com/MahediZaber)**