mirror of
https://github.com/flarum/framework.git
synced 2025-02-27 16:47:23 +08:00
31 lines
992 B
TypeScript
31 lines
992 B
TypeScript
/**
|
|
* The `Checkbox` component defines a checkbox input.
|
|
*
|
|
* ### Attrs
|
|
*
|
|
* - `state` Whether or not the checkbox is checked.
|
|
* - `className` The class name for the root element.
|
|
* - `disabled` Whether or not the checkbox is disabled.
|
|
* - `loading` Whether or not the checkbox is loading.
|
|
* - `onchange` A callback to run when the checkbox is checked/unchecked.
|
|
* - `children` A text label to display next to the checkbox.
|
|
*/
|
|
export default class Checkbox extends Component<import("../Component").ComponentAttrs, undefined> {
|
|
constructor();
|
|
/**
|
|
* Get the template for the checkbox's display (tick/cross icon).
|
|
*
|
|
* @return {import('mithril').Children}
|
|
* @protected
|
|
*/
|
|
protected getDisplay(): import('mithril').Children;
|
|
/**
|
|
* Run a callback when the state of the checkbox is changed.
|
|
*
|
|
* @param {boolean} checked
|
|
* @protected
|
|
*/
|
|
protected onchange(checked: boolean): void;
|
|
}
|
|
import Component from "../Component";
|