Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions packages/main/src/Avatar.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const metadata = {
* <br><br>
* import "@ui5/webcomponents-icons/dist/{icon_name}.js"
* <br>
* <pre>&lt;ui5-avatar icon-src="employee"></pre>
* <pre>&lt;ui5-avatar icon="employee"></pre>
*
* See all the available icons in the <ui5-link target="_blank" href="https://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html" class="api-table-content-cell-link">Icon Explorer</ui5-link>.
* @type {string}
Expand All @@ -77,7 +77,7 @@ const metadata = {
/**
* Defines the displayed initials.
* <br>
* Up to two Latin letters can be displayed as initials in a <code>ui5-avatar</code>.
* Up to two Latin letters can be displayed as initials.
*
* @type {string}
* @defaultvalue ""
Expand All @@ -88,7 +88,7 @@ const metadata = {
},

/**
* Defines the shape of the <code>ui5-avatar</code>.
* Defines the shape of the component.
* <br><br>
* Available options are:
* <ul>
Expand All @@ -105,7 +105,7 @@ const metadata = {
},

/**
* Defines predefined size of the <code>ui5-avatar</code>.
* Defines predefined size of the component.
* <br><br>
* Available options are:
* <ul>
Expand Down Expand Up @@ -184,7 +184,7 @@ const metadata = {
},

/**
* Defines the text alternative of the <code>ui5-avatar</code>.
* Defines the text alternative of the component.
* If not provided a default text alternative will be set, if present.
*
* @type {string}
Expand All @@ -197,7 +197,7 @@ const metadata = {
},

/**
* Defines the aria-haspopup value of the <code>ui5-avatar</code> when <code>interactive</code> property is <code>true</code>.
* Defines the aria-haspopup value of the component when <code>interactive</code> property is <code>true</code>.
* <br><br>
* @type String
* @since 1.0.0-rc.15
Expand Down Expand Up @@ -242,7 +242,7 @@ const metadata = {
*
* <ul>
* <li>[SPACE, ENTER, RETURN] - Fires the <code>click</code> event if the <code>interactive</code> property is set to true.</li>
* <li>[SHIFT] - If [SPACE] or [ENTER],[RETURN] is pressed, pressing [SHIFT] releases the <code>ui5-avatar</code> without triggering the click event.</li>
* <li>[SHIFT] - If [SPACE] or [ENTER],[RETURN] is pressed, pressing [SHIFT] releases the component without triggering the click event.</li>
* </ul>
* <br><br>
*
Expand Down
18 changes: 9 additions & 9 deletions packages/main/src/AvatarGroup.js
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const metadata = {
},

/**
* Defines the aria-haspopup value of the <code>ui5-avatar-group</code> on:
* Defines the aria-haspopup value of the component on:
* <br><br>
* <ul>
* <li> the whole container when <code>type</code> property is <code>Group</code></li>
Expand All @@ -126,7 +126,7 @@ const metadata = {
},
slots: /** @lends sap.ui.webcomponents.main.AvatarGroup.prototype */ {
/**
* Defines the items of the <code>ui5-avatar-group</code>. Use the <code>ui5-avatar</code> component as an item.
* Defines the items of the component. Use the <code>ui5-avatar</code> component as an item.
* <br><br>
* <b>Note:</b> The UX guidelines recommends using avatars with "Circle" shape.
* Moreover, if you use avatars with "Square" shape, there will be visual inconsistency
Expand All @@ -140,10 +140,10 @@ const metadata = {
propertyName: "items",
},
/**
* Defines the overflow button of <code>ui5-avatar-group</code>.
* Defines the overflow button of the component.
* <b>Note:</b> We recommend using the <code>ui5-button</code> component.
* <br><br>
* <b>Note:</b> If this slot is not used, the <code>ui5-avatar-group</code> will
* <b>Note:</b> If this slot is not used, the component will
* display the built-in overflow button.
* @type {HTMLElement}
* @slot overflowButton
Expand All @@ -156,7 +156,7 @@ const metadata = {
},
events: /** @lends sap.ui.webcomponents.main.AvatarGroup.prototype */ {
/**
* Fired when the <code>ui5-avatar-group</code> is activated either with a
* Fired when the component is activated either with a
* click/tap or by using the Enter or Space key.
* @param {HTMLElement} targetRef The DOM ref of the clicked item.
* @param {boolean} overflowButtonClicked indicates if the overflow button is clicked
Expand All @@ -172,7 +172,7 @@ const metadata = {
},
/**
* Fired when the count of visible <code>ui5-avatar</code> elements in the
* <code>ui5-avatar-group</code> has changed
* component has changed
* @event
* @public
* @since 1.0.0-rc.13
Expand Down Expand Up @@ -223,7 +223,7 @@ const metadata = {
* </ul>
*
* <h3>Keyboard Handling</h3>
* The <code>ui5-avatar-group</code> provides advanced keyboard handling.
* The component provides advanced keyboard handling.
* When focused, the user can use the following keyboard
* shortcuts in order to perform a navigation:
* <br>
Expand All @@ -241,7 +241,7 @@ const metadata = {
* - <code>type</code> Group:
* <br>
* <ul>
* <li>[TAB] - Move focus to the next interactive element after the <code>ui5-avatar-group</code></li>
* <li>[TAB] - Move focus to the next interactive element after the component</li>
* <li>[SPACE],[ENTER],[RETURN] - Trigger <code>ui5-click</code> event</li>
* </ul>
* <br>
Expand Down Expand Up @@ -309,7 +309,7 @@ class AvatarGroup extends UI5Element {
}

/**
* Returns an array containing the <code>AvatarColorScheme</code> values that correspond to the avatars in the <code>ui5-avatar-group</code>.
* Returns an array containing the <code>AvatarColorScheme</code> values that correspond to the avatars in the component.
* @readonly
* @type { Array }
* @defaultValue []
Expand Down
6 changes: 3 additions & 3 deletions packages/main/src/Badge.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const metadata = {
properties: /** @lends sap.ui.webcomponents.main.Badge.prototype */ {

/**
* Defines the color scheme of the <code>ui5-badge</code>.
* Defines the color scheme of the component.
* There are 10 predefined schemes. Each scheme applies different values for the <code>background-color</code> and <code>border-color</code>.
* To use one you can set a number from <code>"1"</code> to <code>"10"</code>. The <code>colorScheme</code> <code>"1"</code> will be set by default.
* <br><br>
Expand All @@ -36,7 +36,7 @@ const metadata = {
managedSlots: true,
slots: /** @lends sap.ui.webcomponents.main.Badge.prototype */ {
/**
* Defines the text of the <code>ui5-badge</code>.
* Defines the text of the component.
* <br><b>Note:</b> Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
*
* @type {Node[]}
Expand All @@ -48,7 +48,7 @@ const metadata = {
},

/**
* Defines the <code>ui5-icon</code> to be displayed in the <code>ui5-badge</code>.
* Defines the icon to be displayed in the component.
*
* @type {sap.ui.webcomponents.main.IIcon}
* @slot
Expand Down
6 changes: 3 additions & 3 deletions packages/main/src/BusyIndicator.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const metadata = {
slots: /** @lends sap.ui.webcomponents.main.BusyIndicator.prototype */ {

/**
* Determines the content over which the <code>ui5-busyindicator</code> will appear.
* Determines the content over which the component will appear.
*
* @type {Node[]}
* @slot
Expand All @@ -36,7 +36,7 @@ const metadata = {
properties: /** @lends sap.ui.webcomponents.main.BusyIndicator.prototype */ {

/**
* Defines text to be displayed below the <code>ui5-busyindicator</code>. It can be used to inform the user of the current operation.
* Defines text to be displayed below the component. It can be used to inform the user of the current operation.
* @type {String}
* @public
* @defaultvalue ""
Expand All @@ -47,7 +47,7 @@ const metadata = {
},

/**
* Defines the size of the <code>ui5-busyindicator</code>.
* Defines the size of the component.
*
* <br><br>
* <b>Note:</b>
Expand Down
20 changes: 9 additions & 11 deletions packages/main/src/Button.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const metadata = {
properties: /** @lends sap.ui.webcomponents.main.Button.prototype */ {

/**
* Defines the <code>ui5-button</code> design.
* Defines the component design.
*
* <br><br>
* <b>Note:</b>
Expand All @@ -51,9 +51,9 @@ const metadata = {
},

/**
* Defines whether the <code>ui5-button</code> is disabled
* Defines whether the component is disabled
* (default is set to <code>false</code>).
* A disabled <code>ui5-button</code> can't be pressed or
* A disabled component can't be pressed or
* focused, and it is not in the tab chain.
*
* @type {boolean}
Expand All @@ -65,12 +65,10 @@ const metadata = {
},

/**
* Defines the icon to be displayed as graphical element within the <code>ui5-button</code>.
* Defines the icon to be displayed as graphical element within the component.
* The SAP-icons font provides numerous options.
* <br><br>
* Example:
* <br>
* <pre>ui5-button icon="palette"</pre>
*
* See all the available icons in the <ui5-link target="_blank" href="https://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html" class="api-table-content-cell-link">Icon Explorer</ui5-link>.
*
Expand All @@ -83,7 +81,7 @@ const metadata = {
},

/**
* Defines whether the icon should be displayed after the <code>ui5-button</code> text.
* Defines whether the icon should be displayed after the component text.
*
* @type {boolean}
* @defaultvalue false
Expand All @@ -94,7 +92,7 @@ const metadata = {
},

/**
* When set to <code>true</code>, the <code>ui5-button</code> will
* When set to <code>true</code>, the component will
* automatically submit the nearest form element upon <code>press</code>.
* <br><br>
* <b>Important:</b> For the <code>submits</code> property to have effect, you must add the following import to your project:
Expand Down Expand Up @@ -122,7 +120,7 @@ const metadata = {
},

/**
* Used to switch the active state (pressed or not) of the <code>ui5-button</code>.
* Used to switch the active state (pressed or not) of the component.
* @private
*/
active: {
Expand Down Expand Up @@ -224,7 +222,7 @@ const metadata = {
managedSlots: true,
slots: /** @lends sap.ui.webcomponents.main.Button.prototype */ {
/**
* Defines the text of the <code>ui5-button</code>.
* Defines the text of the component.
* <br><br>
* <b>Note:</b> Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
*
Expand All @@ -239,7 +237,7 @@ const metadata = {
events: /** @lends sap.ui.webcomponents.main.Button.prototype */ {

/**
* Fired when the <code>ui5-button</code> is activated either with a
* Fired when the component is activated either with a
* mouse/tap or by using the Enter or Space key.
* <br><br>
* <b>Note:</b> The event will not be fired if the <code>disabled</code>
Expand Down
2 changes: 1 addition & 1 deletion packages/main/src/Calendar.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ const metadata = {
events: /** @lends sap.ui.webcomponents.main.Calendar.prototype */ {
/**
* Fired when the selected dates change.
* <b>Note:</b> If you call <code>preventDefault()</code> for this event, <code>ui5-calendar</code> will not
* <b>Note:</b> If you call <code>preventDefault()</code> for this event, the component will not
* create instances of <code>ui5-date</code> for the newly selected dates. In that case you should do this manually.
*
* @event sap.ui.webcomponents.main.Calendar#selected-dates-change
Expand Down
2 changes: 1 addition & 1 deletion packages/main/src/CalendarDate.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const metadata = {
properties: /** @lends sap.ui.webcomponents.main.CalendarDate.prototype */ {

/**
* The date formatted according to the <code>formatPattern</code> property of the <code>ui5-calendar</code> that hosts the <code>ui5-date</code>
* The date formatted according to the <code>formatPattern</code> property of the <code>ui5-calendar</code> that hosts the component
*
* @type {string}
* @public
Expand Down
16 changes: 8 additions & 8 deletions packages/main/src/Card.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const metadata = {
slots: /** @lends sap.ui.webcomponents.main.Card.prototype */ {

/**
* Defines the content of the <code>ui5-card</code>.
* Defines the content of the component.
* @type {HTMLElement[]}
* @slot content
* @public
Expand Down Expand Up @@ -69,7 +69,7 @@ const metadata = {
properties: /** @lends sap.ui.webcomponents.main.Card.prototype */ {

/**
* Defines the title displayed in the <code>ui5-card</code> header.
* Defines the title displayed in the component header.
* @type {string}
* @defaultvalue ""
* @public
Expand All @@ -79,7 +79,7 @@ const metadata = {
},

/**
* Defines the subheading displayed in the <code>ui5-card</code> header.
* Defines the subheading displayed in the component header.
* @type {string}
* @defaultvalue ""
* @public
Expand All @@ -89,7 +89,7 @@ const metadata = {
},

/**
* Defines the status displayed in the <code>ui5-card</code> header.
* Defines the status displayed in the component header.
* <br><br>
* <b>Note:</b> If the <code>action</code> slot is set, the <code>status</code> will not be displayed,
* you can either have <code>action</code>, or <code>status</code>.
Expand All @@ -102,7 +102,7 @@ const metadata = {
},

/**
* Defines if the <code>ui5-card</code> header would be interactive,
* Defines if the component header would be interactive,
* e.g gets hover effect, gets focused and <code>headerPress</code> event is fired, when it is pressed.
* @type {boolean}
* @defaultvalue false
Expand All @@ -113,7 +113,7 @@ const metadata = {
},

/**
* Defines the aria-label attribute for the <code>ui5-card</code>
* Defines the aria-label attribute for the component
*
* @type {String}
* @since 1.0.0-rc.9
Expand All @@ -125,7 +125,7 @@ const metadata = {
},

/**
* Receives id(or many ids) of the elements that label the <code>ui5-card</code>
* Receives id(or many ids) of the elements that label the component
*
* @type {String}
* @defaultvalue ""
Expand All @@ -145,7 +145,7 @@ const metadata = {
events: /** @lends sap.ui.webcomponents.main.Card.prototype */ {

/**
* Fired when the <code>ui5-card</code> header is activated
* Fired when the component header is activated
* by mouse/tap or by using the Enter or Space key.
* <br><br>
* <b>Note:</b> The event would be fired only if the <code>headerInteractive</code> property is set to true.
Expand Down
4 changes: 2 additions & 2 deletions packages/main/src/Carousel.js
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ const metadata = {
managedSlots: true,
slots: /** @lends sap.ui.webcomponents.main.Carousel.prototype */ {
/**
* Defines the content of the <code>ui5-carousel</code>.
* Defines the content of the component.
* @type {HTMLElement[]}
* @slot content
* @public
Expand Down Expand Up @@ -197,7 +197,7 @@ const metadata = {
},

/**
* Fired for the last items of the <code>ui5-carousel</code> if it is scrolled and the direction of scrolling is to the end.
* Fired for the last items of the component if it is scrolled and the direction of scrolling is to the end.
* The number of items for which the event is fired is controlled by the <code>infiniteScrollOffset</code> property.
* @event sap.ui.webcomponents.main.Carousel#load-more
* @public
Expand Down
Loading