furo-ui5-checkbox-input #

@furo/ui5 v1.18.0
import '@furo/ui5/src/furo-ui5-checkbox-input.js';
exports FuroUi5CheckboxInput js
extends src/furo-ui5-checkbox-input.js
mixes FieldNodeAdapter

Summary: data checkbox input field

Description #

The ‘furo-ui5-checkbox-input’ component allows the user to switch true and false for type Bool with data binding.

It supports all features from the SAP ui5 checkbox element.

Bindable FieldNodes: bool type, furo.fat.Bool type or the google.wrapper.BoolValue type.

1
2
3

 <furo-ui5-checkbox-input
    fn-bind-data="--dao(FIELDNODE)"
 ></furo-ui5-checkbox-input>

Specificity #

1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.
2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.

supported FAT attributes #

• “readonly”:“true” set the element to readonly
• “disabled”:“true” set the element to disabled

supported meta and constraints #

• readonly: true , set the element to readonly

The constraint required will mark the element as required.

Example #

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

<furo-form-layouter four>
  <furo-ui5-checkbox-input
    fn-bind-data="--doExp(*.furo_data_checkbox_input)"
  ></furo-ui5-checkbox-input>
  <furo-ui5-checkbox-input
      value-state="Success"
      text="Override"
      fn-bind-data="--doExp(*.furo_data_checkbox_input)"
   ></furo-ui5-checkbox-input>
</furo-form-layouter>

Attributes and Properties #

Events #

change #

at-change → Boolean

Fired when the checkbox checked state changes.

furo-value-changed #

at-furo-value-changed → Boolean

Fires the field value when it changes.

Methods #

check #

check() ⟹ void

* → fn-check

Checks the checkbox and updates the value

uncheck #

uncheck() ⟹ void

* → fn-uncheck

Unhecks the checkbox and updates the value

bindData #

bindData(fieldNode FieldNode ) ⟹ void

FieldNode → fn-bind-data

Binds a FieldNode to the component.

Supported types: bool, google.protobuf.BoolValue, furo.fat.Bool

• fieldNode of type: bool, google.protobuf.BoolValue, furo.fat.Bool
  
  

readAttributes #

readAttributes() ⟹ void

* → fn-read-attributes

Reads the attributes which are set on the component dom.

onFnaFieldStateChanged #

onFnaFieldStateChanged(state `` ) ⟹ void

`` → fn-on-fna-field-state-changed

set the value state

• state