Skip to content

Commit

Permalink
Update from discord-net/Discord.Net@787a913
Browse files Browse the repository at this point in the history
  • Loading branch information
discord-net committed Apr 2, 2024
1 parent 326c78a commit 8a7e960
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 14 deletions.
61 changes: 48 additions & 13 deletions docs/guides/int_basics/message-components/buttons-in-depth.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<meta property="og:description" content="There are many changes you can make to buttons, lets take a look at the parameters in the WithButton function&quot;
| Name | Type | Description |
|..."><meta property="og:title" content="Buttons in Depth | Discord.Net Documentation "><meta property="og:site_name" content="Discord.Net Docs"><meta name="theme-color" content="#995EA7"><meta property="og:image" content="https://raw.githubusercontent.com/Discord-Net/Discord.Net/dev/docs/marketing/logo/PackageLogo.png"></head>
<meta property="og:description" content="There are many changes you can make to buttons, lets take a look at the parameters in the WithButton function."><meta property="og:title" content="Buttons in Depth | Discord.Net Documentation "><meta property="og:site_name" content="Discord.Net Docs"><meta name="theme-color" content="#995EA7"><meta property="og:image" content="https://raw.githubusercontent.com/Discord-Net/Discord.Net/dev/docs/marketing/logo/PackageLogo.png"></head>

<script type="module" src="./../../../public/docfx.min.js"></script>

Expand Down Expand Up @@ -89,16 +87,53 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<article data-uid="Guides.MessageComponents.Buttons">
<h1 id="buttons-in-depth">Buttons in depth</h1>

<p>There are many changes you can make to buttons, lets take a look at the parameters in the <code>WithButton</code> function&quot;
| Name | Type | Description |
|----------|---------------|----------------------------------------------------------------|
| label | <code>string</code> | The label text for the button. |
| customId | <code>string</code> | The custom id of the button. |
| style | <code>ButtonStyle</code> | The style of the button. |
| emote | <code>IEmote</code> | A IEmote to be used with this button. |
| url | <code>string</code> | A URL to be used only if the <code>ButtonStyle</code> is a Link. |
| disabled | <code>bool</code> | Whether or not the button is disabled. |
| row | <code>int</code> | The row to place the button if it has enough room, otherwise 0 |</p>
<p>There are many changes you can make to buttons, lets take a look at the parameters in the <code>WithButton</code> function.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>label</td>
<td><code>string</code></td>
<td>The label text for the button.</td>
</tr>
<tr>
<td>customId</td>
<td><code>string</code></td>
<td>The custom id of the button.</td>
</tr>
<tr>
<td>style</td>
<td><code>ButtonStyle</code></td>
<td>The style of the button.</td>
</tr>
<tr>
<td>emote</td>
<td><code>IEmote</code></td>
<td>A IEmote to be used with this button.</td>
</tr>
<tr>
<td>url</td>
<td><code>string</code></td>
<td>A URL to be used only if the <code>ButtonStyle</code> is a Link.</td>
</tr>
<tr>
<td>disabled</td>
<td><code>bool</code></td>
<td>Whether or not the button is disabled.</td>
</tr>
<tr>
<td>row</td>
<td><code>int</code></td>
<td>The row to place the button if it has enough room, otherwise 0</td>
</tr>
</tbody>
</table>
<h3 id="label">Label</h3>
<p>This is the front facing text that the user sees. The maximum length is 80 characters.</p>
<h3 id="customid">CustomId</h3>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4547,7 +4547,7 @@
"guides/int_basics/message-components/buttons-in-depth.html": {
"href": "guides/int_basics/message-components/buttons-in-depth.html",
"title": "Buttons in Depth | Discord.Net Documentation",
"keywords": "Buttons in depth There are many changes you can make to buttons, lets take a look at the parameters in the WithButton function\" | Name | Type | Description | |----------|---------------|----------------------------------------------------------------| | label | string | The label text for the button. | | customId | string | The custom id of the button. | | style | ButtonStyle | The style of the button. | | emote | IEmote | A IEmote to be used with this button. | | url | string | A URL to be used only if the ButtonStyle is a Link. | | disabled | bool | Whether or not the button is disabled. | | row | int | The row to place the button if it has enough room, otherwise 0 | Label This is the front facing text that the user sees. The maximum length is 80 characters. CustomId This is the property sent to you by discord when a button is clicked. It is not required for link buttons as they do not emit an event. The maximum length is 100 characters. Style Styling your buttons are important for indicating different actions: You can do this by using the ButtonStyle which has all the styles defined. Emote You can specify an IEmote when creating buttons to add them to your button. They have the same restrictions as putting guild based emotes in messages. Url If you use the link style with your button you can specify a url. When this button is clicked the user is taken to that url. Disabled You can specify if your button is disabled, meaning users won't be able to click on it."
"keywords": "Buttons in depth There are many changes you can make to buttons, lets take a look at the parameters in the WithButton function. Name Type Description label string The label text for the button. customId string The custom id of the button. style ButtonStyle The style of the button. emote IEmote A IEmote to be used with this button. url string A URL to be used only if the ButtonStyle is a Link. disabled bool Whether or not the button is disabled. row int The row to place the button if it has enough room, otherwise 0 Label This is the front facing text that the user sees. The maximum length is 80 characters. CustomId This is the property sent to you by discord when a button is clicked. It is not required for link buttons as they do not emit an event. The maximum length is 100 characters. Style Styling your buttons are important for indicating different actions: You can do this by using the ButtonStyle which has all the styles defined. Emote You can specify an IEmote when creating buttons to add them to your button. They have the same restrictions as putting guild based emotes in messages. Url If you use the link style with your button you can specify a url. When this button is clicked the user is taken to that url. Disabled You can specify if your button is disabled, meaning users won't be able to click on it."
},
"guides/int_basics/message-components/intro.html": {
"href": "guides/int_basics/message-components/intro.html",
Expand Down

0 comments on commit 8a7e960

Please sign in to comment.