UNPKG

@kvaser/canking-api

Version:

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

135 lines (68 loc) 2.07 kB
[**Kvaser CanKing GUI Extensions SDK v7.5.1**](../../README.md) *** [Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / SelectControlProps # Interface: SelectControlProps Properties of the SelectControl React component. ## Properties ### disabled? > `optional` **disabled**: `boolean` Set to true to disable this control. *** ### fullWidth? > `optional` **fullWidth**: `boolean` Set to true to expand this control to use the full width of its parent. *** ### helperText? > `optional` **helperText**: `string` A helper text that will be displayed underneath the select control. *** ### id > **id**: `string` The component id. *** ### label > **label**: `string` A label text that will be displayed in front of the select control. *** ### margin? > `optional` **margin**: `"none"` \| `"normal"` \| `"dense"` Margins between controls inside this control. *** ### minWidth? > `optional` **minWidth**: `string` \| `number` The min width of this control. *** ### onChange() > **onChange**: (`value`) => `void` Callback that will be called when a new option has been selected. #### Parameters ##### value The new selected value. `number` | `""` #### Returns `void` *** ### options > **options**: [`SelectOption`](../type-aliases/SelectOption.md)[] \| `Map`\<`string`, [`SelectOption`](../type-aliases/SelectOption.md)[]\> The options to be available inside the select control. *** ### prefixTextWithValue? > `optional` **prefixTextWithValue**: `boolean` Set to true to display each option as '<value> - <displayText>', otherwise each option will be displayed with its displayText only. *** ### required? > `optional` **required**: `boolean` Set to true if the value of this control is required. *** ### showLabel? > `optional` **showLabel**: `boolean` Set to true to display the label. *** ### size? > `optional` **size**: `"small"` \| `"medium"` The component size. *** ### value > **value**: `number` \| `""` Value of the selected option or '' if no option has been selected.