Skip to content

Commit 462ba83

Browse files
authored
docs(FAQ): add badges entry, update "tags" screenshot (#7695)
1 parent 0d9bba7 commit 462ba83

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed
104 KB
Loading

docs/knowledge-base/FAQ.mdx

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { Meta } from '@storybook/addon-docs/blocks';
22
import { Footer, TableOfContent } from '@sb/components';
33
import { MessageStrip } from '@ui5/webcomponents-react';
44
import SbTagFilter from '@sb/images/sb-pkg-filter.png';
5+
import { Badge } from "@sb/components/Badge.js";
56

67
<Meta title="FAQ" />
78

@@ -25,12 +26,12 @@ import SbTagFilter from '@sb/images/sb-pkg-filter.png';
2526
<br />
2627
<br />
2728

28-
## Where can I find all compatible versions of `@ui5/webcomponents` and `@ui5/webcomponents-react`?
29+
## Where Can I Find All Compatible Versions of `@ui5/webcomponents` and `@ui5/webcomponents-react`?
2930

3031
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`.
3132
If you want to check which versions are compatible you can find a compatibility table [here](?path=/docs/getting-started--docs#add-ui5webcomponents-react-to-an-existing-app).
3233

33-
## What are "abstract" UI5 Web Components?
34+
## What Are "abstract" UI5 Web Components?
3435

3536
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.
3637

@@ -59,17 +60,17 @@ Rendering a `ComboBoxItem` with some custom HTML attributes...
5960

6061
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.
6162

62-
## How can I style elements inside the shadow root of a web component?
63+
## How Can I Style Elements Inside the Shadow Root of a Web Component?
6364

6465
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](?path=/docs/knowledge-base-styling--docs#css-shadow-parts).
6566

66-
## How can I reuse or change colors, fonts, etc. of UI5 Web Components for React?
67+
## How Can I Reuse or Change Colors, Fonts, etc. of UI5 Web Components for React?
6768

6869
UI5 Web Components for React comes with a [publicly available](https://github.com/SAP/theming-base-content) set of CSS variables that ensure the same look and feel across applications. Changing these values is not recommended, if you still need to customize them, you can find out more about this [here](?path=/docs/knowledge-base-styling--docs#styling-ui5-web-components-for-react-components).
6970

7071
To reuse these styles, you can either use the CSS variable, or use our [Theming Parameters](?path=/docs/knowledge-base-public-utils--docs#theming-parameters).
7172

72-
## Why is changing the theme not working?
73+
## Why Is Changing the Theme Not Working?
7374

7475
You have to ensure to import the `Assets` with the different themes, otherwise only the default theme will be used.
7576

@@ -79,19 +80,25 @@ import '@ui5/webcomponents-react/dist/Assets';
7980

8081
Further information about theming can be found in our and the UI5 Web Components [Theming documentation](?path=/docs/getting-started--docs#theming).
8182

82-
## How can I distinguish if a component is developed in the `ui5-webcomponents` or `ui5-webcomponents-react` repo?
83+
## How Can I Distinguish If a Component Is Developed in the `ui5-webcomponents` or `ui5-webcomponents-react` Repo?
8384

8485
Each component developed by the UI5 Web Components team ([`ui5-webcomponents`](https://github.com/SAP/ui5-webcomponents)) that is wrapped by the UI5 Web Components for React ([`ui5-webcomponents-react`](https://github.com/SAP/ui5-webcomponents-react)) wrapper includes the following note in its component description:
8586

8687
**Note**: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/)
8788

8889
If a component does not have this note, it is a React-only component provided exclusively by `ui5-webcomponents-react`.
8990

90-
Additionally, Storybook supports filtering by tags, allowing you to filter by different `ui5-webcomponents` packages as well:
91+
Additionally, Storybook supports filtering by tags, allowing you to filter by different `ui5-webcomponents(-react)` packages as well:
9192

92-
<img src={SbTagFilter} alt="Storybook Tag Filter" height={320} />
93+
<img src={SbTagFilter} alt="Storybook Tag Filter" height={420} />
9394

94-
## Why isn't scoping working?
95+
## What Do the Badges in the Side Navigation Mean?
96+
97+
- <Badge type="custom" />: There are no global design or UX specifications for this component, or it deviates from them partially or fully. More details can be found in the component’s description.
98+
- <Badge type="experimental" />: The component or pattern is in an experimental state, meaning changes to its public API may occur without a major version update (`v3.0.0`).
99+
- <Badge type="deprecated" />: The component is deprecated and will be removed in the next major version update (`v3.0.0`). More details can be found the component's description.
100+
101+
## Why Isn't Scoping working?
95102

96103
Starting from UI5 Web Components (for React) 2.0.0, the order of imports with regard to scoping and components matters.
97104
Setting the scoping suffix must be done before importing any components, as they use the suffix at the top-level of the module - meaning when a component is imported, the suffix has to be known.

0 commit comments

Comments
 (0)