Skip to content

Commit 5b3faa9

Browse files
Lukas742Lukas742
authored
docs: add FAQ section and mark abstract components (#4871)
1 parent 009abc5 commit 5b3faa9

File tree

125 files changed

+263
-118
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+263
-118
lines changed

‎docs/knowledge-base/FAQ.mdx

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
import { Meta } from '@storybook/addon-docs';
2+
import { Footer, TableOfContent } from '@sb/components';
3+
import { MessageStrip } from '@ui5/webcomponents-react';
4+
5+
<Meta title="FAQ" />
6+
7+
<TableOfContent />
8+
9+
# FAQ
10+
11+
<MessageStrip
12+
hideCloseButton
13+
children={
14+
<>
15+
Please also take a look at the FAQ of{' '}
16+
<ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/docs-faq">
17+
UI5 Web Components
18+
</ui5-link>
19+
.
20+
</>
21+
}
22+
/>
23+
24+
<br />
25+
<br />
26+
27+
## Why is my Popover or Dialog not rendered correctly?
28+
29+
Mounting popups, like the Popover, inside of components can lead to unwanted side-effects (wrong positioning, alignment, etc.), to prevent that we recommend either mounting it outside of the component, or mounting it with a React portal.
30+
You can find out more about how we use portals [here](https://sap.github.io/ui5-webcomponents-react/?path=/docs/knowledge-base-working-with-portals).
31+
32+
## Where can I find all compatible versions of `@ui5/webcomponents` and `@ui5/webcomponents-react`?
33+
34+
All necessary `@ui5/webcomponents` packages are `peerDependencies` of `@ui5/webcomponents-react`, so if you're using npm v7 or later, then these dependencies should be auto installed when running `npm install`.
35+
If you want to check which versions are compatible you can find a compatibility table [here](https://sap.github.io/ui5-webcomponents-react/?path=/docs/getting-started--docs#add-ui5webcomponents-react-to-an-existing-app).
36+
37+
## What are "abstract" UI5 Web Components?
38+
39+
Abstract UI5 Web Components are mainly there to pass props to the actual component inside the shadow root. Therefore, all attributes passed to the element, will have no effect on the actual component.
40+
41+
### Example
42+
43+
Rendering a `ComboBoxItem` with some custom HTML attributes...
44+
45+
```jsx
46+
<ComboBox>
47+
<ComboBoxItem text="ComboBoxItem1" title="Hello" style={{ backgroundColor: 'red' }} />
48+
</ComboBox>
49+
```
50+
51+
...will result in an element that looks like this:
52+
53+
```html
54+
<ui5-cb-item
55+
text="ComboBoxItem1"
56+
title="Hello"
57+
style="background-color: red;"
58+
_ui5rt0=""
59+
_ui5host=""
60+
ui5-cb-item=""
61+
></ui5-cb-item>
62+
```
63+
64+
As you can see, both `title` and `style` are correctly applied, but since the item doesn't have children, nor a shadow root the attributes don't have an effect on the component.
65+
66+
## How can I style elements inside the shadow root of a web component?
67+
68+
Styling elements inside the shadow root is only supported by leveraging the [`::part` pseudo-element](https://developer.mozilla.org/en-US/docs/Web/CSS/::part). You can find out more about this [here](https://sap.github.io/ui5-webcomponents-react/?path=/docs/knowledge-base-styling--docs#css-shadow-parts).
69+
70+
<Footer />

‎packages/main/scripts/create-web-components-wrapper.mjs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,7 @@ const createWebComponentWrapper = async (
205205

206206
return await renderComponentWrapper({
207207
name: componentSpec.module,
208+
abstract: componentSpec.abstract,
208209
imports,
209210
importSpecifier,
210211
propTypesExtends: tsExtendsStatement,
@@ -505,9 +506,11 @@ allWebComponents
505506
const componentWithoutDemo = COMPONENTS_WITHOUT_DEMOS[componentSpec.module];
506507
// create subcomponent description
507508
if (typeof componentWithoutDemo === 'string') {
508-
if (componentSpec.since) {
509-
mainDescription = `<b>Since:</b> ${versionInfo[componentSpec.since]}<br/><br/>` + mainDescription;
510-
}
509+
const since = componentSpec.since ? `<b>Since:</b> ${versionInfo[componentSpec.since]}<br/>` : '';
510+
const abstractDescription = componentSpec.abstract
511+
? `<b>Abstract UI5 Web Component</b> - Find out more about abstract components <a href="https://sap.github.io/ui5-webcomponents-react/?path=/docs/knowledge-base-faq--docs#what-are-abstract-ui5-web-components" target="_blank">here</a>.<br/><br/>`
512+
: '</br>';
513+
mainDescription = `${since}${abstractDescription}${mainDescription}`;
511514
const subComponentDescription = `${await formatDemoDescription(
512515
mainDescription,
513516
componentSpec,

‎packages/main/src/webComponents/Avatar/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ export interface AvatarPropTypes extends AvatarAttributes, CommonProps {
109109
*
110110
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
111111
*
112-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Avatar" target="_blank">UI5 Web Components Storybook</ui5-link>
112+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Avatar)
113113
*/
114114
const Avatar = withWebComponent<AvatarPropTypes, AvatarDomRef>(
115115
'ui5-avatar',

‎packages/main/src/webComponents/AvatarGroup/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ export interface AvatarGroupPropTypes extends AvatarGroupAttributes, Omit<Common
6969
*
7070
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
7171
*
72-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-AvatarGroup" target="_blank">UI5 Web Components Storybook</ui5-link>
72+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-AvatarGroup)
7373
*/
7474
const AvatarGroup = withWebComponent<AvatarGroupPropTypes, AvatarGroupDomRef>(
7575
'ui5-avatar-group',

‎packages/main/src/webComponents/Badge/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export interface BadgePropTypes extends BadgeAttributes, CommonProps {
4040
*
4141
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
4242
*
43-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Badge" target="_blank">UI5 Web Components Storybook</ui5-link>
43+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Badge)
4444
*/
4545
const Badge = withWebComponent<BadgePropTypes, BadgeDomRef>(
4646
'ui5-badge',

‎packages/main/src/webComponents/Bar/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export interface BarPropTypes extends BarAttributes, CommonProps {
5555
*
5656
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
5757
*
58-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/fiori-Bar" target="_blank">UI5 Web Components Storybook</ui5-link>
58+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/fiori-Bar)
5959
*/
6060
const Bar = withWebComponent<BarPropTypes, BarDomRef>(
6161
'ui5-bar',

‎packages/main/src/webComponents/BarcodeScannerDialog/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface BarcodeScannerDialogPropTypes extends BarcodeScannerDialogAttri
4343
*
4444
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
4545
*
46-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/fiori-BarcodeScannerDialog" target="_blank">UI5 Web Components Storybook</ui5-link>
46+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/fiori-BarcodeScannerDialog)
4747
*/
4848
const BarcodeScannerDialog = withWebComponent<BarcodeScannerDialogPropTypes, BarcodeScannerDialogDomRef>(
4949
'ui5-barcode-scanner-dialog',

‎packages/main/src/webComponents/Breadcrumbs/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export interface BreadcrumbsPropTypes extends BreadcrumbsAttributes, CommonProps
5353
*
5454
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
5555
*
56-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Breadcrumbs" target="_blank">UI5 Web Components Storybook</ui5-link>
56+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Breadcrumbs)
5757
*/
5858
const Breadcrumbs = withWebComponent<BreadcrumbsPropTypes, BreadcrumbsDomRef>(
5959
'ui5-breadcrumbs',

‎packages/main/src/webComponents/BreadcrumbsItem/BreadcrumbsItemDescription.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
**Since:** 0.18.0
1+
**Since:** 0.18.0
2+
**Abstract UI5 Web Component** - Find out more about abstract components [here](https://sap.github.io/ui5-webcomponents-react/?path=/docs/knowledge-base-faq--docs#what-are-abstract-ui5-web-components).
23

34
The `BreadcrumbsItem` component defines the content of an item in `Breadcrumbs`

‎packages/main/src/webComponents/BreadcrumbsItem/index.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,11 @@ export interface BreadcrumbsItemPropTypes extends BreadcrumbsItemAttributes, Com
4848
/**
4949
* The `BreadcrumbsItem` component defines the content of an item in `Breadcrumbs`
5050
*
51+
* @abstract
52+
*
5153
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
5254
*
53-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Breadcrumbs" target="_blank">UI5 Web Components Storybook</ui5-link>
55+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Breadcrumbs)
5456
*/
5557
const BreadcrumbsItem = withWebComponent<BreadcrumbsItemPropTypes, BreadcrumbsItemDomRef>(
5658
'ui5-breadcrumbs-item',

‎packages/main/src/webComponents/BusyIndicator/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export interface BusyIndicatorPropTypes extends BusyIndicatorAttributes, CommonP
4545
*
4646
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
4747
*
48-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-BusyIndicator" target="_blank">UI5 Web Components Storybook</ui5-link>
48+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-BusyIndicator)
4949
*/
5050
const BusyIndicator = withWebComponent<BusyIndicatorPropTypes, BusyIndicatorDomRef>(
5151
'ui5-busy-indicator',

‎packages/main/src/webComponents/Button/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ export interface ButtonPropTypes extends ButtonAttributes, Omit<CommonProps, 'on
109109
*
110110
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
111111
*
112-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Button" target="_blank">UI5 Web Components Storybook</ui5-link>
112+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Button)
113113
*/
114114
const Button = withWebComponent<ButtonPropTypes, ButtonDomRef>(
115115
'ui5-button',

‎packages/main/src/webComponents/Calendar/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export interface CalendarPropTypes extends CalendarAttributes, CommonProps {
6565
*
6666
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
6767
*
68-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Calendar" target="_blank">UI5 Web Components Storybook</ui5-link>
68+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Calendar)
6969
*/
7070
const Calendar = withWebComponent<CalendarPropTypes, CalendarDomRef>(
7171
'ui5-calendar',

‎packages/main/src/webComponents/CalendarDate/CalendarDateDescription.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
**Abstract UI5 Web Component** - Find out more about abstract components [here](https://sap.github.io/ui5-webcomponents-react/?path=/docs/knowledge-base-faq--docs#what-are-abstract-ui5-web-components).
2+
13
The `CalendarDate` component defines a calendar date to be used inside `Calendar`

‎packages/main/src/webComponents/CalendarDate/index.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,11 @@ export interface CalendarDatePropTypes extends CalendarDateAttributes, CommonPro
1818
/**
1919
* The `CalendarDate` component defines a calendar date to be used inside `Calendar`
2020
*
21+
* @abstract
22+
*
2123
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
2224
*
23-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Calendar" target="_blank">UI5 Web Components Storybook</ui5-link>
25+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Calendar)
2426
*/
2527
const CalendarDate = withWebComponent<CalendarDatePropTypes, CalendarDateDomRef>(
2628
'ui5-date',

‎packages/main/src/webComponents/Card/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface CardPropTypes extends CardAttributes, CommonProps {
4343
*
4444
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
4545
*
46-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Card" target="_blank">UI5 Web Components Storybook</ui5-link>
46+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Card)
4747
*/
4848
const Card = withWebComponent<CardPropTypes, CardDomRef>(
4949
'ui5-card',

‎packages/main/src/webComponents/CardHeader/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export interface CardHeaderPropTypes extends CardHeaderAttributes, Omit<CommonPr
6060
*
6161
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
6262
*
63-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Card" target="_blank">UI5 Web Components Storybook</ui5-link>
63+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Card)
6464
*/
6565
const CardHeader = withWebComponent<CardHeaderPropTypes, CardHeaderDomRef>(
6666
'ui5-card-header',

‎packages/main/src/webComponents/Carousel/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ export interface CarouselPropTypes extends CarouselAttributes, CommonProps {
101101
*
102102
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
103103
*
104-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Carousel" target="_blank">UI5 Web Components Storybook</ui5-link>
104+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-Carousel)
105105
*/
106106
const Carousel = withWebComponent<CarouselPropTypes, CarouselDomRef>(
107107
'ui5-carousel',

‎packages/main/src/webComponents/CheckBox/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ export interface CheckBoxPropTypes extends CheckBoxAttributes, Omit<CommonProps,
100100
*
101101
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
102102
*
103-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-CheckBox" target="_blank">UI5 Web Components Storybook</ui5-link>
103+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-CheckBox)
104104
*/
105105
const CheckBox = withWebComponent<CheckBoxPropTypes, CheckBoxDomRef>(
106106
'ui5-checkbox',

‎packages/main/src/webComponents/ColorPalette/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface ColorPalettePropTypes extends ColorPaletteAttributes, CommonPro
2626
*
2727
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
2828
*
29-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ColorPalette" target="_blank">UI5 Web Components Storybook</ui5-link>
29+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ColorPalette)
3030
*/
3131
const ColorPalette = withWebComponent<ColorPalettePropTypes, ColorPaletteDomRef>(
3232
'ui5-color-palette',

‎packages/main/src/webComponents/ColorPaletteItem/ColorPaletteItemDescription.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
**Since:** 0.14.0
1+
**Since:** 0.14.0
2+
**Abstract UI5 Web Component** - Find out more about abstract components [here](https://sap.github.io/ui5-webcomponents-react/?path=/docs/knowledge-base-faq--docs#what-are-abstract-ui5-web-components).
23

34
The `ColorPaletteItem` component represents a color in the the `ColorPalette`

‎packages/main/src/webComponents/ColorPaletteItem/index.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ export interface ColorPaletteItemPropTypes extends ColorPaletteItemAttributes, C
2121
/**
2222
* The `ColorPaletteItem` component represents a color in the the `ColorPalette`
2323
*
24+
* @abstract
25+
*
2426
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
2527
*
26-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ColorPalette" target="_blank">UI5 Web Components Storybook</ui5-link>
28+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ColorPalette)
2729
*/
2830
const ColorPaletteItem = withWebComponent<ColorPaletteItemPropTypes, ColorPaletteItemDomRef>(
2931
'ui5-color-palette-item',

‎packages/main/src/webComponents/ColorPalettePopover/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export interface ColorPalettePopoverPropTypes extends ColorPalettePopoverAttribu
5656
*
5757
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
5858
*
59-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ColorPalettePopover" target="_blank">UI5 Web Components Storybook</ui5-link>
59+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ColorPalettePopover)
6060
*/
6161
const ColorPalettePopover = withWebComponent<ColorPalettePopoverPropTypes, ColorPalettePopoverDomRef>(
6262
'ui5-color-palette-popover',

‎packages/main/src/webComponents/ColorPicker/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ColorPickerPropTypes extends ColorPickerAttributes, Omit<Common
2828
*
2929
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
3030
*
31-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ColorPicker" target="_blank">UI5 Web Components Storybook</ui5-link>
31+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ColorPicker)
3232
*/
3333
const ColorPicker = withWebComponent<ColorPickerPropTypes, ColorPickerDomRef>(
3434
'ui5-color-picker',

‎packages/main/src/webComponents/ComboBox/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export interface ComboBoxPropTypes extends ComboBoxAttributes, Omit<CommonProps,
116116
*
117117
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
118118
*
119-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ComboBox" target="_blank">UI5 Web Components Storybook</ui5-link>
119+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ComboBox)
120120
*/
121121
const ComboBox = withWebComponent<ComboBoxPropTypes, ComboBoxDomRef>(
122122
'ui5-combobox',

‎packages/main/src/webComponents/ComboBoxGroupItem/ComboBoxGroupItemDescription.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
**Since:** 0.18.0
1+
**Since:** 0.18.0
2+
**Abstract UI5 Web Component** - Find out more about abstract components [here](https://sap.github.io/ui5-webcomponents-react/?path=/docs/knowledge-base-faq--docs#what-are-abstract-ui5-web-components).
23

34
The `ComboBoxGroupItem` is type of suggestion item, that can be used to split the `ComboBox` suggestions into groups

‎packages/main/src/webComponents/ComboBoxGroupItem/index.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,11 @@ export interface ComboBoxGroupItemPropTypes extends ComboBoxGroupItemAttributes,
1818
/**
1919
* The `ComboBoxGroupItem` is type of suggestion item, that can be used to split the `ComboBox` suggestions into groups
2020
*
21+
* @abstract
22+
*
2123
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
2224
*
23-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ComboBox" target="_blank">UI5 Web Components Storybook</ui5-link>
25+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ComboBox)
2426
*/
2527
const ComboBoxGroupItem = withWebComponent<ComboBoxGroupItemPropTypes, ComboBoxGroupItemDomRef>(
2628
'ui5-cb-group-item',

‎packages/main/src/webComponents/ComboBoxItem/ComboBoxItemDescription.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
**Abstract UI5 Web Component** - Find out more about abstract components [here](https://sap.github.io/ui5-webcomponents-react/?path=/docs/knowledge-base-faq--docs#what-are-abstract-ui5-web-components).
2+
13
The `ComboBoxItem` represents the item for a `ComboBox`

‎packages/main/src/webComponents/ComboBoxItem/index.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ export interface ComboBoxItemPropTypes extends ComboBoxItemAttributes, CommonPro
2222
/**
2323
* The `ComboBoxItem` represents the item for a `ComboBox`
2424
*
25+
* @abstract
26+
*
2527
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
2628
*
27-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ComboBox" target="_blank">UI5 Web Components Storybook</ui5-link>
29+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-ComboBox)
2830
*/
2931
const ComboBoxItem = withWebComponent<ComboBoxItemPropTypes, ComboBoxItemDomRef>(
3032
'ui5-cb-item',

‎packages/main/src/webComponents/CustomListItem/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export interface CustomListItemPropTypes extends CustomListItemAttributes, Commo
6464
*
6565
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
6666
*
67-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-List" target="_blank">UI5 Web Components Storybook</ui5-link>
67+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-List)
6868
*/
6969
const CustomListItem = withWebComponent<CustomListItemPropTypes, CustomListItemDomRef>(
7070
'ui5-li-custom',

‎packages/main/src/webComponents/DatePicker/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ export interface DatePickerPropTypes extends DatePickerAttributes, Omit<CommonPr
157157
*
158158
* __Note:__ This component is a web component developed by the UI5 Web Components’ team.
159159
*
160-
* <ui5-link href="https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-DatePicker" target="_blank">UI5 Web Components Storybook</ui5-link>
160+
* [UI5 Web Components Storybook](https://sap.github.io/ui5-webcomponents/playground/?path=/docs/main-DatePicker)
161161
*/
162162
const DatePicker = withWebComponent<DatePickerPropTypes, DatePickerDomRef>(
163163
'ui5-date-picker',

0 commit comments

Comments
 (0)