Skip to content

Commit

Permalink
feat: new functions/props
Browse files Browse the repository at this point in the history
  • Loading branch information
@FedeIlLeone
FedeIlLeone committed Oct 12, 2023
1 parent 9818e76 commit 8caaa51
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
1 change: 1 addition & 0 deletions docs/plugins/modules/common/stores/channels.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import RequiredNotice from "@site/src/components/RequiredNotice.mdx";
| `getBasicChannel` | <Required /> `channelId`: string | <APIReferences.Channel /> \| undefined | Gets the basic channel by its id |
| `getChannel` | <Required /> `channelId`: string | <APIReferences.Channel /> \| undefined | Gets the channel by its id |
| `getChannelId` | `guildId`: string <br /> `fallbackToDefault`: boolean | string \| undefined | Gets the current selected channel id |
| `getChannelIds` | `guildId`: string | string[] | Gets all channel ids |
| `getCurrentlySelectedChannelId` | `guildId`: string | string \| undefined | Gets the current selected channel id |
| `getDMFromUserId` | <Required /> `userId`: string | string \| undefined | Gets the DM channel id by its user id |
| `getDMUserIds` | | string[] | Gets all DM channel ids |
Expand Down
1 change: 1 addition & 0 deletions docs/plugins/modules/common/stores/messages.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ import RequiredNotice from "@site/src/components/RequiredNotice.mdx";
| `sendActivityBookmark` | <Required /> `channelId`: string <br /> <Required /> `activityDetails`: string <br /> `analyticsTriggeredFrom`: string <br /> `suggestedInvite`: [`InviteSuggestion`](#InviteSuggestion) | Promise<[`HTTPResponse`](../utilities/api#HTTPResponse)&nbsp;\|&nbsp;void> | Sends an activity bookmark |
| `sendBotMessage` | <Required /> `channelId`: string <br /> <Required /> `content`: string <br /> `messageName`: string | void | Clyde sends a custom message |
| `sendClydeError` | <Required /> `channelId`: string <br /> `code`: number | void | Clyde sends an error message |
| `sendClydeProfileOverride` | <Required /> `channelId`: string <br /> <Required /> `clydeProfileURL`: string <br /> `analyticsTriggeredFrom`: string <br /> `suggestedInvite`: [`InviteSuggestion`](#InviteSuggestion) | Promise<[`HTTPResponse`](../utilities/api#HTTPResponse)&nbsp;\|&nbsp;void> | Sends a Clyde profile override |
| `sendGreetMessage` | <Required /> `channelId`: string <br /> <Required /> `stickerId`: string <br /> `options`: [`MessageGreetOptions`](#MessageGreetOptions) | Promise<[`HTTPResponse`](../utilities/api#HTTPResponse)&nbsp;\|&nbsp;void> | Sends a greet message |
| `sendInvite` | <Required /> `channelId`: string <br /> <Required /> `inviteCode`: string <br /> `analyticsTriggeredFrom`: string <br /> `suggestedInvite`: [`InviteSuggestion`](#InviteSuggestion) | Promise<[`HTTPResponse`](../utilities/api#HTTPResponse)&nbsp;\|&nbsp;void> | Sends an invite |
| `sendMessage` | <Required /> `channelId`: string <br /> <Required /> `message`: [`OutgoingMessage`](#OutgoingMessage) <br /> `promise`: boolean <br /> `options`: [`OutgoingMessageOptions`](#OutgoingMessageOptions) | Promise<[`HTTPResponse`](../utilities/api#HTTPResponse)&nbsp;\|&nbsp;void> | Sends a message |
Expand Down
19 changes: 10 additions & 9 deletions docs/plugins/modules/components/Modal.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,13 @@ The props of this component extend the attributes of the `div` element.

:::

| Name | Type | Default | Description |
| -------------------- | ---------- | -------- | ----------------------------------------------------------- |
| `className` | string | | Component class name |
| `fullscreenOnMobile` | boolean | `true` | Whether the modal is in fullscreen if app is in mobile view |
| `hideShadow` | boolean | `false` | Whether the shadow is hidden |
| `onAnimationEnd` | (): string | | Function ran when the modal stopped animating |
| `role` | string | `dialog` | Modal element role |
| `size` | string | `small` | Modal size |
| `transitionState` | string | | Modal state |
| Name | Type | Default | Description |
| -------------------- | ------------- | -------- | ----------------------------------------------------------- |
| `className` | string | | Component class name |
| `fullscreenOnMobile` | boolean | `true` | Whether the modal is in fullscreen if app is in mobile view |
| `hideShadow` | boolean | `false` | Whether the shadow is hidden |
| `onAnimationEnd` | (): string | | Function ran when the modal stopped animating |
| `returnRef` | Ref<unknown\> | | Returned ref |
| `role` | string | `dialog` | Modal element role |
| `size` | string | `small` | Modal size |
| `transitionState` | string | | Modal state |

0 comments on commit 8caaa51

Please sign in to comment.