@patreon/studio/module/components/Toggle/index.d.ts

Patreon Studio Design System

import React from 'react';
export interface ToggleProps extends React.AriaAttributes {
    /**
     * Applies disabled styling to the tiggle.
     */
    disabled?: boolean;
    /**
     * HTML id property.
     */
    id?: string;
    /**
     * Replaces the OFF or ON text with a loading spinner. Should be on when
     * the request is awaiting response.
     */
    isLoading?: boolean;
    /**
     * Optimistic state of the control.
     */
    isOn?: boolean;
    /**
     * Callback function for a click anywhere in the toggle.
     */
    onClick?: (e: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>) => void;
}
export declare function Toggle({ disabled, id, onClick, isLoading, isOn, ...props }: ToggleProps): React.JSX.Element;