# Quickstart

This library can help you with creating message pages like shops, help pages etc.

Links:

* [Github](https://github.com/FlamptX/paginator.py)
* [PyPi](https://pypi.org/project/paginator.py/)

## Installation

The library can be installed using the python package manager `pip`

```
pip install paginator.py
```

## Examples

Here are some examples that might help.

### Sending a message with pages that uses reaction

```python
from paginator import Paginator, Page, NavigationType
from discord import Embed

...

paginator = Paginator(bot)


@bot.command()
async def test(ctx):
    pages = [
        Page(content="React!", embed=Embed(title="Page #1", description="Testing")),
        Page(embed=Embed(title="Page #2", description="Still testing")),
        Page(embed=Embed(title="Page #3", description="Guess... testing"))
    ]

    await paginator.send(ctx.channel, pages, type=NavigationType.Reactions)
```

### Sending a message with pages that uses buttons

```python
from paginator import Paginator, Page, NavigationType
from discord import Embed

...

paginator = Paginator(bot)


@bot.command()
async def test(ctx):
    pages = [
        Page(content="Click!", embed=Embed(title="Page #1", description="Testing")),
        Page(embed=Embed(title="Page #2", description="Still testing")),
        Page(embed=Embed(title="Page #3", description="Guess... testing"))
    ]

    await paginator.send(ctx.channel, pages, type=NavigationType.Buttons)
```

### Changing the emojis

```python
from paginator import Paginator, PageEmojis
from discord import Embed

...

paginator = Paginator(bot)


class Emojis(PageEmojis):
    def __init__(self):
        super().__init__()

        self.back = "⏪"
        self.forward = "⏩"


paginator.page_emojis = Emojis()
```