Skip to content

Commit f884643

Browse files
authored
fix: fix typos in docs (#680)
1 parent 62ba96a commit f884643

24 files changed

+67
-60
lines changed

packages/main/src/Badge.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ const metadata = {
2020

2121
/**
2222
* Defines the color scheme of the <code>ui5-badge</code>.
23-
* There are 10 predefined schemes. Each scheme applies different values for the <code>background-color> and <code>border-color</code>.
23+
* There are 10 predefined schemes. Each scheme applies different values for the <code>background-color</code> and <code>border-color</code>.
2424
* 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.
2525
* <br><br>
2626
* <b>Note:</b> color schemes have no visual representation in High Contrast Black (sap_belize_hcb) theme.

packages/main/src/BusyIndicator.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ const metadata = {
3131
properties: /** @lends sap.ui.webcomponents.main.BusyIndicator.prototype */ {
3232
/**
3333
* Defines the size of the <code>ui5-busyindicator</code>.
34-
* </br></br>
34+
* <br><br>
3535
* <b>Note:</b> Available options are "Small", "Medium" and "Large"
3636
*
3737
* @type {BusyIndicatorSize}

packages/main/src/Button.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ const metadata = {
2222

2323
/**
2424
* Defines the <code>ui5-button</code> design.
25-
* </br></br>
25+
* <br><br>
2626
* <b>Note:</b> Available options are "Default", "Emphasized", "Positive",
2727
* "Negative", and "Transparent".
2828
*

packages/main/src/Card.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ const metadata = {
7272

7373
/**
7474
* Defines image source URI or built-in icon font URI.
75-
* </br></br>
75+
* <br><br>
7676
* <b>Note:</b>
7777
* SAP-icons font provides numerous options. To find all the available icons, see the
7878
* <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>.
@@ -113,7 +113,7 @@ const metadata = {
113113
* <code>heading</code>, <code>subtitle</code>, <code>status</code> and <code>avatar</code>.
114114
*
115115
* <h3>Keyboard handling</h3>
116-
* In case you enable <code>headerInteractive</cdoe> property, you can press the <code>ui5-card</code> header by Space and Enter keys.
116+
* In case you enable <code>headerInteractive</code> property, you can press the <code>ui5-card</code> header by Space and Enter keys.
117117
*
118118
* <h3>ES6 Module Import</h3>
119119
*

packages/main/src/CheckBox.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -143,12 +143,12 @@ const metadata = {
143143
* <h3 class="comment-api-title">Overview</h3>
144144
*
145145
* Allows the user to set a binary value, such as true/false or yes/no for an item.
146-
* <br/><br/>
146+
* <br><br>
147147
* The <code>ui5-checkbox</code> component consists of a box and a label that describes its purpose.
148148
* If it's checked, an indicator is displayed inside the box.
149149
* To check/uncheck the <code>ui5-checkbox</code>, the user has to click or tap the square
150150
* box or its label.
151-
* <br/><br/>
151+
* <br><br>
152152
* Clicking or tapping toggles the <code>ui5-checkbox</code> between checked and unchecked state.
153153
* The <code>ui5-checkbox</code> component only has 2 states - checked and unchecked.
154154
*

packages/main/src/DatePicker.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,10 @@ const metadata = {
179179
* <h3>Usage</h3>
180180
*
181181
* The user can enter a date by:
182-
* <ul><li>Using the calendar that opens in a popup</li>
183-
* <li>Typing it in directly in the input field</li></ul>
182+
* <ul>
183+
* <li>Using the calendar that opens in a popup</li>
184+
* <li>Typing it in directly in the input field</li>
185+
* </ul>
184186
* <br><br>
185187
* When the user makes an entry and chooses the enter key, the calendar shows the corresponding date.
186188
* When the user directly triggers the calendar display, the actual date is displayed.

packages/main/src/Dialog.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ const metadata = {
3636
* The <code>ui5-dialog</code> component is used to temporarily display some information in a
3737
* size-limited window in front of the regular app screen.
3838
* It is used to prompt the user for an action or a confirmation.
39-
* The code>ui5-dialog</code> interrupts the current app processing as it is the only focused UI element and
39+
* The <code>ui5-dialog</code> interrupts the current app processing as it is the only focused UI element and
4040
* the main screen is dimmed/blocked.
4141
* The dialog combines concepts known from other technologies where the windows have
4242
* names such as dialog box, dialog window, pop-up, pop-up window, alert box, or message box.

packages/main/src/GroupHeaderListItem.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ const metadata = {
1717
slots: /** @lends sap.ui.webcomponents.main.GroupHeaderListItem.prototype */ {
1818
/**
1919
* Defines the text of the <code>ui5-li-groupheader</code>.
20-
* <br><b>Note:</b> Аlthough this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
20+
* <br>
21+
* <b>Note:</b> Аlthough this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
2122
*
2223
* @type {Node[]}
2324
* @slot

packages/main/src/Input.js

+6-6
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ const metadata = {
4444

4545
/**
4646
* Defines the <code>ui5-input</code> suggestion items.
47-
* </br></br>
48-
* Example: </br>
49-
* &lt;ui5-input show-suggestions></br>
50-
* &nbsp;&nbsp;&nbsp;&nbsp;&lt;ui5-li>Item #1&lt;/ui5-li></br>
51-
* &nbsp;&nbsp;&nbsp;&nbsp;&lt;ui5-li>Item #2&lt;/ui5-li></br>
47+
* <br><br>
48+
* Example: <br>
49+
* &lt;ui5-input show-suggestions><br>
50+
* &nbsp;&nbsp;&nbsp;&nbsp;&lt;ui5-li>Item #1&lt;/ui5-li><br>
51+
* &nbsp;&nbsp;&nbsp;&nbsp;&lt;ui5-li>Item #2&lt;/ui5-li><br>
5252
* &lt;/ui5-input>
5353
* <ui5-input show-suggestions><ui5-li>Item #1</ui5-li><ui5-li>Item #2</ui5-li></ui5-input>
54-
* </br></br>
54+
* <br><br>
5555
* <b>Note:</b> The suggestion would be displayed only if the <code>showSuggestions</code>
5656
* property is set to <code>true</code>.
5757
*

packages/main/src/Link.js

+5-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ const metadata = {
2121
/**
2222
* Defines whether the <code>ui5-link</code> is disabled.
2323
* <br><br>
24-
* <b>Note:</b> When disabled, the <code>ui5-link</code cannot be triggered by the user.
24+
* <b>Note:</b> When disabled, the <code>ui5-link</code> cannot be triggered by the user.
2525
*
2626
* @type {boolean}
2727
* @defaultvalue false
@@ -48,9 +48,11 @@ const metadata = {
4848
* Defines the <code>ui5-link</code> target.
4949
* <br><br>
5050
* <b>Notes:</b>
51-
* <ul><li>Available options are the standard values: <code>_self</code>, <code>_top</code>,
51+
* <ul>
52+
* <li>Available options are the standard values: <code>_self</code>, <code>_top</code>,
5253
* <code>_blank</code>, <code>_parent</code>, and <code>_search</code>.</li>
53-
* <li>This property must only be used when the <code>href</code> property is set.</li></ul>
54+
* <li>This property must only be used when the <code>href</code> property is set.</li>
55+
* </ul>
5456
*
5557
* @type {string}
5658
* @defaultvalue ""

packages/main/src/ListItem.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const metadata = {
3030
/**
3131
* Defines the visual indication and behavior of the list items.
3232
* Available options are <code>Active</code> (by default) and <code>Inactive</code>.
33-
* </br></br>
33+
* <br><br>
3434
* <b>Note:</b> When set to <code>Active</code>, the item will provide visual response upon press and hover,
3535
* while with type <code>Inactive</code> - will not.
3636
*

packages/main/src/MessageStrip.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const metadata = {
2626

2727
/**
2828
* Defines the <code>ui5-messagestrip</code> type.
29-
* <br></br>
29+
* <br><br>
3030
* <b>Note:</b> Available options are <code>Information"</code>, <code>"Positive"</code>, <code>"Negative"</code>,
3131
* and "Warning".
3232
*
@@ -41,10 +41,10 @@ const metadata = {
4141

4242
/**
4343
* Defines the icon src URI to be displayed as graphical element within the <code>ui5-messagestrip</code>.
44-
* <br></br>
44+
* <br><br>
4545
* <b>Note:</b> If no icon is given, the default icon for the <code>ui5-messagestrip</code> type will be added.
4646
* The SAP-icons font provides numerous options.
47-
* <br></br>
47+
* <br><br>
4848
* Example:
4949
* <br>
5050
* <pre>ui5-messagestrip icon="sap-icon://palette"</pre>

packages/main/src/MultiComboBox.js

+7-7
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ const metadata = {
2323
slots: /** @lends sap.ui.webcomponents.main.MultiComboBox.prototype */ {
2424
/**
2525
* Defines the <code>ui5-multi-combobox</code> items.
26-
* </br></br>
27-
* Example: </br>
28-
* &lt;ui5-multi-combobox></br>
29-
* &nbsp;&nbsp;&nbsp;&nbsp;&lt;ui5-li>Item #1&lt;/ui5-li></br>
30-
* &nbsp;&nbsp;&nbsp;&nbsp;&lt;ui5-li>Item #2&lt;/ui5-li></br>
26+
* <br><br>
27+
* Example: <br>
28+
* &lt;ui5-multi-combobox><br>
29+
* &nbsp;&nbsp;&nbsp;&nbsp;&lt;ui5-li>Item #1&lt;/ui5-li><br>
30+
* &nbsp;&nbsp;&nbsp;&nbsp;&lt;ui5-li>Item #2&lt;/ui5-li><br>
3131
* &lt;/ui5-multi-combobox>
3232
* <br> <br>
3333
*
@@ -180,14 +180,14 @@ const metadata = {
180180
*
181181
* The <code>ui5-multi-combobox</code> provides advanced keyboard handling.
182182
*
183-
* <h4>Picker</h3>
183+
* <h2>Picker</h2>
184184
* If the <code>ui5-multi-combobox</code> is focused,
185185
* you can open or close the drop-down by pressing <code>F4</code>, <code>ALT+UP</code> or <code>ALT+DOWN</code> keys.
186186
* Once the drop-down is opened, you can use the <code>UP</code> and <code>DOWN</code> arrow keys
187187
* to navigate through the available options and select one by pressing the <code>Space</code> or <code>Enter</code> keys.
188188
* <br>
189189
*
190-
* <h4>Tokens</h2>
190+
* <h2>Tokens</h2>
191191
* <ul>
192192
* <li> Left/Right arrow keys - moves the focus selection form the currently focues token to the previous/next one (if available). </li>
193193
* <li> Delete - deletes the token and focuses the previous token. </li>

packages/main/src/Option.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const metadata = {
1919

2020
/**
2121
* Defines the <code>icon</code> source URI.
22-
* </br></br>
22+
* <br><br>
2323
* <b>Note:</b>
2424
* SAP-icons font provides numerous buil-in icons. To find all the available icons, see the
2525
* <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>.

packages/main/src/RadioButton.js

+7-7
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,11 @@ const metadata = {
101101
/**
102102
* Defines the name of the <code>ui5-radiobutton</code>.
103103
* Radio buttons with the same <code>name</code> will form a radio button group.
104-
* <br/><b>Note:</b>
104+
* <br><b>Note:</b>
105105
* The selection can be changed with <code>ARROW_UP/DOWN</code> and <code>ARROW_LEFT/RIGHT</code> keys between radios in same group.
106-
* <br/><b>Note:</b>
106+
* <br><b>Note:</b>
107107
* Only one radio button can be selected per group.
108-
* <br/>
108+
* <br>
109109
* <b>Important:</b> For the <code>name</code> property to have effect when submitting forms, you must add the following import to your project:
110110
* <code>import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";</code>
111111
*
@@ -125,7 +125,7 @@ const metadata = {
125125
* Defines the form value of the <code>ui5-radiobutton</code>.
126126
* When a form with a radio button group is submitted, the group's value
127127
* will be the value of the currently selected radio button.
128-
* <br/>
128+
* <br>
129129
* <b>Important:</b> For the <code>value</code> property to have effect, you must add the following import to your project:
130130
* <code>import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";</code>
131131
*
@@ -178,16 +178,16 @@ const SVGConfig = {
178178
* <code>select</code> event is fired.
179179
* When a <code>ui5-radiobutton</code> that is within a group is selected, the one
180180
* that was previously selected gets automatically deselected. You can group radio buttons by using the <code>name</code> property.
181-
* <br/>
181+
* <br>
182182
* Note: if <code>ui5-radiobutton</code> is not part of a group, it can be selected once, but can not be deselected back.
183183
*
184184
* <h3>Keyboard Handling</h3>
185185
*
186186
* Once the <code>ui5-radiobutton</code> is on focus, it might be selected by pressing the Space and Enter keys.
187-
* <br/>
187+
* <br>
188188
* The Arrow Down/Arrow Up and Arrow Left/Arrow Right keys can be used to change selection between next/previous radio buttons in one group,
189189
* while TAB and SHIFT + TAB can be used to enter or leave the radio button group.
190-
* <br/>
190+
* <br>
191191
* Note: On entering radio button group, the focus goes to the currently selected radio button.
192192
*
193193
* <h3>ES6 Module Import</h3>

packages/main/src/Select.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ const metadata = {
3434

3535
/**
3636
* Defines the <code>ui5-select</code> options.
37-
* <br/><br/>
37+
* <br><br>
3838
* <b>Note:</b> Only one selected option is allowed.
3939
* If more than one option is defined as selected, the last one would be considered as the selected one.
40-
* <br/><br/>
40+
* <br><br>
4141
* <b>Note:</b> Use the <code>ui5-option</code> component to define the desired options.
4242
* @type {Option[]}
4343
* @slot
@@ -53,7 +53,7 @@ const metadata = {
5353

5454
/**
5555
* Defines whether <code>ui5-select</code> is in disabled state.
56-
* </br></br>
56+
* <br><br>
5757
* <b>Note:</b> A disabled <code>ui5-select</code> is noninteractive.
5858
*
5959
* @type {boolean}

packages/main/src/ShellBar.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ const metadata = {
135135
slots: /** @lends sap.ui.webcomponents.main.ShellBar.prototype */ {
136136
/**
137137
* Defines the <code>ui5-shellbar</code> aditional items.
138-
* </br></br>
138+
* <br><br>
139139
* <b>Note:</b>
140140
* You can use the &nbsp;&lt;ui5-shellbar-item>&lt;/ui5-shellbar-item>.
141141
*
@@ -150,7 +150,7 @@ const metadata = {
150150

151151
/**
152152
* Defines the items displayed in menu after a click on the primary title.
153-
* </br></br>
153+
* <br><br>
154154
* <b>Note:</b>
155155
* You can use the &nbsp;&lt;ui5-li>&lt;/ui5-li> and its ancestors.
156156
*

packages/main/src/StandardListItem.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ const metadata = {
2424

2525
/**
2626
* Defines the <code>icon</code> source URI.
27-
* </br></br>
27+
* <br><br>
2828
* <b>Note:</b>
2929
* SAP-icons font provides numerous buil-in icons. To find all the available icons, see the
3030
* <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>.
@@ -38,7 +38,7 @@ const metadata = {
3838

3939
/**
4040
* Defines whether the <code>icon</code> should be displayed in the beginning of the list item or in the end.
41-
* </br></br>
41+
* <br><br>
4242
* <b>Note:</b> If <code>image</code> is set, the <code>icon</code> would be displayed after the <code>image</code>.
4343
*
4444
* @type {boolean}
@@ -51,7 +51,7 @@ const metadata = {
5151

5252
/**
5353
* Defines the <code>image</code> source URI.
54-
* </br></br>
54+
* <br><br>
5555
* <b>Note:</b> The <code>image</code> would be displayed in the beginning of the list item.
5656
*
5757
* @type {string}
@@ -74,7 +74,7 @@ const metadata = {
7474
/**
7575
* Defines the state of the <code>info</code>.
7676
* <br>
77-
* Available options are: <code>"None"</code< (by default), <code>"Success"</code>, <code>"Warning"</code> and <code>"Erorr"</code>.
77+
* Available options are: <code>"None"</code> (by default), <code>"Success"</code>, <code>"Warning"</code> and <code>"Erorr"</code>.
7878
* @type {string}
7979
* @public
8080
* @since 0.13.0

packages/main/src/Switch.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -107,12 +107,12 @@ const metadata = {
107107
*
108108
* <h3 class="comment-api-title">Overview</h3>
109109
* The <code>ui5-switch</code> component is used for changing between binary states.
110-
* </br>
110+
* <br>
111111
* The component can display texts, that will be switched, based on the component state, via the <code>textOn</code> and <code>textOff</code> properties,
112112
* but texts longer than 3 letters will be cuttted off.
113-
* </br>
113+
* <br>
114114
* However, users are able to customize the width of <code>ui5-switch</code> with pure CSS (&lt;ui5-switch style="width: 200px">), and set widths, depending on the texts they would use.
115-
* </br>
115+
* <br>
116116
* Note: the component would not automatically stretch to fit the whole text width.
117117
*
118118
* <h3>Keyboard Handling</h3>

packages/main/src/Tab.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ const metadata = {
7575
* <li>the tab selection line</li>
7676
* </ul>
7777
* <br>
78-
* Available semantic colors are: <code>"Default"</code>, <code>"Neutral", <code>"Positive"</code>, <code>"Critical"</code> and <code>"Negative"</code>.
78+
* Available semantic colors are: <code>"Default"</code>, <code>"Neutral"</code>, <code>"Positive"</code>, <code>"Critical"</code> and <code>"Negative"</code>.
7979
* <br><br>
8080
* <b>Note:</b> The color value depends on the current theme.
8181
* @type {string}

packages/main/src/Table.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,15 @@ const metadata = {
8080
* <li>Internet Explorer</li>
8181
* <li>Microsoft Edge lower than version 41 (EdgeHTML 16)</li>
8282
* <li>Mozilla Firefox lower than version 59</li>
83-
* </ul></li>
83+
* </ul>
84+
* </li>
8485
* <li>Scrolling behavior:
8586
* <ul>
8687
* <li>If the Web Component is placed in layout containers that have the <code>overflow: hidden</code>
8788
* or <code>overflow: auto</code> style definition, this can
8889
* prevent the sticky elements of the Web Component from becoming fixed at the top of the viewport.</li>
89-
* </ul></li>
90+
* </ul>
91+
* </li>
9092
* </ul>
9193
*
9294
* @type {boolean}

packages/main/src/TableColumn.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ const metadata = {
2727

2828
/**
2929
* Defines the minimum screen width required to display this column. By default it is always displayed.
30-
* </br></br>
30+
* <br><br>
3131
* The responsive behavior of the <code>ui5-table</code> is determined by this property. As an example, by setting
3232
* <code>minWidth</code> property to <code>40em</code> shows this column on tablet (and desktop) but hides it on mobile.
33-
* </br>
33+
* <br>
3434
* For further responsive design options, see <code>demandPopin</code> property.
3535
*
3636
* @type {number}
@@ -55,7 +55,7 @@ const metadata = {
5555
/**
5656
* According to your <code>minWidth</code> settings, the <code>ui5-table-column</code> can be hidden
5757
* in different screen sizes.
58-
* </br></br>
58+
* <br><br>
5959
* Setting this property to <code>true</code>, shows this column as pop-in instead of hiding it.
6060
*
6161
* @type {boolean}

0 commit comments

Comments
 (0)