Welcome And Leave

Welcome and leave card builder

```js new canvafy.WelcomeLeave() ```

METHODS
* [build](#build) * [setAvatar](#set-avatar) * [setAvatarBorder](#set-avatar-border) * [setBackground](#set-background) * [setBorder](#set-border) * [setDescription](#set-description) * [setOverlayOpacity](#set-overlay-opacity) * [setTitle](#set-title)

.build([options])

Build the welcome/leave card

Scope: `ASYNC` PARAMETER | TYPE | DESCRIPTION --- | --- | --- options | [BuildOptions](https://github.com/squarfiuz/canvafy/tree/main/docs/typedef/BuildOptions.md) | Build options Returns: [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\

.setAvatar(image)

Set the user avatar

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- image | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) - [Buffer](https://developer.mozilla.org/en-US/docs/Glossary/buffer) - [Canvas.Image](https://www.tabnine.com/code/javascript/functions/canvas/loadImage) | Avatar image | https://someimage.com/avatar.png Returns: [WelcomeLeave](#welcome-leave)

.setAvatarBorder(color)

Set the avatar's border color

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color | #2a2e35 Returns: [WelcomeLeave](#welcome-leave)

.setBackground(type, value)

Set the background color/image

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- type | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Type between 'color' and 'background | background value | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) - [Buffer](https://developer.mozilla.org/en-US/docs/Glossary/buffer) - [Canvas.Image](https://www.tabnine.com/code/javascript/functions/canvas/loadImage) | Background or hexadecimal color | https://someimage.com/background.png / #ff5555 Returns: [WelcomeLeave](#welcome-leave)

.setBorder(color)

Set the border color

.setDescription(text, [color])

Set the card's description

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- text | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Description of the card | Welcome to you! color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color | #a7b9c5 Returns: [WelcomeLeave](#welcome-leave)

.setOverlayOpacity(opacity)

Set the card's description

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- opacity | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | Number between 0 and 1 (0 and 1 included) | 0 Returns: [WelcomeLeave](#welcome-leave)

.setTitle(text, [color])

Set the card's title

PARAMETER | TYPE | DESCRIPTION | EXAMPLE --- | --- | --- | --- text | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Title of the card | Welcome color | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Hexadecimal color | #fff Returns: [WelcomeLeave](#welcome-leave)