UNPKG

@aurigma/ui-framework

Version:

A platform which allows building print product personalization editors based on Aurigma's Customer's Canvas.

95 lines (51 loc) 1.56 kB
# Interface: ICheckboxConfig Provides properties for a [checkbox](../classes/auwidgetcheckbox.md). ## Hierarchy * IMetadataConfig ↳ **ICheckboxConfig** ## Index ### Properties * [autoReset](icheckboxconfig.md#optional-autoreset) * [checkboxIcon](icheckboxconfig.md#optional-checkboxicon) * [disabled](icheckboxconfig.md#optional-disabled) * [enabled](icheckboxconfig.md#optional-enabled) * [onChange](icheckboxconfig.md#optional-onchange) * [prompt](icheckboxconfig.md#prompt) * [showValueInTitle](icheckboxconfig.md#optional-showvalueintitle) * [tooltipIcon](icheckboxconfig.md#optional-tooltipicon) * [value](icheckboxconfig.md#value) ## Properties ### `Optional` autoReset**autoReset**? : *boolean* If `true`, set false as value when step with checkbox displaying twice or more ___ ### `Optional` checkboxIcon • **checkboxIcon**? : *string* ___ ### `Optional` disabled**disabled**? : *boolean* *Inherited from void* ___ ### `Optional` enabled • **enabled**? : *boolean* If `true`, displays the checkbox. ___ ### `Optional` onChange**onChange**? : *Function | Function[]* A function that is executed after changing a checkbox value. ___ ### prompt • **prompt**: *string* A text message associated with the checkbox. ___ ### `Optional` showValueInTitle**showValueInTitle**? : *boolean* *Inherited from void* ___ ### `Optional` tooltipIcon • **tooltipIcon**? : *string* *Inherited from void* ___ ### value**value**: *boolean* This value is `true` if the checkbox is selected.