@patreon/studio/module/components/ActionBar/types.d.ts

Patreon Studio Design System

import type { Action } from '../../types/actions';
import type { IconComponent } from '../Icon/types';
export declare type MessageDisplayStyle = 'default' | 'hide-mobile';
export interface ActionBarProps {
    /**
     * The action a user needs to take in order for the action bar to be dismissed, represented by
     * a button on the right of the bar.
     */
    action: Omit<Action, 'variant'>;
    /**
     * The secondary action a user needs to take, represented by a button to the left of the action button.
     */
    secondaryAction?: Action;
    /**
     * Tag for testing.
     */
    'data-tag'?: string;
    /**
     * HTML id attribute.
     */
    id?: string;
    /**
     * Icon to display in the action bar.
     */
    icon?: IconComponent;
    /**
     * The message display style.
     */
    messageDisplay?: MessageDisplayStyle;
    /**
     * content of the action bar message.
     */
    children: React.ReactNode;
}