slack-web-api-client/dist/block-kit/blocks.d.ts

Streamlined Slack Web API client for TypeScript

import type { AnyMultiSelectElement, AnySelectElement, Button, Checkboxes, DateTimepicker, Datepicker, EmailInput, FileInput, ImageElement, NumberInput, Overflow, PlainTextInput, RadioButtons, RichTextInput, Timepicker, URLInput, WorkflowButton } from "./block-elements";
import type { RichTextBlock } from "./rich-text-block";
import type { AnySlackFile } from "./slack-files";
import type { PlainTextField, AnyTextField } from "./text-fields";
export type AnyBlockType = "image" | "context" | "actions" | "divider" | "section" | "input" | "file" | "header" | "video" | "rich_text";
export interface Block<T extends AnyBlockType = AnyBlockType> {
    type: T;
    block_id?: string;
}
export declare type AnyMessageBlock = ActionsBlock | ContextBlock | DividerBlock | FileBlock | HeaderBlock | ImageBlock | MessageInputBlock | SectionBlock | VideoBlock | RichTextBlock;
export declare type AnyModalBlock = ActionsBlock | ContextBlock | DividerBlock | HeaderBlock | ImageBlock | ViewInputBlock | SectionBlock | VideoBlock | RichTextBlock;
export declare type AnyHomeTabBlock = ActionsBlock | ContextBlock | DividerBlock | HeaderBlock | ImageBlock | ViewInputBlock | SectionBlock | VideoBlock | RichTextBlock;
export interface ActionsBlock extends Block<"actions"> {
    type: "actions";
    elements: (Button | WorkflowButton | Overflow | Datepicker | Timepicker | DateTimepicker | AnySelectElement | AnyMultiSelectElement | RadioButtons | Checkboxes)[];
}
export interface ContextBlock extends Block<"context"> {
    type: "context";
    elements: (ImageElement | AnyTextField)[];
}
export interface DividerBlock extends Block<"divider"> {
    type: "divider";
}
export interface FileBlock extends Block<"file"> {
    type: "file";
    source: string;
    external_id: string;
}
export interface HeaderBlock extends Block<"header"> {
    type: "header";
    text: PlainTextField;
}
export interface PublicImageBlock extends Block<"image"> {
    type: "image";
    image_url: string;
    alt_text: string;
    title?: PlainTextField;
}
export interface SlackFileImageBlock extends Block<"image"> {
    type: "image";
    slack_file: AnySlackFile;
    alt_text: string;
    title?: PlainTextField;
}
export type ImageBlock = PublicImageBlock | SlackFileImageBlock;
export interface MessageInputBlock extends Block<"input"> {
    type: "input";
    label: PlainTextField;
    hint?: PlainTextField;
    optional?: boolean;
    element: AnySelectElement | AnyMultiSelectElement | Datepicker | Timepicker | DateTimepicker | PlainTextInput | URLInput | EmailInput | NumberInput | RadioButtons | Checkboxes;
    dispatch_action?: boolean;
}
export interface ViewInputBlock extends Block<"input"> {
    type: "input";
    label: PlainTextField;
    hint?: PlainTextField;
    optional?: boolean;
    element: AnySelectElement | AnyMultiSelectElement | Datepicker | Timepicker | DateTimepicker | RichTextInput | PlainTextInput | URLInput | EmailInput | NumberInput | FileInput | RadioButtons | Checkboxes;
    dispatch_action?: boolean;
}
export interface SectionBlock extends Block<"section"> {
    type: "section";
    text?: AnyTextField;
    fields?: AnyTextField[];
    accessory?: ImageElement | Button | WorkflowButton | Overflow | Datepicker | Timepicker | AnySelectElement | AnyMultiSelectElement | RadioButtons | Checkboxes;
}
export interface VideoBlock extends Block<"video"> {
    type: "video";
    video_url: string;
    thumbnail_url: string;
    alt_text: string;
    title: PlainTextField;
    title_url?: string;
    author_name?: string;
    provider_name?: string;
    provider_icon_url?: string;
    description?: PlainTextField;
}
//# sourceMappingURL=blocks.d.ts.map