From 8caaa5141be3ff8c2728127e0434d67e42ae4fa6 Mon Sep 17 00:00:00 2001 From: Federico <38290480+FedeIlLeone@users.noreply.github.com> Date: Thu, 12 Oct 2023 19:27:35 +0200 Subject: [PATCH] feat: new functions/props --- .../modules/common/stores/channels.mdx | 1 + .../modules/common/stores/messages.mdx | 1 + docs/plugins/modules/components/Modal.mdx | 19 ++++++++++--------- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/plugins/modules/common/stores/channels.mdx b/docs/plugins/modules/common/stores/channels.mdx index eaf82dc..debbeee 100644 --- a/docs/plugins/modules/common/stores/channels.mdx +++ b/docs/plugins/modules/common/stores/channels.mdx @@ -16,6 +16,7 @@ import RequiredNotice from "@site/src/components/RequiredNotice.mdx"; | `getBasicChannel` | `channelId`: string | \| undefined | Gets the basic channel by its id | | `getChannel` | `channelId`: string | \| undefined | Gets the channel by its id | | `getChannelId` | `guildId`: string
`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` | `userId`: string | string \| undefined | Gets the DM channel id by its user id | | `getDMUserIds` | | string[] | Gets all DM channel ids | diff --git a/docs/plugins/modules/common/stores/messages.mdx b/docs/plugins/modules/common/stores/messages.mdx index cd60230..f68b6bb 100644 --- a/docs/plugins/modules/common/stores/messages.mdx +++ b/docs/plugins/modules/common/stores/messages.mdx @@ -37,6 +37,7 @@ import RequiredNotice from "@site/src/components/RequiredNotice.mdx"; | `sendActivityBookmark` | `channelId`: string
`activityDetails`: string
`analyticsTriggeredFrom`: string
`suggestedInvite`: [`InviteSuggestion`](#InviteSuggestion) | Promise<[`HTTPResponse`](../utilities/api#HTTPResponse) \| void> | Sends an activity bookmark | | `sendBotMessage` | `channelId`: string
`content`: string
`messageName`: string | void | Clyde sends a custom message | | `sendClydeError` | `channelId`: string
`code`: number | void | Clyde sends an error message | +| `sendClydeProfileOverride` | `channelId`: string
`clydeProfileURL`: string
`analyticsTriggeredFrom`: string
`suggestedInvite`: [`InviteSuggestion`](#InviteSuggestion) | Promise<[`HTTPResponse`](../utilities/api#HTTPResponse) \| void> | Sends a Clyde profile override | | `sendGreetMessage` | `channelId`: string
`stickerId`: string
`options`: [`MessageGreetOptions`](#MessageGreetOptions) | Promise<[`HTTPResponse`](../utilities/api#HTTPResponse) \| void> | Sends a greet message | | `sendInvite` | `channelId`: string
`inviteCode`: string
`analyticsTriggeredFrom`: string
`suggestedInvite`: [`InviteSuggestion`](#InviteSuggestion) | Promise<[`HTTPResponse`](../utilities/api#HTTPResponse) \| void> | Sends an invite | | `sendMessage` | `channelId`: string
`message`: [`OutgoingMessage`](#OutgoingMessage)
`promise`: boolean
`options`: [`OutgoingMessageOptions`](#OutgoingMessageOptions) | Promise<[`HTTPResponse`](../utilities/api#HTTPResponse) \| void> | Sends a message | diff --git a/docs/plugins/modules/components/Modal.mdx b/docs/plugins/modules/components/Modal.mdx index 505fe96..2f54025 100644 --- a/docs/plugins/modules/components/Modal.mdx +++ b/docs/plugins/modules/components/Modal.mdx @@ -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 | | Returned ref | +| `role` | string | `dialog` | Modal element role | +| `size` | string | `small` | Modal size | +| `transitionState` | string | | Modal state |