carbon-custom-elements
Version:
A Carbon Design System variant that's as easy to use as native HTML elements, with no framework tax, no framework silo.
55 lines (46 loc) • 1.01 kB
TypeScript
/**
* @license
*
* Copyright IBM Corp. 2019, 2020
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import { Component } from 'react';
interface ComponentProps {
/**
* `true` if the check box should be checked.
*/
checked?: boolean;
/**
* `true` if the check box should be disabled.
*/
disabled?: boolean;
/**
* `true` if the label should be hidden.
*/
hideLabel?: boolean;
/**
* `true` if the check box should show its UI of the indeterminate state.
*/
indeterminate?: boolean;
/**
* The label text.
*/
labelText?: string;
/**
* The form name.
*/
name?: string;
/**
* The value.
*/
value?: string;
}
/**
* Check box.
* @element bx-checkbox
* @fires bx-checkbox-changed - The custom event fired after this changebox changes its checked state.
*/
declare class BXCheckbox extends Component<ComponentProps> {}
export default BXCheckbox;