Răsfoiți Sursa

Fix docs references

panr 5 ani în urmă
părinte
comite
211ca67a54

+ 9 - 9
packages/ckeditor5-ui/src/labeledfield/labeledfieldview.js

@@ -70,9 +70,9 @@ export default class LabeledFieldView extends View {
 		const statusUid = `ck-labeled-view-status-${ uid() }`;
 
 		/**
-		 * The field that gets labeled.
+		 * The field view that gets labeled.
 		 *
-		 * @member {module:ui/view~View} #field
+		 * @member {module:ui/view~View} #fieldView
 		 */
 		this.fieldView = viewCreator( this, viewUid, statusUid );
 
@@ -94,11 +94,11 @@ export default class LabeledFieldView extends View {
 
 		/**
 		 * The validation error text. When set, it will be displayed
-		 * next to the {@link #field} as a typical validation error message.
+		 * next to the {@link #fieldView} as a typical validation error message.
 		 * Set it to `null` to hide the message.
 		 *
 		 * **Note:** Setting this property to anything but `null` will automatically
-		 * make the `hasError` of the {@link #field} `true`.
+		 * make the `hasError` of the {@link #fieldView} `true`.
 		 *
 		 * @observable
 		 * @member {String|null} #errorText
@@ -106,7 +106,7 @@ export default class LabeledFieldView extends View {
 		this.set( 'errorText', null );
 
 		/**
-		 * The additional information text displayed next to the {@link #field} which can
+		 * The additional information text displayed next to the {@link #fieldView} which can
 		 * be used to inform the user about its purpose, provide help or hints.
 		 *
 		 * Set it to `null` to hide the message.
@@ -136,7 +136,7 @@ export default class LabeledFieldView extends View {
 		this.labelView = this._createLabelView( viewUid );
 
 		/**
-		 * The status view for the {@link #field}. It displays {@link #errorText} and
+		 * The status view for the {@link #fieldView}. It displays {@link #errorText} and
 		 * {@link #infoText}.
 		 *
 		 * @member {module:ui/view~View} #statusView
@@ -199,10 +199,10 @@ export default class LabeledFieldView extends View {
 
 	/**
 	 * Creates the status view instance. It displays {@link #errorText} and {@link #infoText}
-	 * next to the {@link #field}. See {@link #_statusText}.
+	 * next to the {@link #fieldView}. See {@link #_statusText}.
 	 *
 	 * @private
-	 * @param {String} statusUid Unique id of the status, shared with the {@link #field view's}
+	 * @param {String} statusUid Unique id of the status, shared with the {@link #fieldView view's}
 	 * `aria-describedby` attribute.
 	 * @returns {module:ui/view~View}
 	 */
@@ -233,7 +233,7 @@ export default class LabeledFieldView extends View {
 	}
 
 	/**
-	 * Focuses the {@link #field}.
+	 * Focuses the {@link #fieldView}.
 	 */
 	focus() {
 		this.fieldView.focus();

+ 3 - 3
packages/ckeditor5-ui/src/labeledfield/utils.js

@@ -28,7 +28,7 @@ import { createDropdown } from '../dropdown/utils';
  *		const labeledInputView = new LabeledFieldView( locale, createLabeledDropdown );
  *		console.log( labeledInputView.view ); // An input instance.
  *
- * @param {module:ui/labeledfield/labeledfieldview~LabeledFieldView} labeledFieldView The instance of the labeled view.
+ * @param {module:ui/labeledfield/labeledfieldview~LabeledFieldView} labeledFieldView The instance of the labeled field view.
  * @param {String} viewUid An UID string that allows DOM logical connection between the
  * {@link module:ui/labeledfield/labeledfieldview~LabeledFieldView#labelView labeled view's label} and the input.
  * @param {String} statusUid An UID string that allows DOM logical connection between the
@@ -59,7 +59,7 @@ export function createLabeledInputText( labeledFieldView, viewUid, statusUid ) {
  * A helper for creating labeled dropdowns.
  *
  * It creates an instance of a {@link module:ui/dropdown/dropdownview~DropdownView dropdown} that is
- * logically related to a {@link module:ui/labeledfield/labeledfieldview~LabeledFieldView labeled view}.
+ * logically related to a {@link module:ui/labeledfield/labeledfieldview~LabeledFieldView labeled field view}.
  *
  * The helper does the following:
  *
@@ -71,7 +71,7 @@ export function createLabeledInputText( labeledFieldView, viewUid, statusUid ) {
  *		const labeledInputView = new LabeledFieldView( locale, createLabeledDropdown );
  *		console.log( labeledInputView.view ); // A dropdown instance.
  *
- * @param {module:ui/labeledfield/labeledfieldview~LabeledFieldView} labeledFieldView The instance of the labeled view.
+ * @param {module:ui/labeledfield/labeledfieldview~LabeledFieldView} labeledFieldView The instance of the labeled field view.
  * @param {String} viewUid An UID string that allows DOM logical connection between the
  * {@link module:ui/labeledfield/labeledfieldview~LabeledFieldView#labelView labeled view label} and the dropdown.
  * @param {String} statusUid An UID string that allows DOM logical connection between the

+ 1 - 1
packages/ckeditor5-ui/tests/labeledfield/labeledfieldview.js

@@ -35,7 +35,7 @@ describe( 'LabeledFieldView', () => {
 			expect( labeledInput.locale ).to.deep.equal( locale );
 		} );
 
-		it( 'should set labeledInput#field', () => {
+		it( 'should set labeledInput#fieldView', () => {
 			expect( labeledInput.fieldView ).to.equal( view );
 		} );