docs: add experimental jsdoc tag to components (#9304)

SAP · Jun 26, 2024 · ed263d0 · ed263d0
1 parent 36c9c8f
commit ed263d0
Show file tree

Hide file tree

Showing 22 changed files with 18 additions and 54 deletions.
diff --git a/packages/ai/src/Button.ts b/packages/ai/src/Button.ts
@@ -41,6 +41,7 @@ import ButtonCss from "./generated/themes/Button.css.js";
  * @extends UI5Element
  * @since 2.0
  * @public
+ * @experimental The Button and ButtonState web components are availabe since 2.0 under an experimental flag and their API and behaviour are subject to change.
  */
 
 @customElement({
@@ -59,10 +60,6 @@ import ButtonCss from "./generated/themes/Button.css.js";
  * @public
  */
 @event("click")
-
-/**
- * @experimental
- */
 class Button extends UI5Element {
 	/**
 	 * Defines the component design.

diff --git a/packages/ai/src/ButtonState.ts b/packages/ai/src/ButtonState.ts
@@ -22,12 +22,9 @@ import property from "@ui5/webcomponents-base/dist/decorators/property.js";
  * @abstract
  * @since 2.0
  * @public
+ * @experimental The Button and ButtonState web components are availabe since 2.0 under an experimental flag and their API and behaviour are subject to change.
  */
 @customElement("ui5-ai-button-state")
-
-/**
- * @experimental
- */
 class ButtonState extends UI5Element {
 	/**
 	 * Defines the name of the button state.

diff --git a/packages/ai/src/PromptInput.ts b/packages/ai/src/PromptInput.ts
@@ -40,6 +40,7 @@ import PromptInputCss from "./generated/themes/PromptInput.css.js";
  * @constructor
  * @public
  * @extends UI5Element
+ * @experimental The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.
  */
 @customElement({
 	tag: "ui5-ai-prompt-input",

diff --git a/packages/main/src/Table.ts b/packages/main/src/Table.ts
@@ -29,6 +29,7 @@ import TableCell from "./TableCell.js";
  * Interface for components that can be slotted inside the <code>features</code> slot of the <code>ui5-table</code>.
  *
  * @public
+ * @experimental
  */
 interface ITableFeature extends UI5Element {
 	/**
@@ -46,6 +47,7 @@ interface ITableFeature extends UI5Element {
  * Interface for components that can be slotted inside the <code>features</code> slot of the <code>ui5-table</code>
  * and provide growing/data loading functionality.
  * @public
+ * @experimental
  */
 interface ITableGrowing extends ITableFeature {
 	/**
@@ -141,6 +143,11 @@ type TableRowClickEventDetail = {
  * @extends UI5Element
  * @since 2.0
  * @public
+ * @experimental This Table web component is available since 2.0 and has been newly implemented to provide better screen reader and keyboard handling support.
+ * Currently, it's considered experimental as its API is subject to change.
+ * This Table replaces the previous Table web component, that has been part of **@ui5/webcomponents** version 1.x.
+ * For compatibility reasons, we moved the previous Tabple implementation to the **@ui5/webcomponents-compat** package
+ * and will be maintained until the new Table is experimental.
  */
 @customElement({
 	tag: "ui5-table",

diff --git a/packages/main/src/TableCell.ts b/packages/main/src/TableCell.ts
@@ -22,6 +22,7 @@ import { LABEL_COLON } from "./generated/i18n/i18n-defaults.js";
  * @extends TableCellBase
  * @since 2.0
  * @public
+ * @experimental This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
  */
 @customElement({
 	tag: "ui5-table-cell",

diff --git a/packages/main/src/TableGrowing.ts b/packages/main/src/TableGrowing.ts
@@ -56,6 +56,7 @@ import {
  * @extends UI5Element
  * @since 2.0
  * @public
+ * @experimental This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
  */
 @customElement({
 	tag: "ui5-table-growing",

diff --git a/packages/main/src/TableHeaderCell.ts b/packages/main/src/TableHeaderCell.ts
@@ -22,6 +22,7 @@ import TableHeaderCellStyles from "./generated/themes/TableHeaderCell.css.js";
  * @extends TableCellBase
  * @since 2.0
  * @public
+ * @experimental This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
  */
 @customElement({
 	tag: "ui5-table-header-cell",

diff --git a/packages/main/src/TableHeaderRow.ts b/packages/main/src/TableHeaderRow.ts
@@ -28,6 +28,7 @@ import {
  * @extends TableRowBase
  * @since 2.0
  * @public
+ * @experimental This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
  */
 @customElement({
 	tag: "ui5-table-header-row",

diff --git a/packages/main/src/TableRow.ts b/packages/main/src/TableRow.ts
@@ -25,6 +25,7 @@ import RadioButton from "./RadioButton.js";
  * @extends TableRowBase
  * @since 2.0
  * @public
+ * @experimental This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
  */
 @customElement({
 	tag: "ui5-table-row",

diff --git a/packages/main/src/TableSelection.ts b/packages/main/src/TableSelection.ts
@@ -48,6 +48,7 @@ import { isSelectionCheckbox, isHeaderSelector, findRowInPath } from "./TableUti
  * @extends UI5Element
  * @since 2.0
  * @public
+ * @experimental This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
  */
 @customElement({ tag: "ui5-table-selection" })
 

diff --git a/packages/website/docs/_components_pages/ai/Button/Button.mdx b/packages/website/docs/_components_pages/ai/Button/Button.mdx
@@ -6,10 +6,6 @@ sidebar_class_name: newComponentBadge expComponentBadge
 import ButtonMenu from "../../../_samples/ai/Button/ButtonMenu/ButtonMenu.md";
 import IconOnlyButton from "../../../_samples/ai/Button/IconOnlyButton/IconOnlyButton.md";
 
-:::info
-The Button and ButtonState web components are availabe since 2.0 under an experimental flag and their API and behaviour are subject to change.
-:::
-
 <%COMPONENT_OVERVIEW%>
 
 ## AI Button with Menu in one of the states

diff --git a/packages/website/docs/_components_pages/ai/Button/ButtonState.mdx b/packages/website/docs/_components_pages/ai/Button/ButtonState.mdx
@@ -3,10 +3,6 @@ slug: ../ButtonState
 sidebar_class_name: newComponentBadge expComponentBadge
 ---
 
-:::info
-The Button and ButtonState web components are availabe since 2.0 under an experimental flag and their API and behaviour are subject to change.
-:::
-
 <%COMPONENT_OVERVIEW%>
 
 <%COMPONENT_METADATA%>
diff --git a/packages/website/docs/_components_pages/ai/PromptInput.mdx b/packages/website/docs/_components_pages/ai/PromptInput.mdx
@@ -4,12 +4,6 @@ sidebar_class_name: newComponentBadge expComponentBadge
 
 import Basic from "../../_samples/ai/PromptInput/Basic/Basic.md";
 
-
-:::info
-The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.
-:::
-
-
 <%COMPONENT_OVERVIEW%>
 
 ## Basic Sample

diff --git a/packages/website/docs/_components_pages/fiori/DynamicPage/DynamicPageHeader.mdx b/packages/website/docs/_components_pages/fiori/DynamicPage/DynamicPageHeader.mdx
@@ -1,5 +1,6 @@
 ---
 slug: ../DynamicPageHeader
+sidebar_class_name: newComponentBadge
 ---
 
 <%COMPONENT_OVERVIEW%>

diff --git a/packages/website/docs/_components_pages/fiori/DynamicPage/DynamicPageTitle.mdx b/packages/website/docs/_components_pages/fiori/DynamicPage/DynamicPageTitle.mdx
@@ -1,5 +1,6 @@
 ---
 slug: ../DynamicPageTitle
+sidebar_class_name: newComponentBadge
 ---
 
 <%COMPONENT_OVERVIEW%>

diff --git a/packages/website/docs/_components_pages/main/Table/Table.mdx b/packages/website/docs/_components_pages/main/Table/Table.mdx
@@ -11,14 +11,6 @@ import StickyHeaderContainer from "../../../_samples/main/Table/StickyHeaderCont
 import NoDataSlot from "../../../_samples/main/Table/NoDataSlot/NoDataSlot.md";
 import Interactive from "../../../_samples/main/Table/Interactive/Interactive.md";
 
-:::info
-This Table web component is available since 2.0 and has been newly implemented to provide better screen reader and keyboard handling support.
-Currently, it's considered experimental as its API is subject to change.
-This Table replaces the previous Table web component, that has been part of **@ui5/webcomponents** version 1.x.
-For compatibility reasons, we moved the previous Tabple implementation to the **@ui5/webcomponents-compat** package
-and will be maintained until the new Table is experimental.
-:::
-
 <%COMPONENT_OVERVIEW%>
 
 ## Basic Sample

diff --git a/packages/website/docs/_components_pages/main/Table/TableCell.mdx b/packages/website/docs/_components_pages/main/Table/TableCell.mdx
@@ -3,10 +3,6 @@ slug: ../../TableCell
 sidebar_class_name: newComponentBadge expComponentBadge
 ---
 
-:::info
-This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
-:::
-
 <%COMPONENT_OVERVIEW%>
 
 <%COMPONENT_METADATA%>
diff --git a/packages/website/docs/_components_pages/main/Table/TableGrowing.mdx b/packages/website/docs/_components_pages/main/Table/TableGrowing.mdx
@@ -6,10 +6,6 @@ sidebar_class_name: newComponentBadge expComponentBadge
 import Growing from "../../../_samples/main/Table/Growing/Growing.md";
 import ScrollToLoad from "../../../_samples/main/Table/ScrollToLoad/ScrollToLoad.md";
 
-:::info
-This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
-:::
-
 <%COMPONENT_OVERVIEW%>
 
 <%COMPONENT_METADATA%>

diff --git a/packages/website/docs/_components_pages/main/Table/TableHeaderCell.mdx b/packages/website/docs/_components_pages/main/Table/TableHeaderCell.mdx
@@ -6,10 +6,6 @@ sidebar_class_name: newComponentBadge expComponentBadge
 import Popin from "../../../_samples/main/Table/Popin/Popin.md";
 import ColumnWidths from "../../../_samples/main/Table/ColumnWidths/ColumnWidths.md";
 
-:::info
-This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
-:::
-
 <%COMPONENT_OVERVIEW%>
 
 <%COMPONENT_METADATA%>

diff --git a/packages/website/docs/_components_pages/main/Table/TableHeaderRow.mdx b/packages/website/docs/_components_pages/main/Table/TableHeaderRow.mdx
@@ -6,10 +6,6 @@ sidebar_class_name: newComponentBadge expComponentBadge
 import StickyHeader from "../../../_samples/main/Table/StickyHeader/StickyHeader.md";
 import StickyHeaderContainer from "../../../_samples/main/Table/StickyHeaderContainer/StickyHeaderContainer.md";
 
-:::info
-This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
-:::
-
 <%COMPONENT_OVERVIEW%>
 
 <%COMPONENT_METADATA%>

diff --git a/packages/website/docs/_components_pages/main/Table/TableRow.mdx b/packages/website/docs/_components_pages/main/Table/TableRow.mdx
@@ -5,10 +5,6 @@ sidebar_class_name: newComponentBadge expComponentBadge
 
 import Interactive from "../../../_samples/main/Table/Interactive/Interactive.md";
 
-:::info
-This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
-:::
-
 <%COMPONENT_OVERVIEW%>
 
 <%COMPONENT_METADATA%>

diff --git a/packages/website/docs/_components_pages/main/Table/TableSelection.mdx b/packages/website/docs/_components_pages/main/Table/TableSelection.mdx
@@ -5,10 +5,6 @@ sidebar_class_name: newComponentBadge expComponentBadge
 
 import Selection from "../../../_samples/main/Table/Selection/Selection.md";
 
-:::info
-This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change.
-:::
-
 <%COMPONENT_OVERVIEW%>
 
 <%COMPONENT_METADATA%>