UNPKG

@kvaser/canking-api

Version:

CanKing API to communicate with the CanKing service using Node.js.

95 lines (48 loc) 1.3 kB
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / CheckboxControlProps # Interface: CheckboxControlProps Properties of the CheckboxControl React component. ## Properties ### checked > **checked**: `boolean` The current check state. *** ### disabled? > `optional` **disabled**: `boolean` Set to true to disable this control. *** ### disableTypography? > `optional` **disableTypography**: `boolean` If `true`, the label is rendered as it is passed without an additional typography node. *** ### id? > `optional` **id**: `string` The component id. *** ### label > **label**: `string` A text label to be displayed. *** ### onChange() > **onChange**: (`checked`) => `void` Callback that is called when the checked state has changed. #### Parameters ##### checked `boolean` The new checked state. #### Returns `void` *** ### size? > `optional` **size**: `"small"` \| `"medium"` The optional size, defaults to 'small'. *** ### sx? > `optional` **sx**: `SxProps`\<`Theme`\> Optional sx props. *** ### typography? > `optional` **typography**: `TypographyProps` Props applied to the Typography wrapper of the passed label. This is unused if disableTypography is true.