jsx-slack/types/block-kit/elements/WorkflowButton.d.ts

Build JSON object for Slack Block Kit surfaces from JSX

import { WorkflowButton as WorkflowButtonElement } from '@slack/types';
import { JSXSlack } from '../../jsx';
import { ActionProps } from './utils';
export interface WorkflowButtonProps extends ActionProps {
    children: JSXSlack.ChildElements;
    /**
     * A string label for setting an accessible name of the button. This label
     * will be read out by screen readers instead of the text content of the
     * button. It must up to 75 characters.
     */
    accessibilityLabel?: string;
    /**
     * An alias to `accessibilityLabel` prop that is compatible with WAI-ARIA.
     */
    'aria-label'?: string;
    /**
     * Select the color scheme of the button from `primary` (Green button) and
     * `danger` (Red button). If not defined, the button won't be colored.
     */
    style?: 'danger' | 'primary';
    /**
     * A [workflow object](https://api.slack.com/reference/block-kit/composition-objects#workflow) that contains the
     * workflow information.
     */
    workflow: WorkflowButtonElement['workflow'];
}
/**
 * The interactive component for
 * [the `workflow_button` element](https://api.slack.com/reference/block-kit/block-elements#workflow_button).
 *
 * It can run a [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) with customizable
 * inputs. You should set the [workflow object](https://api.slack.com/reference/block-kit/composition-objects#workflow)
 * as `workflow` prop.
 *
 * @example
 * ```jsx
 * <Blocks>
 *   <Actions>
 *     <WorkflowButton
 *       actionId="action"
 *       value="value"
 *       style="primary"
 *       workflow={{
 *         trigger: {
 *           url: "https://slack.com/shortcuts/Ft0123ABC456/321...zyx",
 *           customizable_input_parameters: [
 *             {
 *               name: "input_parameter_a",
 *               value: "Value for input param A"
 *             },
 *             {
 *               name: "input_parameter_b",
 *               value: "Value for input param B"
 *             }
 *           ]
 *         }
 *       }}
 *     >
 *       Run Workflow
 *     </Button>
 *   </Actions>
 * </Blocks>
 * ```
 *
 * @return The partial JSON of a block element for the workflow button
 */
export declare const WorkflowButton: import("../../jsx-internals").BuiltInComponent<WorkflowButtonProps>;