Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Fix docs references
Browse files Browse the repository at this point in the history
  • Loading branch information
panr committed Mar 25, 2020
1 parent f76842e commit c5f7e82
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
18 changes: 9 additions & 9 deletions src/labeledfield/labeledfieldview.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 );

Expand All @@ -94,19 +94,19 @@ 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
*/
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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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}
*/
Expand Down Expand Up @@ -233,7 +233,7 @@ export default class LabeledFieldView extends View {
}

/**
* Focuses the {@link #field}.
* Focuses the {@link #fieldView}.
*/
focus() {
this.fieldView.focus();
Expand Down
6 changes: 3 additions & 3 deletions src/labeledfield/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
*
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tests/labeledfield/labeledfieldview.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 );
} );

Expand Down

0 comments on commit c5f7e82

Please sign in to comment.