ui/labeledfield/utils

Constants

• createLabeledDropdown : LabeledFieldViewCreator<DropdownView>

  module:ui/labeledfield/utils~createLabeledDropdown

  A helper for creating labeled dropdowns.

  It creates an instance of a dropdown that is logically related to a labeled field view.

  The helper does the following:

  • It sets dropdown's id and ariaDescribedById attributes.
  • It binds input's isEnabled to the labeled view.

  Usage:

  const labeledInputView = new LabeledFieldView( locale, createLabeledDropdown );
  console.log( labeledInputView.fieldView ); // A dropdown instance.
  

  Copy code

  See source (with github icon)

• createLabeledInputNumber : LabeledFieldViewCreator<InputNumberView>

  module:ui/labeledfield/utils~createLabeledInputNumber

  A helper for creating labeled number inputs.

  It creates an instance of a input number that is logically related to a labeled view in DOM.

  The helper does the following:

  • It sets input's id and ariaDescribedById attributes.
  • It binds input's isReadOnly to the labeled view.
  • It binds input's hasError to the labeled view.
  • It enables a logic that cleans up the error when user starts typing in the input.

  Usage:

  const labeledInputView = new LabeledFieldView( locale, createLabeledInputNumber );
  console.log( labeledInputView.fieldView ); // A number input instance.
  

  Copy code

  See source (with github icon)

• createLabeledInputText : LabeledFieldViewCreator<InputTextView>

  module:ui/labeledfield/utils~createLabeledInputText

  A helper for creating labeled inputs.

  It creates an instance of a input text that is logically related to a labeled view in DOM.

  The helper does the following:

  • It sets input's id and ariaDescribedById attributes.
  • It binds input's isReadOnly to the labeled view.
  • It binds input's hasError to the labeled view.
  • It enables a logic that cleans up the error when user starts typing in the input.

  Usage:

  const labeledInputView = new LabeledFieldView( locale, createLabeledInputText );
  console.log( labeledInputView.fieldView ); // A text input instance.
  

  Copy code

  See source (with github icon)

• createLabeledTextarea : LabeledFieldViewCreator<TextareaView>

  module:ui/labeledfield/utils~createLabeledTextarea

  A helper for creating labeled textarea.

  It creates an instance of a textarea that is logically related to a labeled view in DOM.

  The helper does the following:

  • It sets textarea's id and ariaDescribedById attributes.
  • It binds textarea's isReadOnly to the labeled view.
  • It binds textarea's hasError to the labeled view.
  • It enables a logic that cleans up the error when user starts typing in the textarea.

  Usage:

  const labeledTextarea = new LabeledFieldView( locale, createLabeledTextarea );
  console.log( labeledTextarea.fieldView ); // A textarea instance.
  

  Copy code

  See source (with github icon)