discord-buttons-react/README.md

A package which allow you to use buttons as reactions

<div align="center">
  <p>
    <img src="https://gist.githubusercontent.com/gaetan20/b55932177fe4c41775acebc40f9d3dcc/raw/65533e199858dd2d6cd5dc7a820f57108baf95fa/discord-buttons-react.svg" alt="discord-buttons-react" />
     <a href="url"><img src="https://s6.gifyu.com/images/ezgif-2-723bd5d0c7d0.gif" style="border-radius: 10px 10px 10px 10px;" alt="Gif example"></a>
  </p>
  <br>
</div>

discord-buttons-react is a package that allow you to use buttons as reactions.

### BETA ! there's probably some bugs !

<br>

## Install
```sh
npm install discord-buttons-react
```
## Setup
```js
const discord = require('discord.js');
const client = new discord.Client();
require('discord-buttons')(client); // must be below your discord.Client()
require('discord-buttons-react')(client); // must be below your discord.Client()
```

### You absolutly need to require both discord-buttons and discord-buttons-react !

<br />

## Method
```js
message.channel.createMessageReactionButton(content, ButtonsReactionArray);
```

## Example
```js
const disbutreact = require("discord-buttons-react");

const embed = new Discord.MessageEmbed().setColor("BLURPLE").setDescription("Click to add reaction !")

const ReactionButton1 = new disbutreact.ReactionButton()
    .setStyle('red')
    .setEmoji('✨');

const ReactionButton2 = new disbutreact.ReactionButton()
    .setStyle('green')
    .setEmoji('🎉');

message.channel.createMessageReactionButton("test", [ReactionButton1, ReactionButton2]);
// or
message.channel.createMessageReactionButton(embed, [ReactionButton1, ReactionButton2]);
```
- You can put max 25 ReactionButtons.
- If you don't precise any style, it will be "grey". You can't use url style.

## New Events

### messageButtonReactionAdd
```js
client.on("messageButtonReactionAdd", reactionButton => {
    // your code
})
```
### messageButtonReactionRemove
```js
client.on("messageButtonReactionRemove", reactionButton => {
    // your code
})
```

Both events return reactionButton object :

| methods | result |
|---|---|
| clicker | .user / .member |
| reactionEmoji | emoji name or id |
| message | message object |

<br />

## Contact

[Discord](https://discord.gg/f7FdjUnvFX)