mithril-materialized/dist/toggle-button.d.ts

A materialize library for mithril.

import { FactoryComponent, Attributes, Vnode } from 'mithril';
/**
 * Attributes for the ToggleButton component.
 *
 * A toggle button is a button that can be in a checked or unchecked state.
 * It is typically used within a ToggleGroup to create button groups where
 * one or more buttons can be selected.
 */
export interface ToggleButtonAttrs extends Attributes {
    /** The value of the button. This is returned when the button is selected. */
    value: string | number;
    /** The label text to display next to the icon. */
    label?: string;
    /** The name of the Material Design icon to display. */
    iconName?: string;
    /** A custom SVG icon vnode to display instead of a Material icon. */
    icon?: Vnode<any, any>;
    /** Additional CSS class for the icon element. */
    iconClass?: string;
    /** Whether the button is in a checked/selected state. */
    checked?: boolean;
    /** Whether the button is disabled and cannot be interacted with. */
    disabled?: boolean;
    /** Optional tooltip text to display on hover. */
    tooltip?: string;
    /** Callback function invoked when the button is clicked. */
    onchange?: () => void;
}
/**
 * ToggleButton component.
 *
 * A button that can be toggled on/off. Typically used within a ToggleGroup
 * to create grouped button controls where one or more buttons can be selected.
 *
 * @example
 * ```typescript
 * m(ToggleButton, {
 *   value: 'bold',
 *   iconName: 'format_bold',
 *   checked: true,
 *   tooltip: 'Bold',
 *   onchange: () => console.log('Toggled')
 * })
 * ```
 */
export declare const ToggleButton: FactoryComponent<ToggleButtonAttrs>;