CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

ui/labeledfield/utils

@ckeditor/ckeditor5-ui/src/labeledfield/utils

module

Filtering

Constants

  • createLabeledDropdown : LabeledFieldViewCreator<DropdownView>

    See source

    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.

  • createLabeledInputNumber : LabeledFieldViewCreator<InputNumberView>

    See source

    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.

  • createLabeledInputText : LabeledFieldViewCreator<InputTextView>

    See source

    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.

  • createLabeledTextarea : LabeledFieldViewCreator<TextareaView>

    See source

    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.