Add rich text types

slackapi · Sep 26, 2023 · b374882 · b374882
1 parent d0b04a0
commit b374882
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/packages/types/src/block-kit/block-elements.ts b/packages/types/src/block-kit/block-elements.ts
@@ -673,3 +673,10 @@ export interface WorkflowButton extends Confirmable {
    */
   accessibility_label?: string;
 }
+
+export interface RichTextInput extends Action, Dispatchable, Focusable, Placeholdable {
+  type: 'rich_text_input';
+  initial_value?: RichTextBlock;
+  dispatch_action_config?: DispatchActionConfig;
+  focus_on_load?: boolean;
+}
diff --git a/packages/types/src/block-kit/blocks.ts b/packages/types/src/block-kit/blocks.ts
@@ -1,7 +1,7 @@
 // This file contains objects documented here: https://api.slack.com/reference/block-kit/blocks
 
 import { PlainTextElement, MrkdwnElement } from './composition-objects';
-import { Button, Checkboxes, Datepicker, DateTimepicker, EmailInput, ImageElement, MultiSelect, NumberInput, Overflow, PlainTextInput, RadioButtons, Select, Timepicker, URLInput, WorkflowButton } from './block-elements';
+import { Button, Checkboxes, Datepicker, DateTimepicker, EmailInput, ImageElement, MultiSelect, NumberInput, Overflow, PlainTextInput, RadioButtons, Select, Timepicker, URLInput, WorkflowButton, RichTextInput } from './block-elements';
 import { Action } from './extensions';
 
 export interface Block {
@@ -17,7 +17,7 @@ export interface Block {
 }
 
 export type KnownBlock = ImageBlock | ContextBlock | ActionsBlock | DividerBlock |
-SectionBlock | InputBlock | FileBlock | HeaderBlock | VideoBlock;
+SectionBlock | InputBlock | FileBlock | HeaderBlock | VideoBlock | RichTextBlock;
 
 /**
  * @description Holds multiple interactive elements.
@@ -28,13 +28,12 @@ export interface ActionsBlock extends Block {
    * @description The type of block. For an actions block, `type` is always `actions`.
    */
   type: 'actions';
-  // TODO: add rich text input to this list once ready
   /**
    * @description An array of {@link InteractiveElements} objects.
    * There is a maximum of 25 elements in each action block.
    */
   elements: (Button | Checkboxes | Datepicker | DateTimepicker | MultiSelect | Overflow | RadioButtons | Select |
-  Timepicker | WorkflowButton)[];
+  Timepicker | WorkflowButton | RichTextInput)[];
 }
 
 /**
@@ -260,3 +259,11 @@ export interface VideoBlock extends Block {
    */
   description?: PlainTextElement;
 }
+
+export interface RichTextBlock extends Block {
+  type: 'rich_text',
+  elements: {
+    type: 'rich_text_section' | 'rich_text_list' | 'rich_text_quote' | 'rich_text_performatted';
+    elements: object[];
+  }[];
+}