Skip to content

Commit

Permalink
feat: Actualizar clase WelcomeLeave en README.md
Browse files Browse the repository at this point in the history 
Se actualizó la clase WelcomeLeave en el archivo README.md para utilizar el nuevo nombre de clase y los parámetros actualizados. También se ajustaron los colores y la apariencia de la tarjeta de bienvenida y salida.
  • Loading branch information
@SrGobi
SrGobi committed Oct 23, 2024
1 parent dcfc1d3 commit 22c08c6
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 135 deletions.
189 changes: 66 additions & 123 deletions Classes/WelcomeLeave.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,61 +2,53 @@

<dl>
<dt><a href="#WelcomeLeave">WelcomeLeave</a></dt>
<dd><p>Creador de tarjetas de bienvenida o despedida</p>
</dd>
<dd></dd>
</dl>

## Functions

<dl>
<dt><a href="#setAvatarEstablecer el avatar de la tarjeta">setAvatarEstablecer el avatar de la tarjeta(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd></dd>
<dt><a href="#setTituloEstablecer el título de la tarjeta">setTituloEstablecer el título de la tarjeta(value, color)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd></dd>
<dt><a href="#setSubtituloEstablecer el subtítulo de la tarjeta">setSubtituloEstablecer el subtítulo de la tarjeta(value, color)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd></dd>
<dt><a href="#setColorCircleEstablecer el color del circulo">setColorCircleEstablecer el color del circulo(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd></dd>
<dt><a href="#setColorOverlayEstablecer el color del overlay">setColorOverlayEstablecer el color del overlay(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd></dd>
<dt><a href="#setOpacityOverlayEstablecer la opacidad del overlay">setOpacityOverlayEstablecer la opacidad del overlay(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd></dd>
<dt><a href="#setBackgroundEstablecer imagen / color de fondo">setBackgroundEstablecer imagen / color de fondo(type, data)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd></dd>
<dt><a href="#setTypeOverlayEstablecer rectangle / rounded de overlay">setTypeOverlayEstablecer rectangle / rounded de overlay(type)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd></dd>
<dt><a href="#buildConstruye la tarjeta de bienvenida">buildConstruye la tarjeta de bienvenida([font])</a> ⇒ <code>Promise.&lt;Buffer&gt;</code></dt>
<dd></dd>
<dt><a href="#setAvatar">setAvatar(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd><p>Establecer el avatar de la tarjeta</p>
</dd>
<dt><a href="#setTitulo">setTitulo(value, color)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd><p>Establecer el título de la tarjeta</p>
</dd>
<dt><a href="#setSubtitulo">setSubtitulo(value, color)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd><p>Establecer el subtítulo de la tarjeta</p>
</dd>
<dt><a href="#setColorCircle">setColorCircle(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd><p>Establecer el color del circulo</p>
</dd>
<dt><a href="#setColorOverlay">setColorOverlay(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd><p>Establecer el color del overlay</p>
</dd>
<dt><a href="#setOpacityOverlay">setOpacityOverlay(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd><p>Establecer la opacidad del overlay</p>
</dd>
<dt><a href="#setBackground">setBackground(type, data)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd><p>Establecer imagen / color de fondo</p>
</dd>
<dt><a href="#setTypeOverlay">setTypeOverlay(type)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
<dd><p>Establecer rectangle / rounded de overlay</p>
</dd>
<dt><a href="#build">build([font])</a> ⇒ <code>Promise.&lt;Buffer&gt;</code></dt>
<dd><p>Construye la tarjeta de bienvenida</p>
</dd>
</dl>

<a name="WelcomeLeave"></a>

## WelcomeLeave
Creador de tarjetas de bienvenida o despedida

**Kind**: global class

* [WelcomeLeave](#WelcomeLeave)
* [new WelcomeLeave()](#new_WelcomeLeave_new)
* [.backgroundGlobal](#WelcomeLeave+backgroundGlobal)
* [.avatar](#WelcomeLeave+avatar) : <code>string</code>
* [.titulo](#WelcomeLeave+titulo) : <code>string</code>
* [.subtitulo](#WelcomeLeave+subtitulo) : <code>string</code>
* [.colorTitulo](#WelcomeLeave+colorTitulo) : <code>string</code>
* [.colorSubtitulo](#WelcomeLeave+colorSubtitulo) : <code>string</code>
* [.colorCircle](#WelcomeLeave+colorCircle) : <code>string</code>
* [.colorOverlay](#WelcomeLeave+colorOverlay) : <code>number</code> \| <code>string</code>
* [.opacityOverlay](#WelcomeLeave+opacityOverlay) : <code>string</code>
* [.typeOverlay](#WelcomeLeave+typeOverlay) : <code>string</code>

<a name="new_WelcomeLeave_new"></a>

### new WelcomeLeave()
<details open> <summary>PREVIEW</summary><br> <a> <img src="https://raw.githubusercontent.com/SrGobi/canvacard/refs/heads/test/welcome_1.png" alt="Welcome Card Preview 1"> </a> <a> <img src="https://raw.githubusercontent.com/SrGobi/canvacard/refs/heads/test/welcome_2.png" alt="Welcome Card Preview 2"> </a> <a> <img src="https://raw.githubusercontent.com/SrGobi/canvacard/refs/heads/test/welcome_3.png" alt="Welcome Card Preview 3"> </a> <a> <img src="https://raw.githubusercontent.com/SrGobi/canvacard/refs/heads/test/welcome_4.png" alt="Welcome Card Preview 4"> </a></details>
Creador de tarjetas de bienvenida o despedida

**Example**
```js
const welcome = new canvacard.Welcomer()
const welcome = new canvacard.WelcomeLeave()
.setAvatar(data.avatarURL)
.setBackground('COLOR', '#000000')
.setTitulo("Titulo de la Tarjeta👋", '#FFFFFF')
Expand All @@ -67,76 +59,11 @@ Creador de tarjetas de bienvenida o despedida
.setTypeOverlay('ROUNDED');
const welcomeImage = await welcome.build("Suravaram");
canvacard.write(welcomeImage, "./welcomer.png");```
<a name="WelcomeLeave+backgroundGlobal"></a>
<a name="setAvatar"></a>
### welcomeLeave.backgroundGlobal
Fondo de la tarjeta
**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| backgroundGlobal | <code>object</code> | | Fondo de la tarjeta |
| [backgroundGlobal.type] | <code>&quot;IMAGE&quot;</code> \| <code>&quot;COLOR&quot;</code> | <code>&quot;color&quot;</code> | Tipo de fondo |
## setAvatar(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
Establecer el avatar de la tarjeta
<a name="WelcomeLeave+avatar"></a>
### welcomeLeave.avatar : <code>string</code>
Avatar de la tarjeta
**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)
<a name="WelcomeLeave+titulo"></a>
### welcomeLeave.titulo : <code>string</code>
Título creado con Canvacard
**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)
<a name="WelcomeLeave+subtitulo"></a>
### welcomeLeave.subtitulo : <code>string</code>
Subtítulo creado con Canvacard
**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)
<a name="WelcomeLeave+colorTitulo"></a>
### welcomeLeave.colorTitulo : <code>string</code>
Color del título creado con Canvacard
**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)
<a name="WelcomeLeave+colorSubtitulo"></a>
### welcomeLeave.colorSubtitulo : <code>string</code>
Color del Subtítulo creado con Canvacard
**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)
<a name="WelcomeLeave+colorCircle"></a>
### welcomeLeave.colorCircle : <code>string</code>
Color del circulo
**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)
<a name="WelcomeLeave+colorOverlay"></a>
### welcomeLeave.colorOverlay : <code>number</code> \| <code>string</code>
Color del overlay
**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)
<a name="WelcomeLeave+opacityOverlay"></a>
### welcomeLeave.opacityOverlay : <code>string</code>
Opacidad del overlay
**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)
<a name="WelcomeLeave+typeOverlay"></a>
### welcomeLeave.typeOverlay : <code>string</code>
Tipo de overlay
**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)
<a name="setAvatarEstablecer el avatar de la tarjeta"></a>
## setAvatarEstablecer el avatar de la tarjeta(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
**Kind**: global function
**Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave
**Throws**:
Expand All @@ -148,9 +75,11 @@ Tipo de overlay
| --- | --- | --- |
| value | <code>string</code> \| <code>Buffer</code> | URL de la imagen o Buffer de la imagen |
<a name="setTituloEstablecer el título de la tarjeta"></a>
<a name="setTitulo"></a>
## setTitulo(value, color) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
Establecer el título de la tarjeta
## setTituloEstablecer el título de la tarjeta(value, color) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
**Kind**: global function
**Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave
**Throws**:
Expand All @@ -163,9 +92,11 @@ Tipo de overlay
| value | <code>string</code> | Valor del título |
| color | <code>string</code> | Código de color HTML5 "#000000" |
<a name="setSubtituloEstablecer el subtítulo de la tarjeta"></a>
<a name="setSubtitulo"></a>
## setSubtitulo(value, color) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
Establecer el subtítulo de la tarjeta
## setSubtituloEstablecer el subtítulo de la tarjeta(value, color) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
**Kind**: global function
**Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave
**Throws**:
Expand All @@ -178,9 +109,11 @@ Tipo de overlay
| value | <code>string</code> | Valor del subtítulo |
| color | <code>string</code> | Código de color HTML5 "#000000" |
<a name="setColorCircleEstablecer el color del circulo"></a>
<a name="setColorCircle"></a>
## setColorCircle(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
Establecer el color del circulo
## setColorCircleEstablecer el color del circulo(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
**Kind**: global function
**Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave
**Throws**:
Expand All @@ -192,9 +125,11 @@ Tipo de overlay
| --- | --- | --- |
| value | <code>string</code> | Código de color HTML5 "#000000" |
<a name="setColorOverlayEstablecer el color del overlay"></a>
<a name="setColorOverlay"></a>
## setColorOverlay(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
Establecer el color del overlay
## setColorOverlayEstablecer el color del overlay(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
**Kind**: global function
**Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave
**Throws**:
Expand All @@ -206,9 +141,11 @@ Tipo de overlay
| --- | --- | --- |
| value | <code>string</code> | Código de color HTML5 "#000000" |
<a name="setOpacityOverlayEstablecer la opacidad del overlay"></a>
<a name="setOpacityOverlay"></a>
## setOpacityOverlay(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
Establecer la opacidad del overlay
## setOpacityOverlayEstablecer la opacidad del overlay(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
**Kind**: global function
**Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave
**Throws**:
Expand All @@ -220,9 +157,11 @@ Tipo de overlay
| --- | --- | --- |
| value | <code>number</code> | Valor de 0 a 1 para la opacidad |
<a name="setBackgroundEstablecer imagen / color de fondo"></a>
<a name="setBackground"></a>
## setBackground(type, data) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
Establecer imagen / color de fondo
## setBackgroundEstablecer imagen / color de fondo(type, data) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
**Kind**: global function
**Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave
**Throws**:
Expand All @@ -235,9 +174,11 @@ Tipo de overlay
| type | <code>&quot;COLOR&quot;</code> \| <code>&quot;IMAGE&quot;</code> | Tipo de fondo |
| data | <code>string</code> | URL de la imagen o código de color HTML |
<a name="setTypeOverlayEstablecer rectangle / rounded de overlay"></a>
<a name="setTypeOverlay"></a>
## setTypeOverlay(type) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
Establecer rectangle / rounded de overlay
## setTypeOverlayEstablecer rectangle / rounded de overlay(type) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
**Kind**: global function
**Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave
**Throws**:
Expand All @@ -249,9 +190,11 @@ Tipo de overlay
| --- | --- | --- |
| type | <code>&quot;RECTANGLE&quot;</code> \| <code>&quot;ROUNDED&quot;</code> | Tipo de fondo |
<a name="buildConstruye la tarjeta de bienvenida"></a>
<a name="build"></a>
## build([font]) ⇒ <code>Promise.&lt;Buffer&gt;</code>
Construye la tarjeta de bienvenida
## buildConstruye la tarjeta de bienvenida([font]) ⇒ <code>Promise.&lt;Buffer&gt;</code>
**Kind**: global function
**Returns**: <code>Promise.&lt;Buffer&gt;</code> - Imagen de la tarjeta de bienvenida en formato de buffer
**Throws**:
Expand All @@ -261,5 +204,5 @@ Tipo de overlay
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [font] | <code>string</code> | <code>&quot;\&quot;Arial\&quot;&quot;</code> | Fuente de texto para la tarjeta |
| [font] | <code>string</code> | <code>&quot;Arial&quot;</code> | Fuente de texto para la tarjeta |
Expand Down
21 changes: 9 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,25 +93,22 @@ rank.build("Cascadia Code PL")
</a>
</details>

## [Welcomer Card](https://canvacard.srgobi.com/classes/welcomer)
## [WelcomeLeave Card](https://canvacard.srgobi.com/classes/welcomeleave)

```js
const canvacard = require("canvacard");
const img = "https://cdn.discordapp.com/embed/avatars/0.png";
const background = "https://i.imgur.com/5O7xmVe.png";

const welcomer = new canvacard.Welcomer()
const welcomer = new canvacard.WelcomeLeave()
.setAvatar(img)
.setBackground('IMAGE', background)
.setTitulo("WELCOME")
.setSubtitulo("Subtitulo personalizable!")
.setTitulo("Titulo personalizable!")
.setSubtitulo("Subtitulo personalizable!")
.setColorTitulo("#FFFFFF");
.setColorSubtitulo("#5865f2");
.setColorCircle("#FFFFFF");
.setColorOverlay("#000000");
.setOpacityOverlay("0.4");
.setBackground('COLOR', '#000000')
.setTitulo("Titulo de la Tarjeta👋", '#FFFFFF')
.setSubtitulo("Subtitulo de la Tarjeta 👋", '#FFFFFF')
.setOpacityOverlay(1)
.setColorCircle('#FFFFFF')
.setColorOverlay('#5865F2')
.setTypeOverlay('ROUNDED');

welcomer.build("Cascadia Code PL, Noto Color Emoji")
.then(data => {
Expand Down

0 comments on commit 22c08c6

Please sign in to comment.