ui/labeledfield/utils
@ckeditor/ckeditor5-ui/src/labeledfield/utils
Filtering
Functions
-
createLabeledDropdown( labeledFieldView, viewUid, statusUid ) → defaultmodule:ui/labeledfield/utils~createLabeledDropdownA 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
idandariaDescribedByIdattributes. - It binds input's
isEnabledto the labeled view.
Usage:
const labeledInputView = new LabeledFieldView( locale, createLabeledDropdown ); console.log( labeledInputView.fieldView ); // A dropdown instance.Parameters
labeledFieldView : LabeledFieldView<FocusableView>The instance of the labeled field view.
viewUid : stringA UID string that allows DOM logical connection between the labeled view label and the dropdown.
statusUid : stringA UID string that allows DOM logical connection between the labeled view status and the dropdown.
Returns
defaultThe dropdown view instance.
- It sets dropdown's
-
createLabeledInputNumber( labeledFieldView, viewUid, statusUid ) → InputNumberViewmodule:ui/labeledfield/utils~createLabeledInputNumberA 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
idandariaDescribedByIdattributes. - It binds input's
isReadOnlyto the labeled view. - It binds input's
hasErrorto 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.Parameters
labeledFieldView : LabeledFieldView<FocusableView>The instance of the labeled field view.
viewUid : stringA UID string that allows DOM logical connection between the labeled view's label and the input.
statusUid : stringA UID string that allows DOM logical connection between the labeled view's status and the input.
Returns
InputNumberViewThe input number view instance.
- It sets input's
-
createLabeledInputText( labeledFieldView, viewUid, statusUid ) → InputTextViewmodule:ui/labeledfield/utils~createLabeledInputTextA 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
idandariaDescribedByIdattributes. - It binds input's
isReadOnlyto the labeled view. - It binds input's
hasErrorto 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.Parameters
labeledFieldView : LabeledFieldView<FocusableView>The instance of the labeled field view.
viewUid : stringA UID string that allows DOM logical connection between the labeled view's label and the input.
statusUid : stringA UID string that allows DOM logical connection between the labeled view's status and the input.
Returns
InputTextViewThe input text view instance.
- It sets input's
-
createLabeledTextarea( labeledFieldView, viewUid, statusUid ) → TextareaViewmodule:ui/labeledfield/utils~createLabeledTextareaA 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
idandariaDescribedByIdattributes. - It binds textarea's
isReadOnlyto the labeled view. - It binds textarea's
hasErrorto 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.Parameters
labeledFieldView : LabeledFieldView<FocusableView>The instance of the labeled field view.
viewUid : stringA UID string that allows DOM logical connection between the labeled view's label and the textarea.
statusUid : stringA UID string that allows DOM logical connection between the labeled view's status and the textarea.
Returns
TextareaViewThe textarea view instance.
- It sets textarea's
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.