diff --git a/.gitignore b/.gitignore index a9b6496fcf5..3c12cbc5481 100644 --- a/.gitignore +++ b/.gitignore @@ -31,3 +31,5 @@ cypress/downloads .nx debug-storybook.log + +.vscode diff --git a/package.json b/package.json index aaa0f2c041b..af1d4d8f9a8 100644 --- a/package.json +++ b/package.json @@ -21,10 +21,10 @@ "prettier:all": "prettier --write --config ./prettier.config.js \"**/*\"", "lint": "eslint .", "lerna:version-dryrun": "lerna version --conventional-graduate --no-git-tag-version --no-push", - "wrappers:main": "node packages/cli/dist/bin/index.js create-wrappers --packageName @ui5/webcomponents --out ./packages/main/src/webComponents --additionalComponentNote 'This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/)'", - "wrappers:fiori": "node packages/cli/dist/bin/index.js create-wrappers --packageName @ui5/webcomponents-fiori --out ./packages/main/src/webComponents --additionalComponentNote 'This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/)'", - "wrappers:compat": "WITH_WEB_COMPONENT_IMPORT_PATH='@ui5/webcomponents-react-base/withWebComponent' node packages/cli/dist/bin/index.js create-wrappers --packageName @ui5/webcomponents-compat --out ./packages/compat/src/components --additionalComponentNote 'This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/)' && prettier --log-level silent --write ./packages/compat/src/components", - "wrappers:ai": "node packages/cli/dist/bin/index.js create-wrappers --packageName @ui5/webcomponents-ai --out ./packages/ai/src/components --additionalComponentNote 'This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/)' && prettier --log-level silent --write ./packages/ai/src/components", + "wrappers:main": "WITH_WEB_COMPONENT_DOCS_LINK='true' node packages/cli/dist/bin/index.js create-wrappers --packageName @ui5/webcomponents --out ./packages/main/src/webComponents", + "wrappers:fiori": "WITH_WEB_COMPONENT_DOCS_LINK='true' node packages/cli/dist/bin/index.js create-wrappers --packageName @ui5/webcomponents-fiori --out ./packages/main/src/webComponents", + "wrappers:compat": "WITH_WEB_COMPONENT_DOCS_LINK='true' WITH_WEB_COMPONENT_IMPORT_PATH='@ui5/webcomponents-react-base/withWebComponent' node packages/cli/dist/bin/index.js create-wrappers --packageName @ui5/webcomponents-compat --out ./packages/compat/src/components && prettier --log-level silent --write ./packages/compat/src/components", + "wrappers:ai": "WITH_WEB_COMPONENT_DOCS_LINK='true' node packages/cli/dist/bin/index.js create-wrappers --packageName @ui5/webcomponents-ai --out ./packages/ai/src/components && prettier --log-level silent --write ./packages/ai/src/components", "create-webcomponents-wrapper": "(cd packages/cli && tsc) && yarn run wrappers:main && yarn run wrappers:fiori && prettier --log-level silent --write ./packages/main/src/webComponents && eslint --fix ./packages/main/src/webComponents/*/index.tsx && yarn run sb:prepare-cem", "create-webcomponents-wrapper-compat": "(cd packages/cli && tsc) && yarn run wrappers:compat && yarn run sb:prepare-cem && eslint --fix ./packages/compat/src/components/*/index.tsx", "create-webcomponents-wrapper-ai": "(cd packages/cli && tsc) && yarn run wrappers:ai && yarn run sb:prepare-cem && eslint --fix ./packages/ai/src/components/*/index.tsx", diff --git a/packages/ai/src/components/Button/index.tsx b/packages/ai/src/components/Button/index.tsx index ae7de0d7151..9a0b73d22a1 100644 --- a/packages/ai/src/components/Button/index.tsx +++ b/packages/ai/src/components/Button/index.tsx @@ -71,6 +71,8 @@ interface ButtonPropTypes * Defines the available states of the component. * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that * you only use `ButtonState` components in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; /** @@ -114,7 +116,7 @@ interface ButtonPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Button UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ai/Button) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents-ai__. * @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. diff --git a/packages/ai/src/components/ButtonState/index.tsx b/packages/ai/src/components/ButtonState/index.tsx index 2f252a43bb0..77bbd8c4cac 100644 --- a/packages/ai/src/components/ButtonState/index.tsx +++ b/packages/ai/src/components/ButtonState/index.tsx @@ -62,7 +62,7 @@ interface ButtonStatePropTypes extends ButtonStateAttributes, Omit`, `` and `ui5-suggestion-item-custom` are recommended to be used as suggestion items. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -131,6 +133,8 @@ interface PromptInputPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-ai**. + * + * __Supported Node Type/s:__ `Array` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -177,7 +181,7 @@ interface PromptInputPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [PromptInput UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ai/PromptInput) | [Repository](https://github.com/UI5/webcomponents) * @experimental The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change. */ const PromptInput = withWebComponent( diff --git a/packages/cli/src/scripts/create-wrappers/ComponentRenderer.ts b/packages/cli/src/scripts/create-wrappers/ComponentRenderer.ts index a572ce86280..39b31572573 100644 --- a/packages/cli/src/scripts/create-wrappers/ComponentRenderer.ts +++ b/packages/cli/src/scripts/create-wrappers/ComponentRenderer.ts @@ -4,6 +4,7 @@ import { sinceFilter, snakeCaseToCamelCase, summaryFormatter } from '../../util/ import { AbstractRenderer, RenderingPhase } from './AbstractRenderer.js'; import type { WebComponentWrapper } from './WebComponentWrapper.js'; +const WITH_WEB_COMPONENT_DOCS_LINK = process.env.WITH_WEB_COMPONENT_DOCS_LINK ?? 'false'; export class ComponentRenderer extends AbstractRenderer { public phase = RenderingPhase.component; @@ -72,6 +73,18 @@ export class ComponentRenderer extends AbstractRenderer { if (this.note) { comment += ` * __Note__: ${this.note}\n`; } + if (WITH_WEB_COMPONENT_DOCS_LINK === 'true') { + let ui5wcUrl = 'https://ui5.github.io/webcomponents/components/'; + if (context.packageName === '@ui5/webcomponents-fiori') { + ui5wcUrl += 'fiori/'; + } else if (context.packageName === '@ui5/webcomponents-ai') { + ui5wcUrl += 'ai/'; + } else if (context.packageName === '@ui5/webcomponents-compat') { + ui5wcUrl += 'compat/'; + } + ui5wcUrl += context.componentName; + comment += ` * __Note:__ This is a UI5 Web Component! [${context.componentName} UI5 Web Component Documentation](${ui5wcUrl}) | [Repository](https://github.com/UI5/webcomponents)\n`; + } if (sinceFilter(this.since)) { comment += ` *\n`; comment += ` * @since [${this.since}](https://github.com/UI5/webcomponents/releases/tag/v${this.since}) of __${context.packageName}__.\n`; diff --git a/packages/cli/src/scripts/create-wrappers/PropTypesRenderer.ts b/packages/cli/src/scripts/create-wrappers/PropTypesRenderer.ts index ec575e8a7e0..79a38957b6c 100644 --- a/packages/cli/src/scripts/create-wrappers/PropTypesRenderer.ts +++ b/packages/cli/src/scripts/create-wrappers/PropTypesRenderer.ts @@ -81,6 +81,12 @@ export class PropTypesRenderer extends AbstractRenderer { } } + const slotType = slot._ui5type; + if (slotType) { + descriptionParts.push(` *`); + descriptionParts.push(` * __Supported Node Type/s:__ \`${slotType.text ?? 'unknown'}\``); + } + return `/**\n${descriptionParts.join('\n')}\n */\n${snakeCaseToCamelCase(slot.name)}?: ${ isDefaultSlot ? 'ReactNode | ReactNode[]' : 'UI5WCSlotsNode' }`; diff --git a/packages/compat/src/components/Table/index.tsx b/packages/compat/src/components/Table/index.tsx index 44b4f022860..5886e5de707 100644 --- a/packages/compat/src/components/Table/index.tsx +++ b/packages/compat/src/components/Table/index.tsx @@ -155,6 +155,8 @@ interface TablePropTypes * Defines the component rows. * * **Note:** Use `TableRow` for the intended design. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -168,6 +170,8 @@ interface TablePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ columns?: UI5WCSlotsNode; /** @@ -269,7 +273,7 @@ interface TablePropTypes * - `import "@ui5/webcomponents-compat/dist/TableGroupRow.js";` (`TableGroupRow`) * - `import "@ui5/webcomponents-compat/dist/TableCell.js";` (`TableCell`) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Table UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/compat/Table) | [Repository](https://github.com/UI5/webcomponents) * @deprecated Deprecated as of version 2.12.0, use `@ui5/webcomponents/dist/Table.js` instead. */ const Table = withWebComponent( diff --git a/packages/compat/src/components/TableCell/index.tsx b/packages/compat/src/components/TableCell/index.tsx index 587dd352045..f55e3a72d9d 100644 --- a/packages/compat/src/components/TableCell/index.tsx +++ b/packages/compat/src/components/TableCell/index.tsx @@ -16,6 +16,8 @@ interface TableCellDomRef extends Required, Ui5DomRef {} interface TableCellPropTypes extends TableCellAttributes, Omit { /** * Specifies the content of the component. + * + * __Supported Node Type/s:__ `Array | undefined` */ children?: ReactNode | ReactNode[]; } @@ -23,7 +25,7 @@ interface TableCellPropTypes extends TableCellAttributes, Omit(`ui5-table-cell${tagSuffix}`, [], [], [], []); diff --git a/packages/compat/src/components/TableColumn/index.tsx b/packages/compat/src/components/TableColumn/index.tsx index 06c23dd0cf8..fc11567384a 100644 --- a/packages/compat/src/components/TableColumn/index.tsx +++ b/packages/compat/src/components/TableColumn/index.tsx @@ -56,6 +56,8 @@ interface TableColumnPropTypes Omit { /** * Defines the content of the column header + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; } @@ -64,7 +66,7 @@ interface TableColumnPropTypes * The `TableColumn` component allows to define column specific properties that are applied * when rendering the `Table` component. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableColumn UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/compat/TableColumn) | [Repository](https://github.com/UI5/webcomponents) * @deprecated Deprecated as of version 2.12.0, use `@ui5/webcomponents/dist/Table.js` instead. */ const TableColumn = withWebComponent( diff --git a/packages/compat/src/components/TableGroupRow/index.tsx b/packages/compat/src/components/TableGroupRow/index.tsx index 040f193ebba..888578f07e7 100644 --- a/packages/compat/src/components/TableGroupRow/index.tsx +++ b/packages/compat/src/components/TableGroupRow/index.tsx @@ -18,6 +18,8 @@ interface TableGroupRowPropTypes extends TableGroupRowAttributes, Omit` */ children?: ReactNode | ReactNode[]; } @@ -25,7 +27,7 @@ interface TableGroupRowPropTypes extends TableGroupRowAttributes, Omit` */ children?: ReactNode | ReactNode[]; } @@ -53,7 +55,7 @@ interface TableRowPropTypes extends TableRowAttributes, Omit( diff --git a/packages/main/src/webComponents/Avatar/index.tsx b/packages/main/src/webComponents/Avatar/index.tsx index f55746ccbd5..19744e90162 100644 --- a/packages/main/src/webComponents/Avatar/index.tsx +++ b/packages/main/src/webComponents/Avatar/index.tsx @@ -131,6 +131,8 @@ interface AvatarPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.7.0](https://github.com/UI5/webcomponents/releases/tag/v1.7.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array` */ badge?: UI5WCSlotsNode; @@ -141,6 +143,8 @@ interface AvatarPropTypes * `ui5-avatar:not(:defined) {`
*     `visibility: hidden;`
* `}` + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; /** @@ -172,7 +176,7 @@ interface AvatarPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Avatar UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Avatar) | [Repository](https://github.com/UI5/webcomponents) */ const Avatar = withWebComponent( 'ui5-avatar', diff --git a/packages/main/src/webComponents/AvatarGroup/index.tsx b/packages/main/src/webComponents/AvatarGroup/index.tsx index 1ded316d2be..585998c7785 100644 --- a/packages/main/src/webComponents/AvatarGroup/index.tsx +++ b/packages/main/src/webComponents/AvatarGroup/index.tsx @@ -72,6 +72,8 @@ interface AvatarGroupPropTypes * * Moreover, if you use avatars with "Square" shape, there will be visual inconsistency * as the built-in overflow action has "Circle" shape. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -87,6 +89,8 @@ interface AvatarGroupPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ overflowButton?: UI5WCSlotsNode; /** @@ -163,7 +167,7 @@ interface AvatarGroupPropTypes * - [Tab] - Move focus to the next interactive element after the component * - [Space] / [Enter] or [Return] - Trigger `ui5-click` event * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [AvatarGroup UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/AvatarGroup) | [Repository](https://github.com/UI5/webcomponents) */ const AvatarGroup = withWebComponent( 'ui5-avatar-group', diff --git a/packages/main/src/webComponents/Bar/index.tsx b/packages/main/src/webComponents/Bar/index.tsx index e16a85bebc1..a81e2d687cc 100644 --- a/packages/main/src/webComponents/Bar/index.tsx +++ b/packages/main/src/webComponents/Bar/index.tsx @@ -36,6 +36,8 @@ interface BarPropTypes Omit { /** * Defines the content in the middle of the bar. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -47,6 +49,8 @@ interface BarPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ endContent?: UI5WCSlotsNode; @@ -58,6 +62,8 @@ interface BarPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ startContent?: UI5WCSlotsNode; } @@ -86,7 +92,7 @@ interface BarPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Bar UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Bar) | [Repository](https://github.com/UI5/webcomponents) */ const Bar = withWebComponent( 'ui5-bar', diff --git a/packages/main/src/webComponents/BarcodeScannerDialog/index.tsx b/packages/main/src/webComponents/BarcodeScannerDialog/index.tsx index 0ef7fa07771..61317c8168e 100644 --- a/packages/main/src/webComponents/BarcodeScannerDialog/index.tsx +++ b/packages/main/src/webComponents/BarcodeScannerDialog/index.tsx @@ -43,6 +43,8 @@ interface BarcodeScannerDialogPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.4.0](https://github.com/UI5/webcomponents/releases/tag/v2.4.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array` */ footer?: UI5WCSlotsNode; @@ -59,6 +61,8 @@ interface BarcodeScannerDialogPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.4.0](https://github.com/UI5/webcomponents/releases/tag/v2.4.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array` */ header?: UI5WCSlotsNode; /** @@ -104,7 +108,7 @@ interface BarcodeScannerDialogPropTypes * * For a list of supported barcode formats, see the [zxing-js/library](https://github.com/zxing-js/library) documentation. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [BarcodeScannerDialog UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/BarcodeScannerDialog) | [Repository](https://github.com/UI5/webcomponents) */ const BarcodeScannerDialog = withWebComponent( 'ui5-barcode-scanner-dialog', diff --git a/packages/main/src/webComponents/Breadcrumbs/index.tsx b/packages/main/src/webComponents/Breadcrumbs/index.tsx index 657242521d2..0caad8971e2 100644 --- a/packages/main/src/webComponents/Breadcrumbs/index.tsx +++ b/packages/main/src/webComponents/Breadcrumbs/index.tsx @@ -35,6 +35,8 @@ interface BreadcrumbsPropTypes * Defines the component items. * * **Note:** Use the `BreadcrumbsItem` component to define the desired items. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; /** @@ -73,7 +75,7 @@ interface BreadcrumbsPropTypes * - [Home] - Navigates to the first item. * - [End] - Navigates to the last item. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Breadcrumbs UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Breadcrumbs) | [Repository](https://github.com/UI5/webcomponents) */ const Breadcrumbs = withWebComponent( 'ui5-breadcrumbs', diff --git a/packages/main/src/webComponents/BreadcrumbsItem/index.tsx b/packages/main/src/webComponents/BreadcrumbsItem/index.tsx index 1dfd03fb379..07c97c3f12c 100644 --- a/packages/main/src/webComponents/BreadcrumbsItem/index.tsx +++ b/packages/main/src/webComponents/BreadcrumbsItem/index.tsx @@ -46,6 +46,8 @@ interface BreadcrumbsItemPropTypes * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; } @@ -53,7 +55,7 @@ interface BreadcrumbsItemPropTypes /** * The `BreadcrumbsItem` component defines the content of an item in `Breadcrumbs`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [BreadcrumbsItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/BreadcrumbsItem) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const BreadcrumbsItem = withWebComponent( diff --git a/packages/main/src/webComponents/BusyIndicator/index.tsx b/packages/main/src/webComponents/BusyIndicator/index.tsx index d6e60f52677..7dd48b19ac6 100644 --- a/packages/main/src/webComponents/BusyIndicator/index.tsx +++ b/packages/main/src/webComponents/BusyIndicator/index.tsx @@ -46,6 +46,8 @@ interface BusyIndicatorPropTypes Omit { /** * Determines the content over which the component will appear. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; } @@ -77,7 +79,7 @@ interface BusyIndicatorPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [BusyIndicator UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/BusyIndicator) | [Repository](https://github.com/UI5/webcomponents) */ const BusyIndicator = withWebComponent( 'ui5-busy-indicator', diff --git a/packages/main/src/webComponents/Button/index.tsx b/packages/main/src/webComponents/Button/index.tsx index e8ab2df62bf..50e2f5a5be9 100644 --- a/packages/main/src/webComponents/Button/index.tsx +++ b/packages/main/src/webComponents/Button/index.tsx @@ -162,6 +162,8 @@ interface ButtonPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.7.0](https://github.com/UI5/webcomponents/releases/tag/v2.7.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array` */ badge?: UI5WCSlotsNode; @@ -169,6 +171,8 @@ interface ButtonPropTypes * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; /** @@ -207,7 +211,7 @@ interface ButtonPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Button UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Button) | [Repository](https://github.com/UI5/webcomponents) */ const Button = withWebComponent( 'ui5-button', diff --git a/packages/main/src/webComponents/ButtonBadge/index.tsx b/packages/main/src/webComponents/ButtonBadge/index.tsx index 7dc43c4926c..66444393afa 100644 --- a/packages/main/src/webComponents/ButtonBadge/index.tsx +++ b/packages/main/src/webComponents/ButtonBadge/index.tsx @@ -38,7 +38,7 @@ interface ButtonBadgePropTypes extends ButtonBadgeAttributes, Omit` */ calendarLegend?: UI5WCSlotsNode; @@ -113,6 +115,8 @@ interface CalendarPropTypes * Defines the selected date or dates (depending on the `selectionMode` property) * for this calendar as instances of `CalendarDate` or `CalendarDateRange`. * Use `CalendarDate` for single or multiple selection, and `CalendarDateRange` for range selection. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -126,6 +130,8 @@ interface CalendarPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.23.0](https://github.com/UI5/webcomponents/releases/tag/v1.23.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array` */ specialDates?: UI5WCSlotsNode; /** @@ -230,7 +236,7 @@ interface CalendarPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Calendar UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Calendar) | [Repository](https://github.com/UI5/webcomponents) */ const Calendar = withWebComponent( 'ui5-calendar', diff --git a/packages/main/src/webComponents/CalendarDate/index.tsx b/packages/main/src/webComponents/CalendarDate/index.tsx index b2dbbbd2aed..f81d6d80c25 100644 --- a/packages/main/src/webComponents/CalendarDate/index.tsx +++ b/packages/main/src/webComponents/CalendarDate/index.tsx @@ -19,7 +19,7 @@ interface CalendarDatePropTypes extends CalendarDateAttributes, Omit('ui5-date', ['value'], [], [], []); diff --git a/packages/main/src/webComponents/CalendarDateRange/index.tsx b/packages/main/src/webComponents/CalendarDateRange/index.tsx index 9812d81b972..63ef770ebe6 100644 --- a/packages/main/src/webComponents/CalendarDateRange/index.tsx +++ b/packages/main/src/webComponents/CalendarDateRange/index.tsx @@ -27,7 +27,7 @@ interface CalendarDateRangePropTypes /** * The `CalendarDateRange` component defines a range of dates to be used inside `Calendar` * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [CalendarDateRange UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/CalendarDateRange) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. * @abstract diff --git a/packages/main/src/webComponents/CalendarLegend/index.tsx b/packages/main/src/webComponents/CalendarLegend/index.tsx index 77d9545acbb..b33bab986a5 100644 --- a/packages/main/src/webComponents/CalendarLegend/index.tsx +++ b/packages/main/src/webComponents/CalendarLegend/index.tsx @@ -38,6 +38,8 @@ interface CalendarLegendPropTypes Omit { /** * Defines the items of the component. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; } @@ -49,7 +51,7 @@ interface CalendarLegendPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [CalendarLegend UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/CalendarLegend) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.23.0](https://github.com/UI5/webcomponents/releases/tag/v1.23.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/CalendarLegendItem/index.tsx b/packages/main/src/webComponents/CalendarLegendItem/index.tsx index 982a732255f..f96e2dfdbe3 100644 --- a/packages/main/src/webComponents/CalendarLegendItem/index.tsx +++ b/packages/main/src/webComponents/CalendarLegendItem/index.tsx @@ -36,7 +36,7 @@ interface CalendarLegendItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [CalendarLegendItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/CalendarLegendItem) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.23.0](https://github.com/UI5/webcomponents/releases/tag/v1.23.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/Card/index.tsx b/packages/main/src/webComponents/Card/index.tsx index 271194c4d70..c08911eb24d 100644 --- a/packages/main/src/webComponents/Card/index.tsx +++ b/packages/main/src/webComponents/Card/index.tsx @@ -42,6 +42,8 @@ interface CardDomRef extends Required, Ui5DomRef {} interface CardPropTypes extends CardAttributes, Omit { /** * Defines the content of the component. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -55,6 +57,8 @@ interface CardPropTypes extends CardAttributes, Omit` */ header?: UI5WCSlotsNode; } @@ -71,7 +75,7 @@ interface CardPropTypes extends CardAttributes, Omit( 'ui5-card', diff --git a/packages/main/src/webComponents/CardHeader/index.tsx b/packages/main/src/webComponents/CardHeader/index.tsx index 9b8288b3edd..3dfdd356d11 100644 --- a/packages/main/src/webComponents/CardHeader/index.tsx +++ b/packages/main/src/webComponents/CardHeader/index.tsx @@ -44,6 +44,8 @@ interface CardHeaderPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ action?: UI5WCSlotsNode; @@ -55,6 +57,8 @@ interface CardHeaderPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ avatar?: UI5WCSlotsNode; /** @@ -79,7 +83,7 @@ interface CardHeaderPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [CardHeader UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/CardHeader) | [Repository](https://github.com/UI5/webcomponents) */ const CardHeader = withWebComponent( 'ui5-card-header', diff --git a/packages/main/src/webComponents/Carousel/index.tsx b/packages/main/src/webComponents/Carousel/index.tsx index f0d05e13f9f..1de05c7cc0e 100644 --- a/packages/main/src/webComponents/Carousel/index.tsx +++ b/packages/main/src/webComponents/Carousel/index.tsx @@ -127,6 +127,8 @@ interface CarouselPropTypes Omit { /** * Defines the content of the component. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; /** @@ -179,7 +181,7 @@ interface CarouselPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Carousel UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Carousel) | [Repository](https://github.com/UI5/webcomponents) */ const Carousel = withWebComponent( 'ui5-carousel', diff --git a/packages/main/src/webComponents/CheckBox/index.tsx b/packages/main/src/webComponents/CheckBox/index.tsx index af3de14bb21..3c4bd26dd23 100644 --- a/packages/main/src/webComponents/CheckBox/index.tsx +++ b/packages/main/src/webComponents/CheckBox/index.tsx @@ -175,7 +175,7 @@ interface CheckBoxPropTypes extends CheckBoxAttributes, Omit( 'ui5-checkbox', diff --git a/packages/main/src/webComponents/ColorPalette/index.tsx b/packages/main/src/webComponents/ColorPalette/index.tsx index 8ffeb05d867..4efb503205d 100644 --- a/packages/main/src/webComponents/ColorPalette/index.tsx +++ b/packages/main/src/webComponents/ColorPalette/index.tsx @@ -13,6 +13,8 @@ interface ColorPaletteDomRef extends Required, Ui5DomRef interface ColorPalettePropTypes extends ColorPaletteAttributes, Omit { /** * Defines the `ColorPaletteItem` elements. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; /** @@ -35,7 +37,7 @@ interface ColorPalettePropTypes extends ColorPaletteAttributes, Omit( 'ui5-color-palette', diff --git a/packages/main/src/webComponents/ColorPaletteItem/index.tsx b/packages/main/src/webComponents/ColorPaletteItem/index.tsx index c07cc6da5c4..e0f7b53afeb 100644 --- a/packages/main/src/webComponents/ColorPaletteItem/index.tsx +++ b/packages/main/src/webComponents/ColorPaletteItem/index.tsx @@ -33,7 +33,7 @@ interface ColorPaletteItemPropTypes /** * The `ColorPaletteItem` component represents a color in the the `ColorPalette`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ColorPaletteItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ColorPaletteItem) | [Repository](https://github.com/UI5/webcomponents) */ const ColorPaletteItem = withWebComponent( 'ui5-color-palette-item', diff --git a/packages/main/src/webComponents/ColorPalettePopover/index.tsx b/packages/main/src/webComponents/ColorPalettePopover/index.tsx index ca0e263c3f8..d4c4ab4cbd3 100644 --- a/packages/main/src/webComponents/ColorPalettePopover/index.tsx +++ b/packages/main/src/webComponents/ColorPalettePopover/index.tsx @@ -59,6 +59,8 @@ interface ColorPalettePopoverPropTypes Omit { /** * Defines the content of the component. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; /** @@ -98,7 +100,7 @@ interface ColorPalettePopoverPropTypes * For the `ColorPalettePopover` * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ColorPalettePopover UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ColorPalettePopover) | [Repository](https://github.com/UI5/webcomponents) */ const ColorPalettePopover = withWebComponent( 'ui5-color-palette-popover', diff --git a/packages/main/src/webComponents/ColorPicker/index.tsx b/packages/main/src/webComponents/ColorPicker/index.tsx index 1fb0764857e..5750f0a7f63 100644 --- a/packages/main/src/webComponents/ColorPicker/index.tsx +++ b/packages/main/src/webComponents/ColorPicker/index.tsx @@ -63,7 +63,7 @@ interface ColorPickerPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ColorPicker UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ColorPicker) | [Repository](https://github.com/UI5/webcomponents) */ const ColorPicker = withWebComponent( 'ui5-color-picker', diff --git a/packages/main/src/webComponents/ComboBox/index.tsx b/packages/main/src/webComponents/ComboBox/index.tsx index ce9aae17cd3..18a677fe4a0 100644 --- a/packages/main/src/webComponents/ComboBox/index.tsx +++ b/packages/main/src/webComponents/ComboBox/index.tsx @@ -127,6 +127,8 @@ interface ComboBoxPropTypes > { /** * Defines the component items. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -138,6 +140,8 @@ interface ComboBoxPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ icon?: UI5WCSlotsNode; @@ -155,6 +159,8 @@ interface ComboBoxPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -238,7 +244,7 @@ interface ComboBoxPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ComboBox UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ComboBox) | [Repository](https://github.com/UI5/webcomponents) */ const ComboBox = withWebComponent( 'ui5-combobox', diff --git a/packages/main/src/webComponents/ComboBoxItem/index.tsx b/packages/main/src/webComponents/ComboBoxItem/index.tsx index 733e8806b6b..41ae9990f45 100644 --- a/packages/main/src/webComponents/ComboBoxItem/index.tsx +++ b/packages/main/src/webComponents/ComboBoxItem/index.tsx @@ -25,7 +25,7 @@ interface ComboBoxItemPropTypes extends ComboBoxItemAttributes, Omit( 'ui5-cb-item', diff --git a/packages/main/src/webComponents/ComboBoxItemGroup/index.tsx b/packages/main/src/webComponents/ComboBoxItemGroup/index.tsx index 21ac1bd6e97..77ca7a8f743 100644 --- a/packages/main/src/webComponents/ComboBoxItemGroup/index.tsx +++ b/packages/main/src/webComponents/ComboBoxItemGroup/index.tsx @@ -46,6 +46,8 @@ interface ComboBoxItemGroupPropTypes Omit { /** * Defines the items of the ui5-cb-item-group. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -59,6 +61,8 @@ interface ComboBoxItemGroupPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ header?: UI5WCSlotsNode; /** @@ -94,7 +98,7 @@ interface ComboBoxItemGroupPropTypes * The `ui5-cb-group-item` is type of suggestion item, * that can be used to split the `ComboBox` suggestions into groups. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ComboBoxItemGroup UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ComboBoxItemGroup) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const ComboBoxItemGroup = withWebComponent( diff --git a/packages/main/src/webComponents/DatePicker/index.tsx b/packages/main/src/webComponents/DatePicker/index.tsx index c8791042f5a..1069f4fb8fb 100644 --- a/packages/main/src/webComponents/DatePicker/index.tsx +++ b/packages/main/src/webComponents/DatePicker/index.tsx @@ -236,6 +236,8 @@ interface DatePickerPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -367,7 +369,7 @@ interface DatePickerPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [DatePicker UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/DatePicker) | [Repository](https://github.com/UI5/webcomponents) */ const DatePicker = withWebComponent( 'ui5-date-picker', diff --git a/packages/main/src/webComponents/DateRangePicker/index.tsx b/packages/main/src/webComponents/DateRangePicker/index.tsx index 9b8be61960b..de9c71206e8 100644 --- a/packages/main/src/webComponents/DateRangePicker/index.tsx +++ b/packages/main/src/webComponents/DateRangePicker/index.tsx @@ -258,6 +258,8 @@ interface DateRangePickerPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -341,7 +343,7 @@ interface DateRangePickerPropTypes * - [Shift] + [Page Up] - Increments the corresponding month by one * - [Shift] + [Ctrl] + [Page Up] - Increments the corresponding year by one * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [DateRangePicker UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/DateRangePicker) | [Repository](https://github.com/UI5/webcomponents) */ const DateRangePicker = withWebComponent( 'ui5-daterange-picker', diff --git a/packages/main/src/webComponents/DateTimePicker/index.tsx b/packages/main/src/webComponents/DateTimePicker/index.tsx index dec5ed22a04..a9e6af19c36 100644 --- a/packages/main/src/webComponents/DateTimePicker/index.tsx +++ b/packages/main/src/webComponents/DateTimePicker/index.tsx @@ -236,6 +236,8 @@ interface DateTimePickerPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -349,7 +351,7 @@ interface DateTimePickerPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [DateTimePicker UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/DateTimePicker) | [Repository](https://github.com/UI5/webcomponents) */ const DateTimePicker = withWebComponent( 'ui5-datetime-picker', diff --git a/packages/main/src/webComponents/Dialog/index.tsx b/packages/main/src/webComponents/Dialog/index.tsx index 85b0b556f0d..1214702dffe 100644 --- a/packages/main/src/webComponents/Dialog/index.tsx +++ b/packages/main/src/webComponents/Dialog/index.tsx @@ -155,6 +155,8 @@ interface DialogPropTypes > { /** * Defines the content of the Popup. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -168,6 +170,8 @@ interface DialogPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ footer?: UI5WCSlotsNode; @@ -184,6 +188,8 @@ interface DialogPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ header?: UI5WCSlotsNode; /** @@ -271,7 +277,7 @@ interface DialogPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Dialog UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Dialog) | [Repository](https://github.com/UI5/webcomponents) */ const Dialog = withWebComponent( 'ui5-dialog', diff --git a/packages/main/src/webComponents/DynamicDateRange/index.tsx b/packages/main/src/webComponents/DynamicDateRange/index.tsx index e05ee3c43f3..07dd3a0ef11 100644 --- a/packages/main/src/webComponents/DynamicDateRange/index.tsx +++ b/packages/main/src/webComponents/DynamicDateRange/index.tsx @@ -76,7 +76,7 @@ interface DynamicDateRangePropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [DynamicDateRange UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/DynamicDateRange) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.11.0](https://github.com/UI5/webcomponents/releases/tag/v2.11.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/DynamicPage/index.tsx b/packages/main/src/webComponents/DynamicPage/index.tsx index 4813c88f823..1eed5cd79ee 100644 --- a/packages/main/src/webComponents/DynamicPage/index.tsx +++ b/packages/main/src/webComponents/DynamicPage/index.tsx @@ -47,6 +47,8 @@ interface DynamicPagePropTypes > { /** * Defines the content of the Dynamic Page. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -58,6 +60,8 @@ interface DynamicPagePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ footerArea?: UI5WCSlotsNode; @@ -69,6 +73,8 @@ interface DynamicPagePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ headerArea?: UI5WCSlotsNode; @@ -80,6 +86,8 @@ interface DynamicPagePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ titleArea?: UI5WCSlotsNode; /** @@ -148,7 +156,7 @@ interface DynamicPagePropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [DynamicPage UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/DynamicPage) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents-fiori__. */ diff --git a/packages/main/src/webComponents/DynamicPageHeader/index.tsx b/packages/main/src/webComponents/DynamicPageHeader/index.tsx index 194c5408983..70c6c1f6d1c 100644 --- a/packages/main/src/webComponents/DynamicPageHeader/index.tsx +++ b/packages/main/src/webComponents/DynamicPageHeader/index.tsx @@ -12,6 +12,8 @@ interface DynamicPageHeaderDomRef extends Required, interface DynamicPageHeaderPropTypes extends DynamicPageHeaderAttributes, Omit { /** * Defines the content of the Dynamic Page Header. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; } @@ -35,7 +37,7 @@ interface DynamicPageHeaderPropTypes extends DynamicPageHeaderAttributes, Omit` */ actionsBar?: UI5WCSlotsNode; @@ -42,11 +44,15 @@ interface DynamicPageTitlePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ breadcrumbs?: UI5WCSlotsNode; /** * Defines the content of the Dynamic page title. + * + * __Supported Node Type/s:__ `Array` */ children?: ReactNode | ReactNode[]; @@ -64,6 +70,8 @@ interface DynamicPageTitlePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ heading?: UI5WCSlotsNode; @@ -75,6 +83,8 @@ interface DynamicPageTitlePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ navigationBar?: UI5WCSlotsNode; @@ -86,6 +96,8 @@ interface DynamicPageTitlePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ snappedHeading?: UI5WCSlotsNode; @@ -97,6 +109,8 @@ interface DynamicPageTitlePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array` */ snappedSubheading?: UI5WCSlotsNode; @@ -117,6 +131,8 @@ interface DynamicPageTitlePropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.3.0](https://github.com/UI5/webcomponents/releases/tag/v2.3.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array` */ snappedTitleOnMobile?: UI5WCSlotsNode; @@ -128,6 +144,8 @@ interface DynamicPageTitlePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ subheading?: UI5WCSlotsNode; } @@ -156,7 +174,7 @@ interface DynamicPageTitlePropTypes * The responsive behavior of the `DynamicPageTitle` depends on the behavior of the * content that is displayed. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [DynamicPageTitle UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/DynamicPageTitle) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents-fiori__. */ diff --git a/packages/main/src/webComponents/DynamicSideContent/index.tsx b/packages/main/src/webComponents/DynamicSideContent/index.tsx index 90b6fdc5576..f30d0a0a9eb 100644 --- a/packages/main/src/webComponents/DynamicSideContent/index.tsx +++ b/packages/main/src/webComponents/DynamicSideContent/index.tsx @@ -80,6 +80,8 @@ interface DynamicSideContentPropTypes Omit<CommonProps, keyof DynamicSideContentAttributes | 'children' | 'sideContent' | 'onLayoutChange'> { /** * Defines the main content. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ children?: ReactNode | ReactNode[]; @@ -91,6 +93,8 @@ interface DynamicSideContentPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ sideContent?: UI5WCSlotsNode; /** @@ -164,7 +168,7 @@ interface DynamicSideContentPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [DynamicSideContent UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/DynamicSideContent) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.1.0](https://github.com/UI5/webcomponents/releases/tag/v1.1.0) of __@ui5/webcomponents-fiori__. */ diff --git a/packages/main/src/webComponents/ExpandableText/index.tsx b/packages/main/src/webComponents/ExpandableText/index.tsx index d1ed77e5295..ef0b0a808b0 100644 --- a/packages/main/src/webComponents/ExpandableText/index.tsx +++ b/packages/main/src/webComponents/ExpandableText/index.tsx @@ -5,36 +5,6 @@ import type ExpandableTextOverflowMode from '@ui5/webcomponents/dist/types/Expan import type TextEmptyIndicatorMode from '@ui5/webcomponents/dist/types/TextEmptyIndicatorMode.js'; import { withWebComponent } from '@ui5/webcomponents-react-base'; import type { CommonProps, Ui5DomRef } from '@ui5/webcomponents-react-base'; -import { addCustomCSSWithScoping } from '@ui5/webcomponents-react-base/internal/utils'; - -//todo: remove once ExpandableText supports setting white-space -addCustomCSSWithScoping( - 'ui5-expandable-text', - ` -:host([data-_render-whitespace]) [ui5-text]{ -white-space: pre-wrap; -}`, -); - -interface DeprecatedExpandableTextProps { - /** - * Text of the component. - * - * @deprecated: Please use `text` instead. - */ - children?: string; - /** - * Determines if the full text should be displayed inside a `ResponsivePopover` or in-place. - * - * @deprecated: Please use `overflowMode` instead. - */ - showOverflowInPopover?: boolean; - //todo: deprecate once white-space can be applied w/o addCustomCSS - /** - * Defines how white-space inside <code>Text</code> is handled. If set to true, sequences of white space are preserved. - */ - renderWhitespace?: boolean; -} interface ExpandableTextAttributes { /** @@ -64,10 +34,7 @@ interface ExpandableTextAttributes { interface ExpandableTextDomRef extends Required<ExpandableTextAttributes>, Ui5DomRef {} -interface ExpandableTextPropTypes - extends ExpandableTextAttributes, - Omit<CommonProps, keyof ExpandableTextAttributes | 'children'>, - DeprecatedExpandableTextProps {} +interface ExpandableTextPropTypes extends ExpandableTextAttributes, Omit<CommonProps, keyof ExpandableTextAttributes> {} /** * The `ExpandableText` component allows displaying a large body of text in a small space. It provides an "expand/collapse" functionality, which shows/hides potentially truncated text. @@ -85,11 +52,9 @@ interface ExpandableTextPropTypes * * On phones, if the component is configured to display the full text in a popover, the popover will appear in full screen. * - * __Note:__ For compatibility reasons, `children`, `showOverflowInPopover`, and `renderWhitespace` are added by the UI5 Web Components for React wrapper and are not part of the underlying web component (`ui5-expandable-text`). - * These props will be removed in the next major release (not yet planned); see their deprecation notices for alternatives. * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ExpandableText UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ExpandableText) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.6.0](https://github.com/UI5/webcomponents/releases/tag/v2.6.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/FileUploader/index.tsx b/packages/main/src/webComponents/FileUploader/index.tsx index b8e9b07fc1c..992f0612636 100644 --- a/packages/main/src/webComponents/FileUploader/index.tsx +++ b/packages/main/src/webComponents/FileUploader/index.tsx @@ -135,6 +135,8 @@ interface FileUploaderPropTypes * This slot is intended for use cases where you want a button-only file uploader. * It is recommended to set `hideInput` property to "true" when using this slot. * Not setting `hideInput` may negatively impact the screen reader users. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ children?: ReactNode | ReactNode[]; @@ -151,6 +153,8 @@ interface FileUploaderPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -190,7 +194,7 @@ interface FileUploaderPropTypes * For the `FileUploader` * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [FileUploader UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/FileUploader) | [Repository](https://github.com/UI5/webcomponents) */ const FileUploader = withWebComponent<FileUploaderPropTypes, FileUploaderDomRef>( 'ui5-file-uploader', diff --git a/packages/main/src/webComponents/FilterItem/index.tsx b/packages/main/src/webComponents/FilterItem/index.tsx index c13fb34001c..23ef645eb51 100644 --- a/packages/main/src/webComponents/FilterItem/index.tsx +++ b/packages/main/src/webComponents/FilterItem/index.tsx @@ -29,6 +29,8 @@ interface FilterItemPropTypes extends FilterItemAttributes, Omit<CommonProps, ke * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<FilterItemOption>` */ values?: UI5WCSlotsNode; } @@ -39,7 +41,7 @@ interface FilterItemPropTypes extends FilterItemAttributes, Omit<CommonProps, ke * For the `FilterItem` * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [FilterItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/FilterItem) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const FilterItem = withWebComponent<FilterItemPropTypes, FilterItemDomRef>( diff --git a/packages/main/src/webComponents/FilterItemOption/index.tsx b/packages/main/src/webComponents/FilterItemOption/index.tsx index 2fffd11827b..b17332b5403 100644 --- a/packages/main/src/webComponents/FilterItemOption/index.tsx +++ b/packages/main/src/webComponents/FilterItemOption/index.tsx @@ -30,7 +30,7 @@ interface FilterItemOptionPropTypes * For the `FilterItemOption` * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [FilterItemOption UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/FilterItemOption) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const FilterItemOption = withWebComponent<FilterItemOptionPropTypes, FilterItemOptionDomRef>( diff --git a/packages/main/src/webComponents/FlexibleColumnLayout/index.tsx b/packages/main/src/webComponents/FlexibleColumnLayout/index.tsx index 5bb391bbaa5..a0c7b80cc60 100644 --- a/packages/main/src/webComponents/FlexibleColumnLayout/index.tsx +++ b/packages/main/src/webComponents/FlexibleColumnLayout/index.tsx @@ -101,6 +101,8 @@ interface FlexibleColumnLayoutPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ endColumn?: UI5WCSlotsNode; @@ -112,6 +114,8 @@ interface FlexibleColumnLayoutPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ midColumn?: UI5WCSlotsNode; @@ -123,6 +127,8 @@ interface FlexibleColumnLayoutPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ startColumn?: UI5WCSlotsNode; /** @@ -177,7 +183,7 @@ interface FlexibleColumnLayoutPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [FlexibleColumnLayout UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/FlexibleColumnLayout) | [Repository](https://github.com/UI5/webcomponents) */ const FlexibleColumnLayout = withWebComponent<FlexibleColumnLayoutPropTypes, FlexibleColumnLayoutDomRef>( 'ui5-flexible-column-layout', diff --git a/packages/main/src/webComponents/Form/index.tsx b/packages/main/src/webComponents/Form/index.tsx index 0d0d3cebd99..bf947d435d5 100644 --- a/packages/main/src/webComponents/Form/index.tsx +++ b/packages/main/src/webComponents/Form/index.tsx @@ -92,6 +92,8 @@ interface FormPropTypes extends FormAttributes, Omit<CommonProps, keyof FormAttr * * **Note:** Mixing FormGroups and standalone FormItems (not belonging to a group) is not supported. * Either use FormGroups and make sure all FormItems are part of a FormGroup, or use just FormItems without any FormGroups. + * + * __Supported Node Type/s:__ `Array<IFormItem>` */ children?: ReactNode | ReactNode[]; @@ -105,6 +107,8 @@ interface FormPropTypes extends FormAttributes, Omit<CommonProps, keyof FormAttr * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ header?: UI5WCSlotsNode; } @@ -243,7 +247,7 @@ interface FormPropTypes extends FormAttributes, Omit<CommonProps, keyof FormAttr * - import @ui5/webcomponents/dist/FormGroup.js"; * - import @ui5/webcomponents/dist/FormItem.js"; * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Form UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Form) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/FormGroup/index.tsx b/packages/main/src/webComponents/FormGroup/index.tsx index b89d67111ec..cd520eeec7d 100644 --- a/packages/main/src/webComponents/FormGroup/index.tsx +++ b/packages/main/src/webComponents/FormGroup/index.tsx @@ -35,6 +35,8 @@ interface FormGroupDomRef extends Required<FormGroupAttributes>, Ui5DomRef {} interface FormGroupPropTypes extends FormGroupAttributes, Omit<CommonProps, keyof FormGroupAttributes | 'children'> { /** * Defines the items of the component. + * + * __Supported Node Type/s:__ `Array<FormItem>` */ children?: ReactNode | ReactNode[]; } @@ -56,7 +58,7 @@ interface FormGroupPropTypes extends FormGroupAttributes, Omit<CommonProps, keyo * * - import @ui5/webcomponents/dist/FormGroup.js"; * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [FormGroup UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/FormGroup) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/FormItem/index.tsx b/packages/main/src/webComponents/FormItem/index.tsx index 9c1946df85f..ce4567dcc12 100644 --- a/packages/main/src/webComponents/FormItem/index.tsx +++ b/packages/main/src/webComponents/FormItem/index.tsx @@ -26,6 +26,8 @@ interface FormItemPropTypes /** * Defines the content of the component, * associated to `labelContent`. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ children?: ReactNode | ReactNode[]; @@ -37,6 +39,8 @@ interface FormItemPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ labelContent?: UI5WCSlotsNode; } @@ -53,7 +57,7 @@ interface FormItemPropTypes * * - import @ui5/webcomponents/dist/FormItem.js"; * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [FormItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/FormItem) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/Icon/index.tsx b/packages/main/src/webComponents/Icon/index.tsx index 40b2c481df3..03ac1a14394 100644 --- a/packages/main/src/webComponents/Icon/index.tsx +++ b/packages/main/src/webComponents/Icon/index.tsx @@ -145,7 +145,7 @@ interface IconPropTypes extends IconAttributes, Omit<CommonProps, keyof IconAttr * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Icon UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Icon) | [Repository](https://github.com/UI5/webcomponents) */ const Icon = withWebComponent<IconPropTypes, IconDomRef>( 'ui5-icon', diff --git a/packages/main/src/webComponents/IllustratedMessage/index.tsx b/packages/main/src/webComponents/IllustratedMessage/index.tsx index e3143cb6a25..41d86eab6e7 100644 --- a/packages/main/src/webComponents/IllustratedMessage/index.tsx +++ b/packages/main/src/webComponents/IllustratedMessage/index.tsx @@ -90,6 +90,8 @@ interface IllustratedMessagePropTypes * Defines the component actions. * * **Note:** Not displayed when the `design` property is set to `Base`. + * + * __Supported Node Type/s:__ `Array<IButton>` */ children?: ReactNode | ReactNode[]; @@ -103,6 +105,8 @@ interface IllustratedMessagePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ subtitle?: UI5WCSlotsNode; @@ -118,6 +122,8 @@ interface IllustratedMessagePropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.7.0](https://github.com/UI5/webcomponents/releases/tag/v1.7.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<HTMLElement> & string` */ title?: UI5WCSlotsNode; } @@ -154,7 +160,7 @@ interface IllustratedMessagePropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [IllustratedMessage UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/IllustratedMessage) | [Repository](https://github.com/UI5/webcomponents) */ const IllustratedMessage = withWebComponent<IllustratedMessagePropTypes, IllustratedMessageDomRef>( 'ui5-illustrated-message', diff --git a/packages/main/src/webComponents/Input/index.tsx b/packages/main/src/webComponents/Input/index.tsx index 56c7b096b8f..8e828896082 100644 --- a/packages/main/src/webComponents/Input/index.tsx +++ b/packages/main/src/webComponents/Input/index.tsx @@ -166,6 +166,8 @@ interface InputPropTypes * property is set to `true`. * * **Note:** The `<SuggestionItem>`, `<SuggestionItemGroup>` and `SuggestionItemCustom` are recommended to be used as suggestion items. + * + * __Supported Node Type/s:__ `Array<IInputSuggestionItem>` */ children?: ReactNode | ReactNode[]; @@ -177,6 +179,8 @@ interface InputPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IIcon>` */ icon?: UI5WCSlotsNode; @@ -197,6 +201,8 @@ interface InputPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -293,7 +299,7 @@ interface InputPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Input UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Input) | [Repository](https://github.com/UI5/webcomponents) */ const Input = withWebComponent<InputPropTypes, InputDomRef>( 'ui5-input', diff --git a/packages/main/src/webComponents/Label/index.tsx b/packages/main/src/webComponents/Label/index.tsx index 90ba9ed1e05..0e0c5e53831 100644 --- a/packages/main/src/webComponents/Label/index.tsx +++ b/packages/main/src/webComponents/Label/index.tsx @@ -49,6 +49,8 @@ interface LabelPropTypes extends LabelAttributes, Omit<CommonProps, keyof LabelA * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -65,7 +67,7 @@ interface LabelPropTypes extends LabelAttributes, Omit<CommonProps, keyof LabelA * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Label UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Label) | [Repository](https://github.com/UI5/webcomponents) */ const Label = withWebComponent<LabelPropTypes, LabelDomRef>( 'ui5-label', diff --git a/packages/main/src/webComponents/Link/index.tsx b/packages/main/src/webComponents/Link/index.tsx index 6f5784c01cc..5937cd3e330 100644 --- a/packages/main/src/webComponents/Link/index.tsx +++ b/packages/main/src/webComponents/Link/index.tsx @@ -166,6 +166,8 @@ interface LinkPropTypes extends LinkAttributes, Omit<CommonProps, keyof LinkAttr * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; /** @@ -208,7 +210,7 @@ interface LinkPropTypes extends LinkAttributes, Omit<CommonProps, keyof LinkAttr * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Link UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Link) | [Repository](https://github.com/UI5/webcomponents) */ const Link = withWebComponent<LinkPropTypes, LinkDomRef>( 'ui5-link', diff --git a/packages/main/src/webComponents/List/index.tsx b/packages/main/src/webComponents/List/index.tsx index 5c94fe28031..478efef256e 100644 --- a/packages/main/src/webComponents/List/index.tsx +++ b/packages/main/src/webComponents/List/index.tsx @@ -175,6 +175,8 @@ interface ListPropTypes * Defines the items of the component. * * **Note:** Use `ListItemStandard`, `ListItemCustom`, and `ListItemGroup` for the intended design. + * + * __Supported Node Type/s:__ `Array<ListItemBase | ListItemGroup>` */ children?: ReactNode | ReactNode[]; @@ -189,6 +191,8 @@ interface ListPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ header?: UI5WCSlotsNode; /** @@ -338,7 +342,7 @@ interface ListPropTypes * * `import "@ui5/webcomponents/dist/ListItemGroup.js";` (for `ListItemGroup`) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [List UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/List) | [Repository](https://github.com/UI5/webcomponents) */ const List = withWebComponent<ListPropTypes, ListDomRef>( 'ui5-list', diff --git a/packages/main/src/webComponents/ListItemCustom/index.tsx b/packages/main/src/webComponents/ListItemCustom/index.tsx index 368489cc1d9..a473e5eb0d0 100644 --- a/packages/main/src/webComponents/ListItemCustom/index.tsx +++ b/packages/main/src/webComponents/ListItemCustom/index.tsx @@ -90,6 +90,8 @@ interface ListItemCustomPropTypes Omit<CommonProps, keyof ListItemCustomAttributes | 'children' | 'deleteButton' | 'onDetailClick'> { /** * Defines the content of the component. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; @@ -106,6 +108,8 @@ interface ListItemCustomPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.9.0](https://github.com/UI5/webcomponents/releases/tag/v1.9.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<IButton>` */ deleteButton?: UI5WCSlotsNode; /** @@ -124,7 +128,7 @@ interface ListItemCustomPropTypes * * The component accepts arbitrary HTML content to allow full customization. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ListItemCustom UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ListItemCustom) | [Repository](https://github.com/UI5/webcomponents) */ const ListItemCustom = withWebComponent<ListItemCustomPropTypes, ListItemCustomDomRef>( 'ui5-li-custom', diff --git a/packages/main/src/webComponents/ListItemGroup/index.tsx b/packages/main/src/webComponents/ListItemGroup/index.tsx index 0be323612a8..7ab1fb86fba 100644 --- a/packages/main/src/webComponents/ListItemGroup/index.tsx +++ b/packages/main/src/webComponents/ListItemGroup/index.tsx @@ -46,6 +46,8 @@ interface ListItemGroupPropTypes Omit<CommonProps, keyof ListItemGroupAttributes | 'children' | 'header' | 'onMove' | 'onMoveOver'> { /** * Defines the items of the <code>ui5-li-group</code>. + * + * __Supported Node Type/s:__ `Array<ListItemBase>` */ children?: ReactNode | ReactNode[]; @@ -59,6 +61,8 @@ interface ListItemGroupPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<ListItemBase>` */ header?: UI5WCSlotsNode; /** @@ -97,7 +101,7 @@ interface ListItemGroupPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ListItemGroup UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ListItemGroup) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/ListItemStandard/index.tsx b/packages/main/src/webComponents/ListItemStandard/index.tsx index 3326278c100..143f3d2c9b9 100644 --- a/packages/main/src/webComponents/ListItemStandard/index.tsx +++ b/packages/main/src/webComponents/ListItemStandard/index.tsx @@ -160,6 +160,8 @@ interface ListItemStandardPropTypes * Be aware that wrapping (via `wrappingType="Normal"`) may not function correctly with custom HTML content in the `default` slot. * * If both `text` and `default` slot are used, the `text` property takes precedence. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; @@ -176,6 +178,8 @@ interface ListItemStandardPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.9.0](https://github.com/UI5/webcomponents/releases/tag/v1.9.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<IButton>` */ deleteButton?: UI5WCSlotsNode; @@ -193,6 +197,8 @@ interface ListItemStandardPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ image?: UI5WCSlotsNode; /** @@ -212,7 +218,7 @@ interface ListItemStandardPropTypes * providing the most common use cases such as `text`, * `image` and `icon`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ListItemStandard UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ListItemStandard) | [Repository](https://github.com/UI5/webcomponents) */ const ListItemStandard = withWebComponent<ListItemStandardPropTypes, ListItemStandardDomRef>( 'ui5-li', diff --git a/packages/main/src/webComponents/MediaGallery/index.tsx b/packages/main/src/webComponents/MediaGallery/index.tsx index a01fbab5d19..87f6b44919d 100644 --- a/packages/main/src/webComponents/MediaGallery/index.tsx +++ b/packages/main/src/webComponents/MediaGallery/index.tsx @@ -63,6 +63,8 @@ interface MediaGalleryPropTypes * **Note:** Only one selected item is allowed. * * **Note:** Use the `MediaGalleryItem` component to define the desired items. + * + * __Supported Node Type/s:__ `Array<IMediaGalleryItem>` */ children?: ReactNode | ReactNode[]; /** @@ -121,7 +123,7 @@ interface MediaGalleryPropTypes * * `import "@ui5/webcomponents-fiori/dist/MediaGalleryItem.js";` * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [MediaGallery UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/MediaGallery) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.1.0](https://github.com/UI5/webcomponents/releases/tag/v1.1.0) of __@ui5/webcomponents-fiori__. */ diff --git a/packages/main/src/webComponents/MediaGalleryItem/index.tsx b/packages/main/src/webComponents/MediaGalleryItem/index.tsx index 22f025bab7a..b7dcd62e124 100644 --- a/packages/main/src/webComponents/MediaGalleryItem/index.tsx +++ b/packages/main/src/webComponents/MediaGalleryItem/index.tsx @@ -33,6 +33,8 @@ interface MediaGalleryItemPropTypes Omit<CommonProps, keyof MediaGalleryItemAttributes | 'children' | 'thumbnail'> { /** * Defines the content of the component. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ children?: ReactNode | ReactNode[]; @@ -44,6 +46,8 @@ interface MediaGalleryItemPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ thumbnail?: UI5WCSlotsNode; } @@ -63,7 +67,7 @@ interface MediaGalleryItemPropTypes * * ) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [MediaGalleryItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/MediaGalleryItem) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.1.0](https://github.com/UI5/webcomponents/releases/tag/v1.1.0) of __@ui5/webcomponents-fiori__. */ diff --git a/packages/main/src/webComponents/Menu/index.tsx b/packages/main/src/webComponents/Menu/index.tsx index 5c9abe10631..df539d63fd5 100644 --- a/packages/main/src/webComponents/Menu/index.tsx +++ b/packages/main/src/webComponents/Menu/index.tsx @@ -71,6 +71,8 @@ interface MenuPropTypes * Defines the items of this component. * * **Note:** Use `MenuItem` and `MenuSeparator` for their intended design. + * + * __Supported Node Type/s:__ `Array<IMenuItem>` */ children?: ReactNode | ReactNode[]; /** @@ -171,7 +173,7 @@ interface MenuPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Menu UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Menu) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.3.0](https://github.com/UI5/webcomponents/releases/tag/v1.3.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/MenuItem/index.tsx b/packages/main/src/webComponents/MenuItem/index.tsx index a7182eeb644..3f7c87a4ca3 100644 --- a/packages/main/src/webComponents/MenuItem/index.tsx +++ b/packages/main/src/webComponents/MenuItem/index.tsx @@ -175,6 +175,8 @@ interface MenuItemPropTypes * * The priority of what will be displayed at the end of the menu item is as follows: * sub-menu arrow (if there are items added in `items` slot) -> components added in `endContent` -> text set to `additionalText`. + * + * __Supported Node Type/s:__ `Array<IMenuItem>` */ children?: ReactNode | ReactNode[]; @@ -191,6 +193,8 @@ interface MenuItemPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.9.0](https://github.com/UI5/webcomponents/releases/tag/v1.9.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<IButton>` */ deleteButton?: UI5WCSlotsNode; @@ -216,6 +220,8 @@ interface MenuItemPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ endContent?: UI5WCSlotsNode; /** @@ -299,7 +305,7 @@ interface MenuItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [MenuItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/MenuItem) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.3.0](https://github.com/UI5/webcomponents/releases/tag/v1.3.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/MenuItemGroup/index.tsx b/packages/main/src/webComponents/MenuItemGroup/index.tsx index 153ba8ea930..ae3fd6fcf90 100644 --- a/packages/main/src/webComponents/MenuItemGroup/index.tsx +++ b/packages/main/src/webComponents/MenuItemGroup/index.tsx @@ -22,6 +22,8 @@ interface MenuItemGroupPropTypes /** * Defines the items of this component. * **Note:** The slot can hold any combination of components of type `MenuItem` or `MenuSeparator` or both. + * + * __Supported Node Type/s:__ `Array<IMenuItem>` */ children?: ReactNode | ReactNode[]; } @@ -45,7 +47,7 @@ interface MenuItemGroupPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [MenuItemGroup UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/MenuItemGroup) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.12.0](https://github.com/UI5/webcomponents/releases/tag/v2.12.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/MenuSeparator/index.tsx b/packages/main/src/webComponents/MenuSeparator/index.tsx index eb3c6b17018..051dbae3665 100644 --- a/packages/main/src/webComponents/MenuSeparator/index.tsx +++ b/packages/main/src/webComponents/MenuSeparator/index.tsx @@ -13,7 +13,7 @@ interface MenuSeparatorPropTypes extends MenuSeparatorAttributes, CommonProps {} /** * The `MenuSeparator` represents a horizontal line to separate menu items inside a `Menu`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [MenuSeparator UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/MenuSeparator) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/MessageStrip/index.tsx b/packages/main/src/webComponents/MessageStrip/index.tsx index 3582fdaeed2..ca6154aac7b 100644 --- a/packages/main/src/webComponents/MessageStrip/index.tsx +++ b/packages/main/src/webComponents/MessageStrip/index.tsx @@ -48,6 +48,8 @@ interface MessageStripPropTypes * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; @@ -64,6 +66,8 @@ interface MessageStripPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IIcon>` */ icon?: UI5WCSlotsNode; /** @@ -98,7 +102,7 @@ interface MessageStripPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [MessageStrip UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/MessageStrip) | [Repository](https://github.com/UI5/webcomponents) */ const MessageStrip = withWebComponent<MessageStripPropTypes, MessageStripDomRef>( 'ui5-message-strip', diff --git a/packages/main/src/webComponents/MultiComboBox/index.tsx b/packages/main/src/webComponents/MultiComboBox/index.tsx index a2d6cc8fd59..172761ea283 100644 --- a/packages/main/src/webComponents/MultiComboBox/index.tsx +++ b/packages/main/src/webComponents/MultiComboBox/index.tsx @@ -141,6 +141,8 @@ interface MultiComboBoxPropTypes > { /** * Defines the component items. + * + * __Supported Node Type/s:__ `Array<IMultiComboBoxItem>` */ children?: ReactNode | ReactNode[]; @@ -152,6 +154,8 @@ interface MultiComboBoxPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IIcon>` */ icon?: UI5WCSlotsNode; @@ -169,6 +173,8 @@ interface MultiComboBoxPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -255,7 +261,7 @@ interface MultiComboBoxPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [MultiComboBox UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/MultiComboBox) | [Repository](https://github.com/UI5/webcomponents) */ const MultiComboBox = withWebComponent<MultiComboBoxPropTypes, MultiComboBoxDomRef>( 'ui5-multi-combobox', diff --git a/packages/main/src/webComponents/MultiComboBoxItem/index.tsx b/packages/main/src/webComponents/MultiComboBoxItem/index.tsx index f7415f8e356..7e73fade03a 100644 --- a/packages/main/src/webComponents/MultiComboBoxItem/index.tsx +++ b/packages/main/src/webComponents/MultiComboBoxItem/index.tsx @@ -33,7 +33,7 @@ interface MultiComboBoxItemPropTypes /** * The `MultiComboBoxItem` represents the item for a `MultiComboBox`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [MultiComboBoxItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/MultiComboBoxItem) | [Repository](https://github.com/UI5/webcomponents) */ const MultiComboBoxItem = withWebComponent<MultiComboBoxItemPropTypes, MultiComboBoxItemDomRef>( 'ui5-mcb-item', diff --git a/packages/main/src/webComponents/MultiComboBoxItemGroup/index.tsx b/packages/main/src/webComponents/MultiComboBoxItemGroup/index.tsx index 1e417554ce4..7f98177f5fe 100644 --- a/packages/main/src/webComponents/MultiComboBoxItemGroup/index.tsx +++ b/packages/main/src/webComponents/MultiComboBoxItemGroup/index.tsx @@ -46,6 +46,8 @@ interface MultiComboBoxItemGroupPropTypes Omit<CommonProps, keyof MultiComboBoxItemGroupAttributes | 'children' | 'header' | 'onMove' | 'onMoveOver'> { /** * Defines the items of the <code>ui5-mcb-item-group</code>. + * + * __Supported Node Type/s:__ `Array<MultiComboBoxItem>` */ children?: ReactNode | ReactNode[]; @@ -59,6 +61,8 @@ interface MultiComboBoxItemGroupPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<ListItemBase>` */ header?: UI5WCSlotsNode; /** @@ -94,7 +98,7 @@ interface MultiComboBoxItemGroupPropTypes * The `MultiComboBoxItemGroup` is type of suggestion item, * that can be used to split the `MultiComboBox` suggestions into groups. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [MultiComboBoxItemGroup UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/MultiComboBoxItemGroup) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/MultiInput/index.tsx b/packages/main/src/webComponents/MultiInput/index.tsx index 4dcf950c47c..b5099e917da 100644 --- a/packages/main/src/webComponents/MultiInput/index.tsx +++ b/packages/main/src/webComponents/MultiInput/index.tsx @@ -179,6 +179,8 @@ interface MultiInputPropTypes * property is set to `true`. * * **Note:** The `<SuggestionItem>`, `<SuggestionItemGroup>` and `SuggestionItemCustom` are recommended to be used as suggestion items. + * + * __Supported Node Type/s:__ `Array<IInputSuggestionItem>` */ children?: ReactNode | ReactNode[]; @@ -190,6 +192,8 @@ interface MultiInputPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IIcon>` */ icon?: UI5WCSlotsNode; @@ -201,6 +205,8 @@ interface MultiInputPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IToken>` */ tokens?: UI5WCSlotsNode; @@ -221,6 +227,8 @@ interface MultiInputPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -321,7 +329,7 @@ interface MultiInputPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [MultiInput UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/MultiInput) | [Repository](https://github.com/UI5/webcomponents) */ const MultiInput = withWebComponent<MultiInputPropTypes, MultiInputDomRef>( 'ui5-multi-input', diff --git a/packages/main/src/webComponents/NavigationLayout/index.tsx b/packages/main/src/webComponents/NavigationLayout/index.tsx index b1e6acd4ed5..5938c46752c 100644 --- a/packages/main/src/webComponents/NavigationLayout/index.tsx +++ b/packages/main/src/webComponents/NavigationLayout/index.tsx @@ -27,6 +27,8 @@ interface NavigationLayoutPropTypes Omit<CommonProps, keyof NavigationLayoutAttributes | 'children' | 'header' | 'sideContent'> { /** * Defines the content. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ children?: ReactNode | ReactNode[]; @@ -38,6 +40,8 @@ interface NavigationLayoutPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ header?: UI5WCSlotsNode; @@ -49,6 +53,8 @@ interface NavigationLayoutPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<SideNavigation>` */ sideContent?: UI5WCSlotsNode; } @@ -70,7 +76,7 @@ interface NavigationLayoutPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [NavigationLayout UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/NavigationLayout) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.4.0](https://github.com/UI5/webcomponents/releases/tag/v2.4.0) of __@ui5/webcomponents-fiori__. */ diff --git a/packages/main/src/webComponents/NotificationList/index.tsx b/packages/main/src/webComponents/NotificationList/index.tsx index 230a6052626..85f9903ba0d 100644 --- a/packages/main/src/webComponents/NotificationList/index.tsx +++ b/packages/main/src/webComponents/NotificationList/index.tsx @@ -25,6 +25,8 @@ interface NotificationListPropTypes Omit<CommonProps, keyof NotificationListAttributes | 'children' | 'onItemClick' | 'onItemClose' | 'onItemToggle'> { /** * Defines the items of the component. + * + * __Supported Node Type/s:__ `Array<NotificationListItemBase>` */ children?: ReactNode | ReactNode[]; /** @@ -84,7 +86,7 @@ interface NotificationListPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [NotificationList UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/NotificationList) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents-fiori__. */ diff --git a/packages/main/src/webComponents/NotificationListGroupItem/index.tsx b/packages/main/src/webComponents/NotificationListGroupItem/index.tsx index 567b8ed9dc5..d31d2579cad 100644 --- a/packages/main/src/webComponents/NotificationListGroupItem/index.tsx +++ b/packages/main/src/webComponents/NotificationListGroupItem/index.tsx @@ -58,6 +58,8 @@ interface NotificationListGroupItemPropTypes /** * Defines the items of the `NotificationListGroupItem`, * usually `NotificationListItem` items. + * + * __Supported Node Type/s:__ `Array<NotificationListItem>` */ children?: ReactNode | ReactNode[]; /** @@ -106,7 +108,7 @@ interface NotificationListGroupItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [NotificationListGroupItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/NotificationListGroupItem) | [Repository](https://github.com/UI5/webcomponents) */ const NotificationListGroupItem = withWebComponent<NotificationListGroupItemPropTypes, NotificationListGroupItemDomRef>( 'ui5-li-notification-group', diff --git a/packages/main/src/webComponents/NotificationListItem/index.tsx b/packages/main/src/webComponents/NotificationListItem/index.tsx index 06d20646436..11de73e40eb 100644 --- a/packages/main/src/webComponents/NotificationListItem/index.tsx +++ b/packages/main/src/webComponents/NotificationListItem/index.tsx @@ -85,6 +85,8 @@ interface NotificationListItemPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ avatar?: UI5WCSlotsNode; @@ -93,6 +95,8 @@ interface NotificationListItemPropTypes * usually a description of the notification. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; @@ -104,6 +108,8 @@ interface NotificationListItemPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ footnotes?: UI5WCSlotsNode; @@ -119,6 +125,8 @@ interface NotificationListItemPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ menu?: UI5WCSlotsNode; /** @@ -165,7 +173,7 @@ interface NotificationListItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [NotificationListItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/NotificationListItem) | [Repository](https://github.com/UI5/webcomponents) */ const NotificationListItem = withWebComponent<NotificationListItemPropTypes, NotificationListItemDomRef>( 'ui5-li-notification', diff --git a/packages/main/src/webComponents/Option/index.tsx b/packages/main/src/webComponents/Option/index.tsx index 3f98571bfb0..04c6e42ab26 100644 --- a/packages/main/src/webComponents/Option/index.tsx +++ b/packages/main/src/webComponents/Option/index.tsx @@ -51,6 +51,8 @@ interface OptionPropTypes extends OptionAttributes, Omit<CommonProps, keyof Opti * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -60,7 +62,7 @@ interface OptionPropTypes extends OptionAttributes, Omit<CommonProps, keyof Opti * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Option UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Option) | [Repository](https://github.com/UI5/webcomponents) */ const Option = withWebComponent<OptionPropTypes, OptionDomRef>( 'ui5-option', diff --git a/packages/main/src/webComponents/OptionCustom/index.tsx b/packages/main/src/webComponents/OptionCustom/index.tsx index 311d98608a2..01e25bd8e38 100644 --- a/packages/main/src/webComponents/OptionCustom/index.tsx +++ b/packages/main/src/webComponents/OptionCustom/index.tsx @@ -40,6 +40,8 @@ interface OptionCustomPropTypes Omit<CommonProps, keyof OptionCustomAttributes | 'children'> { /** * Defines the content of the component. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -51,7 +53,7 @@ interface OptionCustomPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [OptionCustom UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/OptionCustom) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/Page/index.tsx b/packages/main/src/webComponents/Page/index.tsx index f186703ade6..d2ea2fbe8e7 100644 --- a/packages/main/src/webComponents/Page/index.tsx +++ b/packages/main/src/webComponents/Page/index.tsx @@ -44,6 +44,8 @@ interface PagePropTypes Omit<CommonProps, keyof PageAttributes | 'children' | 'footer' | 'header'> { /** * Defines the content HTML Element. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; @@ -55,6 +57,8 @@ interface PagePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ footer?: UI5WCSlotsNode; @@ -66,6 +70,8 @@ interface PagePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ header?: UI5WCSlotsNode; } @@ -88,7 +94,7 @@ interface PagePropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Page UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/Page) | [Repository](https://github.com/UI5/webcomponents) */ const Page = withWebComponent<PagePropTypes, PageDomRef>( 'ui5-page', diff --git a/packages/main/src/webComponents/Panel/index.tsx b/packages/main/src/webComponents/Panel/index.tsx index 29b7f3a39d8..ce3abb44af4 100644 --- a/packages/main/src/webComponents/Panel/index.tsx +++ b/packages/main/src/webComponents/Panel/index.tsx @@ -74,6 +74,8 @@ interface PanelPropTypes Omit<CommonProps, keyof PanelAttributes | 'children' | 'header' | 'onToggle'> { /** * Defines the content of the component. The content is visible only when the component is expanded. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; @@ -87,6 +89,8 @@ interface PanelPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ header?: UI5WCSlotsNode; /** @@ -143,7 +147,7 @@ interface PanelPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Panel UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Panel) | [Repository](https://github.com/UI5/webcomponents) */ const Panel = withWebComponent<PanelPropTypes, PanelDomRef>( 'ui5-panel', diff --git a/packages/main/src/webComponents/Popover/index.tsx b/packages/main/src/webComponents/Popover/index.tsx index 1ea49510296..b4ac47d611c 100644 --- a/packages/main/src/webComponents/Popover/index.tsx +++ b/packages/main/src/webComponents/Popover/index.tsx @@ -163,6 +163,8 @@ interface PopoverPropTypes > { /** * Defines the content of the Popup. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ children?: ReactNode | ReactNode[]; @@ -174,6 +176,8 @@ interface PopoverPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ footer?: UI5WCSlotsNode; @@ -185,6 +189,8 @@ interface PopoverPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ header?: UI5WCSlotsNode; /** @@ -249,7 +255,7 @@ interface PopoverPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Popover UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Popover) | [Repository](https://github.com/UI5/webcomponents) */ const Popover = withWebComponent<PopoverPropTypes, PopoverDomRef>( 'ui5-popover', diff --git a/packages/main/src/webComponents/ProductSwitch/index.tsx b/packages/main/src/webComponents/ProductSwitch/index.tsx index f5af0703463..9af2e453be6 100644 --- a/packages/main/src/webComponents/ProductSwitch/index.tsx +++ b/packages/main/src/webComponents/ProductSwitch/index.tsx @@ -12,6 +12,8 @@ interface ProductSwitchDomRef extends Required<ProductSwitchAttributes>, Ui5DomR interface ProductSwitchPropTypes extends ProductSwitchAttributes, Omit<CommonProps, 'children'> { /** * Defines the items of the `ProductSwitch`. + * + * __Supported Node Type/s:__ `Array<IProductSwitchItem>` */ children?: ReactNode | ReactNode[]; } @@ -33,7 +35,7 @@ interface ProductSwitchPropTypes extends ProductSwitchAttributes, Omit<CommonPro * * `import "@ui5/webcomponents-fiori/dist/ProductSwitchItem.js";` (for `ProductSwitchItem`) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ProductSwitch UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/ProductSwitch) | [Repository](https://github.com/UI5/webcomponents) */ const ProductSwitch = withWebComponent<ProductSwitchPropTypes, ProductSwitchDomRef>( 'ui5-product-switch', diff --git a/packages/main/src/webComponents/ProductSwitchItem/index.tsx b/packages/main/src/webComponents/ProductSwitchItem/index.tsx index 1b13ee91527..171e73b4bd7 100644 --- a/packages/main/src/webComponents/ProductSwitchItem/index.tsx +++ b/packages/main/src/webComponents/ProductSwitchItem/index.tsx @@ -70,6 +70,8 @@ interface ProductSwitchItemPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.14.0](https://github.com/UI5/webcomponents/releases/tag/v2.14.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ image?: UI5WCSlotsNode; /** @@ -98,7 +100,7 @@ interface ProductSwitchItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ProductSwitchItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/ProductSwitchItem) | [Repository](https://github.com/UI5/webcomponents) */ const ProductSwitchItem = withWebComponent<ProductSwitchItemPropTypes, ProductSwitchItemDomRef>( 'ui5-product-switch-item', diff --git a/packages/main/src/webComponents/ProgressIndicator/index.tsx b/packages/main/src/webComponents/ProgressIndicator/index.tsx index 0ebd3613ae0..9ffc0ed851f 100644 --- a/packages/main/src/webComponents/ProgressIndicator/index.tsx +++ b/packages/main/src/webComponents/ProgressIndicator/index.tsx @@ -62,7 +62,7 @@ interface ProgressIndicatorPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ProgressIndicator UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ProgressIndicator) | [Repository](https://github.com/UI5/webcomponents) */ const ProgressIndicator = withWebComponent<ProgressIndicatorPropTypes, ProgressIndicatorDomRef>( 'ui5-progress-indicator', diff --git a/packages/main/src/webComponents/RadioButton/index.tsx b/packages/main/src/webComponents/RadioButton/index.tsx index d22adfa0b4e..7f38f5dc607 100644 --- a/packages/main/src/webComponents/RadioButton/index.tsx +++ b/packages/main/src/webComponents/RadioButton/index.tsx @@ -138,7 +138,7 @@ interface RadioButtonPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [RadioButton UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/RadioButton) | [Repository](https://github.com/UI5/webcomponents) */ const RadioButton = withWebComponent<RadioButtonPropTypes, RadioButtonDomRef>( 'ui5-radio-button', diff --git a/packages/main/src/webComponents/RangeSlider/index.tsx b/packages/main/src/webComponents/RangeSlider/index.tsx index 22cc788284d..ceb13760dc4 100644 --- a/packages/main/src/webComponents/RangeSlider/index.tsx +++ b/packages/main/src/webComponents/RangeSlider/index.tsx @@ -162,7 +162,7 @@ interface RangeSliderPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [RangeSlider UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/RangeSlider) | [Repository](https://github.com/UI5/webcomponents) */ const RangeSlider = withWebComponent<RangeSliderPropTypes, RangeSliderDomRef>( 'ui5-range-slider', diff --git a/packages/main/src/webComponents/RatingIndicator/index.tsx b/packages/main/src/webComponents/RatingIndicator/index.tsx index e7e7bdd4d81..88cad5b408f 100644 --- a/packages/main/src/webComponents/RatingIndicator/index.tsx +++ b/packages/main/src/webComponents/RatingIndicator/index.tsx @@ -120,7 +120,7 @@ interface RatingIndicatorPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [RatingIndicator UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/RatingIndicator) | [Repository](https://github.com/UI5/webcomponents) */ const RatingIndicator = withWebComponent<RatingIndicatorPropTypes, RatingIndicatorDomRef>( 'ui5-rating-indicator', diff --git a/packages/main/src/webComponents/ResponsivePopover/index.tsx b/packages/main/src/webComponents/ResponsivePopover/index.tsx index 20dde0671d9..ced75b78bf8 100644 --- a/packages/main/src/webComponents/ResponsivePopover/index.tsx +++ b/packages/main/src/webComponents/ResponsivePopover/index.tsx @@ -163,6 +163,8 @@ interface ResponsivePopoverPropTypes > { /** * Defines the content of the Popup. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ children?: ReactNode | ReactNode[]; @@ -174,6 +176,8 @@ interface ResponsivePopoverPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ footer?: UI5WCSlotsNode; @@ -185,6 +189,8 @@ interface ResponsivePopoverPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ header?: UI5WCSlotsNode; /** @@ -237,7 +243,7 @@ interface ResponsivePopoverPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ResponsivePopover UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ResponsivePopover) | [Repository](https://github.com/UI5/webcomponents) */ const ResponsivePopover = withWebComponent<ResponsivePopoverPropTypes, ResponsivePopoverDomRef>( 'ui5-responsive-popover', diff --git a/packages/main/src/webComponents/Search/index.tsx b/packages/main/src/webComponents/Search/index.tsx index ce31271638b..69f4b340768 100644 --- a/packages/main/src/webComponents/Search/index.tsx +++ b/packages/main/src/webComponents/Search/index.tsx @@ -85,11 +85,15 @@ interface SearchPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<Button>` */ action?: UI5WCSlotsNode; /** * Defines the Search suggestion items. + * + * __Supported Node Type/s:__ `Array<SearchItem | SearchItemGroup>` */ children?: ReactNode | ReactNode[]; @@ -106,6 +110,8 @@ interface SearchPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.11.0](https://github.com/UI5/webcomponents/releases/tag/v2.11.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<Button>` */ filterButton?: UI5WCSlotsNode; @@ -117,6 +123,8 @@ interface SearchPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IllustratedMessage>` */ illustration?: UI5WCSlotsNode; @@ -128,6 +136,8 @@ interface SearchPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<SearchMessageArea>` */ messageArea?: UI5WCSlotsNode; @@ -139,6 +149,8 @@ interface SearchPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<ISearchScope>` */ scopes?: UI5WCSlotsNode; /** @@ -201,7 +213,7 @@ interface SearchPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Search UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/Search) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.9.0](https://github.com/UI5/webcomponents/releases/tag/v2.9.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/SearchItem/index.tsx b/packages/main/src/webComponents/SearchItem/index.tsx index 7df65cddbb4..a2ab84a9ee0 100644 --- a/packages/main/src/webComponents/SearchItem/index.tsx +++ b/packages/main/src/webComponents/SearchItem/index.tsx @@ -61,6 +61,8 @@ interface SearchItemPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.12.0](https://github.com/UI5/webcomponents/releases/tag/v2.12.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ image?: UI5WCSlotsNode; /** @@ -78,7 +80,7 @@ interface SearchItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SearchItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/SearchItem) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.9.0](https://github.com/UI5/webcomponents/releases/tag/v2.9.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/SearchItemGroup/index.tsx b/packages/main/src/webComponents/SearchItemGroup/index.tsx index bd074e30836..290e92965ae 100644 --- a/packages/main/src/webComponents/SearchItemGroup/index.tsx +++ b/packages/main/src/webComponents/SearchItemGroup/index.tsx @@ -46,6 +46,8 @@ interface SearchItemGroupPropTypes Omit<CommonProps, keyof SearchItemGroupAttributes | 'children' | 'header' | 'onMove' | 'onMoveOver'> { /** * Defines the items of the <code>ui5-li-group</code>. + * + * __Supported Node Type/s:__ `Array<ListItemBase>` */ children?: ReactNode | ReactNode[]; @@ -59,6 +61,8 @@ interface SearchItemGroupPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<ListItemBase>` */ header?: UI5WCSlotsNode; /** @@ -94,7 +98,7 @@ interface SearchItemGroupPropTypes * The `SearchItemGroup` is type of suggestion item, * that can be used to split the `SearchItem` suggestions into groups. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SearchItemGroup UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/SearchItemGroup) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.9.0](https://github.com/UI5/webcomponents/releases/tag/v2.9.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/SearchItemShowMore/index.tsx b/packages/main/src/webComponents/SearchItemShowMore/index.tsx index 4eb78b37306..51b2c29ffa4 100644 --- a/packages/main/src/webComponents/SearchItemShowMore/index.tsx +++ b/packages/main/src/webComponents/SearchItemShowMore/index.tsx @@ -31,7 +31,7 @@ interface SearchItemShowMorePropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SearchItemShowMore UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/SearchItemShowMore) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.14.0](https://github.com/UI5/webcomponents/releases/tag/v2.14.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/SearchMessageArea/index.tsx b/packages/main/src/webComponents/SearchMessageArea/index.tsx index ffc36d2e543..d4df8d5e94f 100644 --- a/packages/main/src/webComponents/SearchMessageArea/index.tsx +++ b/packages/main/src/webComponents/SearchMessageArea/index.tsx @@ -27,7 +27,7 @@ interface SearchMessageAreaPropTypes /** * `import "@ui5/webcomponents-fiori/dist/SearchMessageArea.js";` * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SearchMessageArea UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/SearchMessageArea) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.9.0](https://github.com/UI5/webcomponents/releases/tag/v2.9.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/SearchScope/index.tsx b/packages/main/src/webComponents/SearchScope/index.tsx index c875b01caf2..9f2c6d09176 100644 --- a/packages/main/src/webComponents/SearchScope/index.tsx +++ b/packages/main/src/webComponents/SearchScope/index.tsx @@ -24,7 +24,7 @@ interface SearchScopePropTypes extends SearchScopeAttributes, Omit<CommonProps, /** * The `SearchScope` represents the options for the scope in `Search`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SearchScope UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/SearchScope) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.9.0](https://github.com/UI5/webcomponents/releases/tag/v2.9.0) of __@ui5/webcomponents-fiori__. * @abstract diff --git a/packages/main/src/webComponents/SegmentedButton/index.tsx b/packages/main/src/webComponents/SegmentedButton/index.tsx index bb70dc5d1fe..bcce083eb8b 100644 --- a/packages/main/src/webComponents/SegmentedButton/index.tsx +++ b/packages/main/src/webComponents/SegmentedButton/index.tsx @@ -70,6 +70,8 @@ interface SegmentedButtonPropTypes * **Note:** Multiple items are allowed. * * **Note:** Use the `SegmentedButtonItem` for the intended design. + * + * __Supported Node Type/s:__ `Array<ISegmentedButtonItem>` */ children?: ReactNode | ReactNode[]; /** @@ -90,7 +92,7 @@ interface SegmentedButtonPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SegmentedButton UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/SegmentedButton) | [Repository](https://github.com/UI5/webcomponents) */ const SegmentedButton = withWebComponent<SegmentedButtonPropTypes, SegmentedButtonDomRef>( 'ui5-segmented-button', diff --git a/packages/main/src/webComponents/SegmentedButtonItem/index.tsx b/packages/main/src/webComponents/SegmentedButtonItem/index.tsx index 01c641a99d2..e9af5fd8c3b 100644 --- a/packages/main/src/webComponents/SegmentedButtonItem/index.tsx +++ b/packages/main/src/webComponents/SegmentedButtonItem/index.tsx @@ -80,6 +80,8 @@ interface SegmentedButtonItemPropTypes * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -94,7 +96,7 @@ interface SegmentedButtonItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SegmentedButtonItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/SegmentedButtonItem) | [Repository](https://github.com/UI5/webcomponents) */ const SegmentedButtonItem = withWebComponent<SegmentedButtonItemPropTypes, SegmentedButtonItemDomRef>( 'ui5-segmented-button-item', diff --git a/packages/main/src/webComponents/Select/index.tsx b/packages/main/src/webComponents/Select/index.tsx index bbcf81a12d2..a32136eae3e 100644 --- a/packages/main/src/webComponents/Select/index.tsx +++ b/packages/main/src/webComponents/Select/index.tsx @@ -127,6 +127,8 @@ interface SelectPropTypes * If more than one option is defined as selected, the last one would be considered as the selected one. * * **Note:** Use the `Option` component to define the desired options. + * + * __Supported Node Type/s:__ `Array<IOption>` */ children?: ReactNode | ReactNode[]; @@ -147,6 +149,8 @@ interface SelectPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.17.0](https://github.com/UI5/webcomponents/releases/tag/v1.17.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ label?: UI5WCSlotsNode; @@ -166,6 +170,8 @@ interface SelectPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -256,7 +262,7 @@ interface SelectPropTypes * `import "@ui5/webcomponents/dist/Option";` * `import "@ui5/webcomponents/dist/OptionCustom";` * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Select UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Select) | [Repository](https://github.com/UI5/webcomponents) */ const Select = withWebComponent<SelectPropTypes, SelectDomRef>( 'ui5-select', diff --git a/packages/main/src/webComponents/ShellBar/index.tsx b/packages/main/src/webComponents/ShellBar/index.tsx index 622b1e52e6a..128f5d112c4 100644 --- a/packages/main/src/webComponents/ShellBar/index.tsx +++ b/packages/main/src/webComponents/ShellBar/index.tsx @@ -189,6 +189,8 @@ interface ShellBarPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<IButton>` */ assistant?: UI5WCSlotsNode; @@ -206,6 +208,8 @@ interface ShellBarPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.12.0](https://github.com/UI5/webcomponents/releases/tag/v2.12.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<ShellBarBranding>` */ branding?: UI5WCSlotsNode; @@ -214,6 +218,8 @@ interface ShellBarPropTypes * * **Note:** * You can use the `<ShellBarItem></ShellBarItem>`. + * + * __Supported Node Type/s:__ `Array<ShellBarItem>` */ children?: ReactNode | ReactNode[]; @@ -232,6 +238,8 @@ interface ShellBarPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.7.0](https://github.com/UI5/webcomponents/releases/tag/v2.7.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ content?: UI5WCSlotsNode; @@ -244,6 +252,8 @@ interface ShellBarPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ logo?: UI5WCSlotsNode; @@ -257,6 +267,8 @@ interface ShellBarPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<ListItemBase>` */ menuItems?: UI5WCSlotsNode; @@ -272,6 +284,8 @@ interface ShellBarPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ profile?: UI5WCSlotsNode; @@ -283,6 +297,8 @@ interface ShellBarPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IShellBarSearchField>` */ searchField?: UI5WCSlotsNode; @@ -296,6 +312,8 @@ interface ShellBarPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IButton>` */ startButton?: UI5WCSlotsNode; /** @@ -431,7 +449,7 @@ interface ShellBarPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ShellBar UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/ShellBar) | [Repository](https://github.com/UI5/webcomponents) */ const ShellBar = withWebComponent<ShellBarPropTypes, ShellBarDomRef>( 'ui5-shellbar', diff --git a/packages/main/src/webComponents/ShellBarBranding/index.tsx b/packages/main/src/webComponents/ShellBarBranding/index.tsx index bb8700f473d..bb29427a683 100644 --- a/packages/main/src/webComponents/ShellBarBranding/index.tsx +++ b/packages/main/src/webComponents/ShellBarBranding/index.tsx @@ -47,6 +47,8 @@ interface ShellBarBrandingPropTypes * Defines the title for the ui5-shellbar-branding component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ children?: ReactNode | ReactNode[]; @@ -59,6 +61,8 @@ interface ShellBarBrandingPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ logo?: UI5WCSlotsNode; /** @@ -76,7 +80,7 @@ interface ShellBarBrandingPropTypes * `ShellBar` component. Its content has higher priority than the `primaryTitle` property * and the `logo` slot of `ShellBar`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ShellBarBranding UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/ShellBarBranding) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.12.0](https://github.com/UI5/webcomponents/releases/tag/v2.12.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/ShellBarItem/index.tsx b/packages/main/src/webComponents/ShellBarItem/index.tsx index 152781e2918..0c11a4eba40 100644 --- a/packages/main/src/webComponents/ShellBarItem/index.tsx +++ b/packages/main/src/webComponents/ShellBarItem/index.tsx @@ -74,7 +74,7 @@ interface ShellBarItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ShellBarItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/ShellBarItem) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const ShellBarItem = withWebComponent<ShellBarItemPropTypes, ShellBarItemDomRef>( diff --git a/packages/main/src/webComponents/ShellBarSearch/index.tsx b/packages/main/src/webComponents/ShellBarSearch/index.tsx index 51b00c287e9..bfda08552fe 100644 --- a/packages/main/src/webComponents/ShellBarSearch/index.tsx +++ b/packages/main/src/webComponents/ShellBarSearch/index.tsx @@ -91,11 +91,15 @@ interface ShellBarSearchPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<Button>` */ action?: UI5WCSlotsNode; /** * Defines the Search suggestion items. + * + * __Supported Node Type/s:__ `Array<SearchItem | SearchItemGroup>` */ children?: ReactNode | ReactNode[]; @@ -112,6 +116,8 @@ interface ShellBarSearchPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.11.0](https://github.com/UI5/webcomponents/releases/tag/v2.11.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<Button>` */ filterButton?: UI5WCSlotsNode; @@ -123,6 +129,8 @@ interface ShellBarSearchPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IllustratedMessage>` */ illustration?: UI5WCSlotsNode; @@ -134,6 +142,8 @@ interface ShellBarSearchPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<SearchMessageArea>` */ messageArea?: UI5WCSlotsNode; @@ -145,6 +155,8 @@ interface ShellBarSearchPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<ISearchScope>` */ scopes?: UI5WCSlotsNode; /** @@ -198,7 +210,7 @@ interface ShellBarSearchPropTypes /** * Search field for the ShellBar component. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ShellBarSearch UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/ShellBarSearch) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.10.0](https://github.com/UI5/webcomponents/releases/tag/v2.10.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/ShellBarSpacer/index.tsx b/packages/main/src/webComponents/ShellBarSpacer/index.tsx index 1bf5d16221e..a34208d192c 100644 --- a/packages/main/src/webComponents/ShellBarSpacer/index.tsx +++ b/packages/main/src/webComponents/ShellBarSpacer/index.tsx @@ -14,7 +14,7 @@ interface ShellBarSpacerPropTypes extends ShellBarSpacerAttributes, CommonProps * The `ShellBarSpacer` is an element, used for visual separation between the two content parts of the `ShellBar`. * **Note:** The `ShellBarSpacer` component is in an experimental state and is a subject to change. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ShellBarSpacer UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/ShellBarSpacer) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.7.0](https://github.com/UI5/webcomponents/releases/tag/v2.7.0) of __@ui5/webcomponents-fiori__. * @abstract diff --git a/packages/main/src/webComponents/SideNavigation/index.tsx b/packages/main/src/webComponents/SideNavigation/index.tsx index 306890a6a87..5025c3c4cf3 100644 --- a/packages/main/src/webComponents/SideNavigation/index.tsx +++ b/packages/main/src/webComponents/SideNavigation/index.tsx @@ -29,6 +29,8 @@ interface SideNavigationPropTypes Omit<CommonProps, keyof SideNavigationAttributes | 'children' | 'fixedItems' | 'header' | 'onSelectionChange'> { /** * Defines the main items of the component. + * + * __Supported Node Type/s:__ `Array<SideNavigationItemBase>` */ children?: ReactNode | ReactNode[]; @@ -42,6 +44,8 @@ interface SideNavigationPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<SideNavigationItemBase>` */ fixedItems?: UI5WCSlotsNode; @@ -55,6 +59,8 @@ interface SideNavigationPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ header?: UI5WCSlotsNode; /** @@ -106,7 +112,7 @@ interface SideNavigationPropTypes * * `import "@ui5/webcomponents-fiori/dist/SideNavigationSubItem.js";` (for `SideNavigationSubItem`) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SideNavigation UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/SideNavigation) | [Repository](https://github.com/UI5/webcomponents) */ const SideNavigation = withWebComponent<SideNavigationPropTypes, SideNavigationDomRef>( 'ui5-side-navigation', diff --git a/packages/main/src/webComponents/SideNavigationGroup/index.tsx b/packages/main/src/webComponents/SideNavigationGroup/index.tsx index d7e0558ba0b..26c075462eb 100644 --- a/packages/main/src/webComponents/SideNavigationGroup/index.tsx +++ b/packages/main/src/webComponents/SideNavigationGroup/index.tsx @@ -47,6 +47,8 @@ interface SideNavigationGroupPropTypes Omit<CommonProps, keyof SideNavigationGroupAttributes | 'children'> { /** * Defines nested items by passing `SideNavigationItem` to the default slot. + * + * __Supported Node Type/s:__ `Array<SideNavigationItem>` */ children?: ReactNode | ReactNode[]; } @@ -57,7 +59,7 @@ interface SideNavigationGroupPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SideNavigationGroup UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/SideNavigationGroup) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.24.0](https://github.com/UI5/webcomponents/releases/tag/v1.24.0) of __@ui5/webcomponents-fiori__. * @abstract diff --git a/packages/main/src/webComponents/SideNavigationItem/index.tsx b/packages/main/src/webComponents/SideNavigationItem/index.tsx index ea585098885..4f898085214 100644 --- a/packages/main/src/webComponents/SideNavigationItem/index.tsx +++ b/packages/main/src/webComponents/SideNavigationItem/index.tsx @@ -138,6 +138,8 @@ interface SideNavigationItemPropTypes Omit<CommonProps, keyof SideNavigationItemAttributes | 'children' | 'onClick'> { /** * Defines nested items by passing `SideNavigationSubItem` to the default slot. + * + * __Supported Node Type/s:__ `Array<SideNavigationSubItem>` */ children?: ReactNode | ReactNode[]; /** @@ -158,7 +160,7 @@ interface SideNavigationItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SideNavigationItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/SideNavigationItem) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const SideNavigationItem = withWebComponent<SideNavigationItemPropTypes, SideNavigationItemDomRef>( diff --git a/packages/main/src/webComponents/SideNavigationSubItem/index.tsx b/packages/main/src/webComponents/SideNavigationSubItem/index.tsx index 7d840707024..980cfdfbd1a 100644 --- a/packages/main/src/webComponents/SideNavigationSubItem/index.tsx +++ b/packages/main/src/webComponents/SideNavigationSubItem/index.tsx @@ -147,7 +147,7 @@ interface SideNavigationSubItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SideNavigationSubItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/SideNavigationSubItem) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const SideNavigationSubItem = withWebComponent<SideNavigationSubItemPropTypes, SideNavigationSubItemDomRef>( diff --git a/packages/main/src/webComponents/Slider/index.tsx b/packages/main/src/webComponents/Slider/index.tsx index 9d6aef429c8..032ef90df07 100644 --- a/packages/main/src/webComponents/Slider/index.tsx +++ b/packages/main/src/webComponents/Slider/index.tsx @@ -154,7 +154,7 @@ interface SliderPropTypes extends SliderAttributes, Omit<CommonProps, keyof Slid * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Slider UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Slider) | [Repository](https://github.com/UI5/webcomponents) */ const Slider = withWebComponent<SliderPropTypes, SliderDomRef>( 'ui5-slider', diff --git a/packages/main/src/webComponents/SortItem/index.tsx b/packages/main/src/webComponents/SortItem/index.tsx index d3bfd36a292..af4a2406654 100644 --- a/packages/main/src/webComponents/SortItem/index.tsx +++ b/packages/main/src/webComponents/SortItem/index.tsx @@ -28,7 +28,7 @@ interface SortItemPropTypes extends SortItemAttributes, Omit<CommonProps, keyof * For the `SortItem` * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SortItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/SortItem) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const SortItem = withWebComponent<SortItemPropTypes, SortItemDomRef>('ui5-sort-item', ['text'], ['selected'], [], []); diff --git a/packages/main/src/webComponents/SpecialCalendarDate/index.tsx b/packages/main/src/webComponents/SpecialCalendarDate/index.tsx index 394db08b252..7646e3a2db7 100644 --- a/packages/main/src/webComponents/SpecialCalendarDate/index.tsx +++ b/packages/main/src/webComponents/SpecialCalendarDate/index.tsx @@ -29,7 +29,7 @@ interface SpecialCalendarDatePropTypes * The `SpecialCalendarDate` component defines a special calendar date to be used inside `Calendar`, * which is visually distinguished from the rest of the dates. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SpecialCalendarDate UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/SpecialCalendarDate) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.23.0](https://github.com/UI5/webcomponents/releases/tag/v1.23.0) of __@ui5/webcomponents__. * @abstract diff --git a/packages/main/src/webComponents/SplitButton/index.tsx b/packages/main/src/webComponents/SplitButton/index.tsx index 4fc18226264..fe9207bf797 100644 --- a/packages/main/src/webComponents/SplitButton/index.tsx +++ b/packages/main/src/webComponents/SplitButton/index.tsx @@ -80,6 +80,8 @@ interface SplitButtonPropTypes * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; /** @@ -135,7 +137,7 @@ interface SplitButtonPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SplitButton UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/SplitButton) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.1.0](https://github.com/UI5/webcomponents/releases/tag/v1.1.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/StepInput/index.tsx b/packages/main/src/webComponents/StepInput/index.tsx index 395f498a96b..39c7a6040de 100644 --- a/packages/main/src/webComponents/StepInput/index.tsx +++ b/packages/main/src/webComponents/StepInput/index.tsx @@ -110,6 +110,8 @@ interface StepInputPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -181,7 +183,7 @@ interface StepInputPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [StepInput UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/StepInput) | [Repository](https://github.com/UI5/webcomponents) */ const StepInput = withWebComponent<StepInputPropTypes, StepInputDomRef>( 'ui5-step-input', diff --git a/packages/main/src/webComponents/SuggestionItem/index.tsx b/packages/main/src/webComponents/SuggestionItem/index.tsx index 359c9119c10..e7f35736e3e 100644 --- a/packages/main/src/webComponents/SuggestionItem/index.tsx +++ b/packages/main/src/webComponents/SuggestionItem/index.tsx @@ -25,7 +25,7 @@ interface SuggestionItemPropTypes extends SuggestionItemAttributes, Omit<CommonP /** * The `SuggestionItem` represents the suggestion item of the `Input`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SuggestionItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/SuggestionItem) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const SuggestionItem = withWebComponent<SuggestionItemPropTypes, SuggestionItemDomRef>( diff --git a/packages/main/src/webComponents/SuggestionItemCustom/index.tsx b/packages/main/src/webComponents/SuggestionItemCustom/index.tsx index c80c7529898..cd6f710d15f 100644 --- a/packages/main/src/webComponents/SuggestionItemCustom/index.tsx +++ b/packages/main/src/webComponents/SuggestionItemCustom/index.tsx @@ -21,6 +21,8 @@ interface SuggestionItemCustomPropTypes Omit<CommonProps, keyof SuggestionItemCustomAttributes | 'children'> { /** * Defines the content of the component. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -31,7 +33,7 @@ interface SuggestionItemCustomPropTypes * The text property is considered only for autocomplete. * In case the user needs highlighting functionality, check "@ui5/webcomponents-base/dist/util/generateHighlightedMarkup.js" * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SuggestionItemCustom UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/SuggestionItemCustom) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/SuggestionItemGroup/index.tsx b/packages/main/src/webComponents/SuggestionItemGroup/index.tsx index b6addeb2ded..45a087b2a35 100644 --- a/packages/main/src/webComponents/SuggestionItemGroup/index.tsx +++ b/packages/main/src/webComponents/SuggestionItemGroup/index.tsx @@ -46,6 +46,8 @@ interface SuggestionItemGroupPropTypes Omit<CommonProps, keyof SuggestionItemGroupAttributes | 'children' | 'header' | 'onMove' | 'onMoveOver'> { /** * Defines the items of the <code>ui5-suggestion-item-group</code>. + * + * __Supported Node Type/s:__ `Array<SuggestionListItem>` */ children?: ReactNode | ReactNode[]; @@ -59,6 +61,8 @@ interface SuggestionItemGroupPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<ListItemBase>` */ header?: UI5WCSlotsNode; /** @@ -94,7 +98,7 @@ interface SuggestionItemGroupPropTypes * The `SuggestionItemGroup` is type of suggestion item, * that can be used to split the `Input` suggestions into groups. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [SuggestionItemGroup UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/SuggestionItemGroup) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/Switch/index.tsx b/packages/main/src/webComponents/Switch/index.tsx index 6ce94fc8640..4b35c04a4d0 100644 --- a/packages/main/src/webComponents/Switch/index.tsx +++ b/packages/main/src/webComponents/Switch/index.tsx @@ -136,7 +136,7 @@ interface SwitchPropTypes extends SwitchAttributes, Omit<CommonProps, keyof Swit * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Switch UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Switch) | [Repository](https://github.com/UI5/webcomponents) */ const Switch = withWebComponent<SwitchPropTypes, SwitchDomRef>( 'ui5-switch', diff --git a/packages/main/src/webComponents/Tab/index.tsx b/packages/main/src/webComponents/Tab/index.tsx index e904534c906..f9150f0fa2e 100644 --- a/packages/main/src/webComponents/Tab/index.tsx +++ b/packages/main/src/webComponents/Tab/index.tsx @@ -79,6 +79,8 @@ interface TabDomRef extends Required<TabAttributes>, Ui5DomRef { interface TabPropTypes extends TabAttributes, Omit<CommonProps, keyof TabAttributes | 'children' | 'items'> { /** * Holds the content associated with this tab. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; @@ -92,6 +94,8 @@ interface TabPropTypes extends TabAttributes, Omit<CommonProps, keyof TabAttribu * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<ITab>` */ items?: UI5WCSlotsNode; } @@ -101,7 +105,7 @@ interface TabPropTypes extends TabAttributes, Omit<CommonProps, keyof TabAttribu * It defines both the item in the tab strip (top part of the `TabContainer`) and the * content that is presented to the user once the tab is selected. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Tab UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Tab) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const Tab = withWebComponent<TabPropTypes, TabDomRef>( diff --git a/packages/main/src/webComponents/TabContainer/index.tsx b/packages/main/src/webComponents/TabContainer/index.tsx index 926ce6ab919..7f001b7f6fb 100644 --- a/packages/main/src/webComponents/TabContainer/index.tsx +++ b/packages/main/src/webComponents/TabContainer/index.tsx @@ -95,6 +95,8 @@ interface TabContainerPropTypes * Defines the tabs. * * **Note:** Use `Tab` and `TabSeparator` for the intended design. + * + * __Supported Node Type/s:__ `Array<ITab>` */ children?: ReactNode | ReactNode[]; @@ -107,6 +109,8 @@ interface TabContainerPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IButton>` */ overflowButton?: UI5WCSlotsNode; @@ -121,6 +125,8 @@ interface TabContainerPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.1.0](https://github.com/UI5/webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<IButton>` */ startOverflowButton?: UI5WCSlotsNode; /** @@ -193,7 +199,7 @@ interface TabContainerPropTypes * * `import "@ui5/webcomponents/dist/TabSeparator.js";` (for `TabSeparator`) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TabContainer UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TabContainer) | [Repository](https://github.com/UI5/webcomponents) */ const TabContainer = withWebComponent<TabContainerPropTypes, TabContainerDomRef>( 'ui5-tabcontainer', diff --git a/packages/main/src/webComponents/TabSeparator/index.tsx b/packages/main/src/webComponents/TabSeparator/index.tsx index c40cd86de0d..445d3478463 100644 --- a/packages/main/src/webComponents/TabSeparator/index.tsx +++ b/packages/main/src/webComponents/TabSeparator/index.tsx @@ -21,7 +21,7 @@ interface TabSeparatorPropTypes extends TabSeparatorAttributes, CommonProps {} /** * The `TabSeparator` represents a vertical line to separate tabs inside a `TabContainer`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TabSeparator UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TabSeparator) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const TabSeparator = withWebComponent<TabSeparatorPropTypes, TabSeparatorDomRef>('ui5-tab-separator', [], [], [], []); diff --git a/packages/main/src/webComponents/Table/index.tsx b/packages/main/src/webComponents/Table/index.tsx index 0b1c49fb8fe..fb37156f153 100644 --- a/packages/main/src/webComponents/Table/index.tsx +++ b/packages/main/src/webComponents/Table/index.tsx @@ -86,6 +86,8 @@ interface TablePropTypes * Defines the rows of the component. * * **Note:** Use `TableRow` for the intended design. + * + * __Supported Node Type/s:__ `Array<TableRow>` */ children?: ReactNode | ReactNode[]; @@ -97,6 +99,8 @@ interface TablePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<ITableFeature>` */ features?: UI5WCSlotsNode; @@ -110,6 +114,8 @@ interface TablePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<TableHeaderRow>` */ headerRow?: UI5WCSlotsNode; @@ -121,6 +127,8 @@ interface TablePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ noData?: UI5WCSlotsNode; /** @@ -243,7 +251,7 @@ interface TablePropTypes * `import "@ui5/webcomponents/dist/TableHeaderRow.js";` (`TableHeaderRow`)\ * `import "@ui5/webcomponents/dist/TableHeaderCell.js";` (`TableHeaderCell`) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Table UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Table) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableCell/index.tsx b/packages/main/src/webComponents/TableCell/index.tsx index e61c475c72c..36ed3830981 100644 --- a/packages/main/src/webComponents/TableCell/index.tsx +++ b/packages/main/src/webComponents/TableCell/index.tsx @@ -19,6 +19,8 @@ interface TableCellDomRef extends Required<TableCellAttributes>, Ui5DomRef {} interface TableCellPropTypes extends TableCellAttributes, Omit<CommonProps, keyof TableCellAttributes | 'children'> { /** * Defines the content of the component. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -29,7 +31,7 @@ interface TableCellPropTypes extends TableCellAttributes, Omit<CommonProps, keyo * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableCell UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableCell) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableGrowing/index.tsx b/packages/main/src/webComponents/TableGrowing/index.tsx index c72cd10798f..11a2ebe4eac 100644 --- a/packages/main/src/webComponents/TableGrowing/index.tsx +++ b/packages/main/src/webComponents/TableGrowing/index.tsx @@ -78,7 +78,7 @@ interface TableGrowingPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableGrowing UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableGrowing) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableHeaderCell/index.tsx b/packages/main/src/webComponents/TableHeaderCell/index.tsx index 3b54881767e..ccf47270454 100644 --- a/packages/main/src/webComponents/TableHeaderCell/index.tsx +++ b/packages/main/src/webComponents/TableHeaderCell/index.tsx @@ -96,11 +96,15 @@ interface TableHeaderCellPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.8.0](https://github.com/UI5/webcomponents/releases/tag/v2.8.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<TableHeaderCellActionBase>` */ action?: UI5WCSlotsNode; /** * Defines the content of the component. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -113,7 +117,7 @@ interface TableHeaderCellPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableHeaderCell UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableHeaderCell) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableHeaderCellActionAI/index.tsx b/packages/main/src/webComponents/TableHeaderCellActionAI/index.tsx index afd1a09b078..2197c5a4ffa 100644 --- a/packages/main/src/webComponents/TableHeaderCellActionAI/index.tsx +++ b/packages/main/src/webComponents/TableHeaderCellActionAI/index.tsx @@ -27,7 +27,7 @@ interface TableHeaderCellActionAIPropTypes extends TableHeaderCellActionAIAttrib * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableHeaderCellActionAI UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableHeaderCellActionAI) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.8.0](https://github.com/UI5/webcomponents/releases/tag/v2.8.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableHeaderRow/index.tsx b/packages/main/src/webComponents/TableHeaderRow/index.tsx index d5a62605a8f..ccb39f83364 100644 --- a/packages/main/src/webComponents/TableHeaderRow/index.tsx +++ b/packages/main/src/webComponents/TableHeaderRow/index.tsx @@ -24,6 +24,8 @@ interface TableHeaderRowPropTypes * Defines the cells of the component. * * **Note:** Use `TableHeaderCell` for the intended design. + * + * __Supported Node Type/s:__ `Array<TableHeaderCell>` */ children?: ReactNode | ReactNode[]; } @@ -36,7 +38,7 @@ interface TableHeaderRowPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableHeaderRow UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableHeaderRow) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableRow/index.tsx b/packages/main/src/webComponents/TableRow/index.tsx index 4574cc1a7b6..e870782b691 100644 --- a/packages/main/src/webComponents/TableRow/index.tsx +++ b/packages/main/src/webComponents/TableRow/index.tsx @@ -60,6 +60,8 @@ interface TableRowPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.7.0](https://github.com/UI5/webcomponents/releases/tag/v2.7.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<TableRowActionBase>` */ actions?: UI5WCSlotsNode; @@ -67,6 +69,8 @@ interface TableRowPropTypes * Defines the cells of the component. * * **Note:** Use `TableCell` for the intended design. + * + * __Supported Node Type/s:__ `Array<TableCell>` */ children?: ReactNode | ReactNode[]; } @@ -76,7 +80,7 @@ interface TableRowPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableRow UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableRow) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableRowAction/index.tsx b/packages/main/src/webComponents/TableRowAction/index.tsx index d3a6d6ab602..af063b779a9 100644 --- a/packages/main/src/webComponents/TableRowAction/index.tsx +++ b/packages/main/src/webComponents/TableRowAction/index.tsx @@ -53,7 +53,7 @@ interface TableRowActionPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableRowAction UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableRowAction) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.7.0](https://github.com/UI5/webcomponents/releases/tag/v2.7.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableRowActionNavigation/index.tsx b/packages/main/src/webComponents/TableRowActionNavigation/index.tsx index 805d230f497..3011ac04566 100644 --- a/packages/main/src/webComponents/TableRowActionNavigation/index.tsx +++ b/packages/main/src/webComponents/TableRowActionNavigation/index.tsx @@ -42,7 +42,7 @@ interface TableRowActionNavigationPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableRowActionNavigation UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableRowActionNavigation) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.7.0](https://github.com/UI5/webcomponents/releases/tag/v2.7.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableSelection/index.tsx b/packages/main/src/webComponents/TableSelection/index.tsx index af9c897fab5..7beab77de21 100644 --- a/packages/main/src/webComponents/TableSelection/index.tsx +++ b/packages/main/src/webComponents/TableSelection/index.tsx @@ -57,7 +57,7 @@ interface TableSelectionPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableSelection UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableSelection) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. * @experimental This web component is available since 2.0 with an experimental flag and its API and behavior are subject to change. diff --git a/packages/main/src/webComponents/TableSelectionMulti/index.tsx b/packages/main/src/webComponents/TableSelectionMulti/index.tsx index cea4e7a6f5d..0e8829aea46 100644 --- a/packages/main/src/webComponents/TableSelectionMulti/index.tsx +++ b/packages/main/src/webComponents/TableSelectionMulti/index.tsx @@ -90,7 +90,7 @@ interface TableSelectionMultiPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableSelectionMulti UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableSelectionMulti) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.8.0](https://github.com/UI5/webcomponents/releases/tag/v2.8.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableSelectionSingle/index.tsx b/packages/main/src/webComponents/TableSelectionSingle/index.tsx index e4eae1d2ff6..7fea8fca74a 100644 --- a/packages/main/src/webComponents/TableSelectionSingle/index.tsx +++ b/packages/main/src/webComponents/TableSelectionSingle/index.tsx @@ -68,7 +68,7 @@ interface TableSelectionSinglePropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableSelectionSingle UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableSelectionSingle) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.8.0](https://github.com/UI5/webcomponents/releases/tag/v2.8.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TableVirtualizer/index.tsx b/packages/main/src/webComponents/TableVirtualizer/index.tsx index 770f3abbff0..61a7388e7d7 100644 --- a/packages/main/src/webComponents/TableVirtualizer/index.tsx +++ b/packages/main/src/webComponents/TableVirtualizer/index.tsx @@ -61,7 +61,7 @@ interface TableVirtualizerPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TableVirtualizer UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TableVirtualizer) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.5.0](https://github.com/UI5/webcomponents/releases/tag/v2.5.0) of __@ui5/webcomponents__. * @experimental This component is not intended to be used in a productive enviroment. The API is under development and may be changed in the future. diff --git a/packages/main/src/webComponents/Tag/index.tsx b/packages/main/src/webComponents/Tag/index.tsx index d0603ba6c91..4d1ce5211d1 100644 --- a/packages/main/src/webComponents/Tag/index.tsx +++ b/packages/main/src/webComponents/Tag/index.tsx @@ -68,6 +68,8 @@ interface TagPropTypes extends TagAttributes, Omit<CommonProps, keyof TagAttribu * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; @@ -79,6 +81,8 @@ interface TagPropTypes extends TagAttributes, Omit<CommonProps, keyof TagAttribu * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IIcon>` */ icon?: UI5WCSlotsNode; /** @@ -108,7 +112,7 @@ interface TagPropTypes extends TagAttributes, Omit<CommonProps, keyof TagAttribu * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Tag UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Tag) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/Text/index.tsx b/packages/main/src/webComponents/Text/index.tsx index 534a24038bf..60b096d0144 100644 --- a/packages/main/src/webComponents/Text/index.tsx +++ b/packages/main/src/webComponents/Text/index.tsx @@ -27,6 +27,8 @@ interface TextDomRef extends Required<TextAttributes>, Ui5DomRef {} interface TextPropTypes extends TextAttributes, Omit<CommonProps, keyof TextAttributes | 'children'> { /** * Defines the text of the component. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -52,7 +54,7 @@ interface TextPropTypes extends TextAttributes, Omit<CommonProps, keyof TextAttr * * <code>import "@ui5/webcomponents/dist/Text";</code> * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Text UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Text) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/TextArea/index.tsx b/packages/main/src/webComponents/TextArea/index.tsx index 184fa5c6483..fa844ba82d1 100644 --- a/packages/main/src/webComponents/TextArea/index.tsx +++ b/packages/main/src/webComponents/TextArea/index.tsx @@ -136,6 +136,8 @@ interface TextAreaPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -190,7 +192,7 @@ interface TextAreaPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TextArea UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TextArea) | [Repository](https://github.com/UI5/webcomponents) */ const TextArea = withWebComponent<TextAreaPropTypes, TextAreaDomRef>( 'ui5-textarea', diff --git a/packages/main/src/webComponents/TimePicker/index.tsx b/packages/main/src/webComponents/TimePicker/index.tsx index b4e77eb6731..38d0f1d2eff 100644 --- a/packages/main/src/webComponents/TimePicker/index.tsx +++ b/packages/main/src/webComponents/TimePicker/index.tsx @@ -153,6 +153,8 @@ interface TimePickerPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ valueStateMessage?: UI5WCSlotsNode; /** @@ -250,7 +252,7 @@ interface TimePickerPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TimePicker UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TimePicker) | [Repository](https://github.com/UI5/webcomponents) */ const TimePicker = withWebComponent<TimePickerPropTypes, TimePickerDomRef>( 'ui5-time-picker', diff --git a/packages/main/src/webComponents/Timeline/index.tsx b/packages/main/src/webComponents/Timeline/index.tsx index d67a6911ca5..524fab2cda8 100644 --- a/packages/main/src/webComponents/Timeline/index.tsx +++ b/packages/main/src/webComponents/Timeline/index.tsx @@ -61,6 +61,8 @@ interface TimelinePropTypes Omit<CommonProps, keyof TimelineAttributes | 'children' | 'onLoadMore'> { /** * Determines the content of the `Timeline`. + * + * __Supported Node Type/s:__ `Array<ITimelineItem>` */ children?: ReactNode | ReactNode[]; /** @@ -84,7 +86,7 @@ interface TimelinePropTypes * There are two distinct variants of the timeline: basic and social. The basic timeline is read-only, * while the social timeline offers a high level of interaction and collaboration, and is integrated within SAP Jam. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Timeline UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/Timeline) | [Repository](https://github.com/UI5/webcomponents) */ const Timeline = withWebComponent<TimelinePropTypes, TimelineDomRef>( 'ui5-timeline', diff --git a/packages/main/src/webComponents/TimelineGroupItem/index.tsx b/packages/main/src/webComponents/TimelineGroupItem/index.tsx index 9cf8077a2b5..a660ea49699 100644 --- a/packages/main/src/webComponents/TimelineGroupItem/index.tsx +++ b/packages/main/src/webComponents/TimelineGroupItem/index.tsx @@ -26,6 +26,8 @@ interface TimelineGroupItemPropTypes Omit<CommonProps, keyof TimelineGroupItemAttributes | 'children' | 'onToggle'> { /** * Determines the content of the `TimelineGroupItem`. + * + * __Supported Node Type/s:__ `Array<ITimelineItem>` */ children?: ReactNode | ReactNode[]; /** @@ -44,7 +46,7 @@ interface TimelineGroupItemPropTypes * * **Note**: Please do not use empty groups in order to preserve the intended design. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TimelineGroupItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/TimelineGroupItem) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.1.0](https://github.com/UI5/webcomponents/releases/tag/v2.1.0) of __@ui5/webcomponents-fiori__. */ diff --git a/packages/main/src/webComponents/TimelineItem/index.tsx b/packages/main/src/webComponents/TimelineItem/index.tsx index 8d607bb85ec..097cd3c7d3f 100644 --- a/packages/main/src/webComponents/TimelineItem/index.tsx +++ b/packages/main/src/webComponents/TimelineItem/index.tsx @@ -56,6 +56,8 @@ interface TimelineItemPropTypes Omit<CommonProps, keyof TimelineItemAttributes | 'children' | 'onNameClick'> { /** * Defines the content of the `TimelineItem`. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; /** @@ -75,7 +77,7 @@ interface TimelineItemPropTypes /** * An entry posted on the timeline. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TimelineItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/TimelineItem) | [Repository](https://github.com/UI5/webcomponents) */ const TimelineItem = withWebComponent<TimelineItemPropTypes, TimelineItemDomRef>( 'ui5-timeline-item', diff --git a/packages/main/src/webComponents/Title/index.tsx b/packages/main/src/webComponents/Title/index.tsx index d8cdff07e43..0800bedfa47 100644 --- a/packages/main/src/webComponents/Title/index.tsx +++ b/packages/main/src/webComponents/Title/index.tsx @@ -41,6 +41,8 @@ interface TitlePropTypes extends TitleAttributes, Omit<CommonProps, keyof TitleA * This component supports nesting a `Link` component inside. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -51,7 +53,7 @@ interface TitlePropTypes extends TitleAttributes, Omit<CommonProps, keyof TitleA * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Title UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Title) | [Repository](https://github.com/UI5/webcomponents) */ const Title = withWebComponent<TitlePropTypes, TitleDomRef>('ui5-title', ['level', 'size', 'wrappingType'], [], [], []); diff --git a/packages/main/src/webComponents/Toast/index.tsx b/packages/main/src/webComponents/Toast/index.tsx index 2c2cd08929d..16f0b6e0f80 100644 --- a/packages/main/src/webComponents/Toast/index.tsx +++ b/packages/main/src/webComponents/Toast/index.tsx @@ -39,6 +39,8 @@ interface ToastPropTypes extends ToastAttributes, Omit<CommonProps, keyof ToastA * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; /** @@ -74,7 +76,7 @@ interface ToastPropTypes extends ToastAttributes, Omit<CommonProps, keyof ToastA * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Toast UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Toast) | [Repository](https://github.com/UI5/webcomponents) */ const Toast = withWebComponent<ToastPropTypes, ToastDomRef>( 'ui5-toast', diff --git a/packages/main/src/webComponents/ToggleButton/index.tsx b/packages/main/src/webComponents/ToggleButton/index.tsx index c6d9595a794..eb19fd492af 100644 --- a/packages/main/src/webComponents/ToggleButton/index.tsx +++ b/packages/main/src/webComponents/ToggleButton/index.tsx @@ -168,6 +168,8 @@ interface ToggleButtonPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.7.0](https://github.com/UI5/webcomponents/releases/tag/v2.7.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<ButtonBadge>` */ badge?: UI5WCSlotsNode; @@ -175,6 +177,8 @@ interface ToggleButtonPropTypes * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; /** @@ -205,7 +209,7 @@ interface ToggleButtonPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ToggleButton UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ToggleButton) | [Repository](https://github.com/UI5/webcomponents) */ const ToggleButton = withWebComponent<ToggleButtonPropTypes, ToggleButtonDomRef>( 'ui5-toggle-button', diff --git a/packages/main/src/webComponents/Token/index.tsx b/packages/main/src/webComponents/Token/index.tsx index 9cc9aefe497..842ba766d12 100644 --- a/packages/main/src/webComponents/Token/index.tsx +++ b/packages/main/src/webComponents/Token/index.tsx @@ -30,6 +30,8 @@ interface TokenPropTypes extends TokenAttributes, Omit<CommonProps, keyof TokenA * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<IIcon>` */ closeIcon?: UI5WCSlotsNode; } @@ -39,7 +41,7 @@ interface TokenPropTypes extends TokenAttributes, Omit<CommonProps, keyof TokenA * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Token UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Token) | [Repository](https://github.com/UI5/webcomponents) */ const Token = withWebComponent<TokenPropTypes, TokenDomRef>('ui5-token', ['text'], ['selected'], ['closeIcon'], []); diff --git a/packages/main/src/webComponents/Tokenizer/index.tsx b/packages/main/src/webComponents/Tokenizer/index.tsx index ff088c5eba2..e962d025c43 100644 --- a/packages/main/src/webComponents/Tokenizer/index.tsx +++ b/packages/main/src/webComponents/Tokenizer/index.tsx @@ -67,6 +67,8 @@ interface TokenizerPropTypes Omit<CommonProps, keyof TokenizerAttributes | 'children' | 'onSelectionChange' | 'onTokenDelete'> { /** * Defines the tokens to be displayed. + * + * __Supported Node Type/s:__ `Array<Token>` */ children?: ReactNode | ReactNode[]; /** @@ -114,7 +116,7 @@ interface TokenizerPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Tokenizer UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Tokenizer) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of __@ui5/webcomponents__. * @experimental This component is availabe since 2.0 under an experimental flag and its API and behaviour are subject to change. diff --git a/packages/main/src/webComponents/Toolbar/index.tsx b/packages/main/src/webComponents/Toolbar/index.tsx index f3a3f00b879..b05f7ab849b 100644 --- a/packages/main/src/webComponents/Toolbar/index.tsx +++ b/packages/main/src/webComponents/Toolbar/index.tsx @@ -48,6 +48,8 @@ interface ToolbarPropTypes extends ToolbarAttributes, Omit<CommonProps, keyof To * Defines the items of the component. * * **Note:** Currently only `ToolbarButton`, `ToolbarSelect`, `ToolbarSeparator` and `ToolbarSpacer` are allowed here. + * + * __Supported Node Type/s:__ `Array<ToolbarItem>` */ children?: ReactNode | ReactNode[]; } @@ -64,7 +66,7 @@ interface ToolbarPropTypes extends ToolbarAttributes, Omit<CommonProps, keyof To * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Toolbar UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Toolbar) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.17.0](https://github.com/UI5/webcomponents/releases/tag/v1.17.0) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/ToolbarButton/index.tsx b/packages/main/src/webComponents/ToolbarButton/index.tsx index beae5c43cd0..a7d84319409 100644 --- a/packages/main/src/webComponents/ToolbarButton/index.tsx +++ b/packages/main/src/webComponents/ToolbarButton/index.tsx @@ -138,7 +138,7 @@ interface ToolbarButtonPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ToolbarButton UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ToolbarButton) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.17.0](https://github.com/UI5/webcomponents/releases/tag/v1.17.0) of __@ui5/webcomponents__. * @abstract diff --git a/packages/main/src/webComponents/ToolbarSelect/index.tsx b/packages/main/src/webComponents/ToolbarSelect/index.tsx index 152669bf5bf..b5c36c77c13 100644 --- a/packages/main/src/webComponents/ToolbarSelect/index.tsx +++ b/packages/main/src/webComponents/ToolbarSelect/index.tsx @@ -70,6 +70,8 @@ interface ToolbarSelectPropTypes * If more than one option is defined as selected, the last one would be considered as the selected one. * * **Note:** Use the `ToolbarSelectOption` component to define the desired options. + * + * __Supported Node Type/s:__ `Array<ToolbarSelectOption>` */ children?: ReactNode | ReactNode[]; /** @@ -110,7 +112,7 @@ interface ToolbarSelectPropTypes * * `import "@ui5/webcomponents/dist/ToolbarSelectOption.js";` (comes with `ToolbarSelect`) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ToolbarSelect UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ToolbarSelect) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.17.0](https://github.com/UI5/webcomponents/releases/tag/v1.17.0) of __@ui5/webcomponents__. * @abstract diff --git a/packages/main/src/webComponents/ToolbarSelectOption/index.tsx b/packages/main/src/webComponents/ToolbarSelectOption/index.tsx index 5aefd9de887..0fb4cde63cc 100644 --- a/packages/main/src/webComponents/ToolbarSelectOption/index.tsx +++ b/packages/main/src/webComponents/ToolbarSelectOption/index.tsx @@ -22,6 +22,8 @@ interface ToolbarSelectOptionPropTypes * Defines the text of the component. * * **Note:** Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -29,7 +31,7 @@ interface ToolbarSelectOptionPropTypes /** * The `ToolbarSelectOption` component defines the content of an option in the `ToolbarSelect`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ToolbarSelectOption UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ToolbarSelectOption) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.17.0](https://github.com/UI5/webcomponents/releases/tag/v1.17.0) of __@ui5/webcomponents__. * @abstract diff --git a/packages/main/src/webComponents/ToolbarSeparator/index.tsx b/packages/main/src/webComponents/ToolbarSeparator/index.tsx index 8ede030b9cc..1a16014bdf9 100644 --- a/packages/main/src/webComponents/ToolbarSeparator/index.tsx +++ b/packages/main/src/webComponents/ToolbarSeparator/index.tsx @@ -31,7 +31,7 @@ interface ToolbarSeparatorPropTypes * The `ToolbarSeparator` is an element, used for visual separation between two elements. * It takes no space in calculating toolbar items width. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ToolbarSeparator UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ToolbarSeparator) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.17.0](https://github.com/UI5/webcomponents/releases/tag/v1.17.0) of __@ui5/webcomponents__. * @abstract diff --git a/packages/main/src/webComponents/ToolbarSpacer/index.tsx b/packages/main/src/webComponents/ToolbarSpacer/index.tsx index 7d925d7270d..a532447cfd3 100644 --- a/packages/main/src/webComponents/ToolbarSpacer/index.tsx +++ b/packages/main/src/webComponents/ToolbarSpacer/index.tsx @@ -37,7 +37,7 @@ interface ToolbarSpacerPropTypes extends ToolbarSpacerAttributes, Omit<CommonPro * The `ToolbarSpacer` is an element, used for taking needed space for toolbar items to take 100% width. * It takes no space in calculating toolbar items width. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ToolbarSpacer UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/ToolbarSpacer) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.17.0](https://github.com/UI5/webcomponents/releases/tag/v1.17.0) of __@ui5/webcomponents__. * @abstract diff --git a/packages/main/src/webComponents/Tree/index.tsx b/packages/main/src/webComponents/Tree/index.tsx index 0f073193dca..36d39241a81 100644 --- a/packages/main/src/webComponents/Tree/index.tsx +++ b/packages/main/src/webComponents/Tree/index.tsx @@ -106,6 +106,8 @@ interface TreePropTypes * Defines the items of the component. Tree items may have other tree items as children. * * **Note:** Use `TreeItem` for the intended design. + * + * __Supported Node Type/s:__ `Array<TreeItemBase>` */ children?: ReactNode | ReactNode[]; @@ -120,6 +122,8 @@ interface TreePropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ header?: UI5WCSlotsNode; /** @@ -248,7 +252,7 @@ interface TreePropTypes * * `import "@ui5/webcomponents/dist/TreeItem.js";` * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Tree UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/Tree) | [Repository](https://github.com/UI5/webcomponents) */ const Tree = withWebComponent<TreePropTypes, TreeDomRef>( 'ui5-tree', diff --git a/packages/main/src/webComponents/TreeItem/index.tsx b/packages/main/src/webComponents/TreeItem/index.tsx index 72da79af81c..9a81bba65bf 100644 --- a/packages/main/src/webComponents/TreeItem/index.tsx +++ b/packages/main/src/webComponents/TreeItem/index.tsx @@ -159,6 +159,8 @@ interface TreeItemPropTypes * Defines the items of the component. * * **Note:** Use `TreeItem` or `TreeItemCustom` + * + * __Supported Node Type/s:__ `Array<TreeItemBase>` */ children?: ReactNode | ReactNode[]; @@ -175,6 +177,8 @@ interface TreeItemPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.9.0](https://github.com/UI5/webcomponents/releases/tag/v1.9.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<IButton>` */ deleteButton?: UI5WCSlotsNode; @@ -192,6 +196,8 @@ interface TreeItemPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.10.0](https://github.com/UI5/webcomponents/releases/tag/v2.10.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ image?: UI5WCSlotsNode; /** @@ -212,7 +218,7 @@ interface TreeItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TreeItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TreeItem) | [Repository](https://github.com/UI5/webcomponents) */ const TreeItem = withWebComponent<TreeItemPropTypes, TreeItemDomRef>( 'ui5-tree-item', diff --git a/packages/main/src/webComponents/TreeItemCustom/index.tsx b/packages/main/src/webComponents/TreeItemCustom/index.tsx index ffb988d7eaf..4e33a824360 100644 --- a/packages/main/src/webComponents/TreeItemCustom/index.tsx +++ b/packages/main/src/webComponents/TreeItemCustom/index.tsx @@ -156,6 +156,8 @@ interface TreeItemCustomPropTypes * Defines the items of the component. * * **Note:** Use `TreeItem` or `TreeItemCustom` + * + * __Supported Node Type/s:__ `Array<TreeItemBase>` */ children?: ReactNode | ReactNode[]; @@ -167,6 +169,8 @@ interface TreeItemCustomPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ content?: UI5WCSlotsNode; @@ -183,6 +187,8 @@ interface TreeItemCustomPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.9.0](https://github.com/UI5/webcomponents/releases/tag/v1.9.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<IButton>` */ deleteButton?: UI5WCSlotsNode; @@ -200,6 +206,8 @@ interface TreeItemCustomPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.10.0](https://github.com/UI5/webcomponents/releases/tag/v2.10.0) of **@ui5/webcomponents**. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ image?: UI5WCSlotsNode; /** @@ -222,7 +230,7 @@ interface TreeItemCustomPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [TreeItemCustom UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/TreeItemCustom) | [Repository](https://github.com/UI5/webcomponents) * * @since [1.9.2](https://github.com/UI5/webcomponents/releases/tag/v1.9.2) of __@ui5/webcomponents__. */ diff --git a/packages/main/src/webComponents/UploadCollection/index.tsx b/packages/main/src/webComponents/UploadCollection/index.tsx index 6b7bdce82fe..6f69f0179c7 100644 --- a/packages/main/src/webComponents/UploadCollection/index.tsx +++ b/packages/main/src/webComponents/UploadCollection/index.tsx @@ -55,6 +55,8 @@ interface UploadCollectionPropTypes * Defines the items of the `UploadCollection`. * * **Note:** Use `UploadCollectionItem` for the intended design. + * + * __Supported Node Type/s:__ `Array<UploadCollectionItem>` */ children?: ReactNode | ReactNode[]; @@ -70,6 +72,8 @@ interface UploadCollectionPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ header?: UI5WCSlotsNode; /** @@ -104,7 +108,7 @@ interface UploadCollectionPropTypes * * `import "@ui5/webcomponents-fiori/dist/UploadCollectionItem.js";` (for `UploadCollectionItem`) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [UploadCollection UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/UploadCollection) | [Repository](https://github.com/UI5/webcomponents) */ const UploadCollection = withWebComponent<UploadCollectionPropTypes, UploadCollectionDomRef>( 'ui5-upload-collection', diff --git a/packages/main/src/webComponents/UploadCollectionItem/index.tsx b/packages/main/src/webComponents/UploadCollectionItem/index.tsx index 2b616644ea5..bd91ca1a6c8 100644 --- a/packages/main/src/webComponents/UploadCollectionItem/index.tsx +++ b/packages/main/src/webComponents/UploadCollectionItem/index.tsx @@ -148,6 +148,8 @@ interface UploadCollectionItemPropTypes > { /** * Hold the description of the `UploadCollectionItem`. Will be shown below the file name. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; @@ -164,6 +166,8 @@ interface UploadCollectionItemPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.9.0](https://github.com/UI5/webcomponents/releases/tag/v1.9.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<IButton>` */ deleteButton?: UI5WCSlotsNode; @@ -177,6 +181,8 @@ interface UploadCollectionItemPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ thumbnail?: UI5WCSlotsNode; /** @@ -239,7 +245,7 @@ interface UploadCollectionItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [UploadCollectionItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/UploadCollectionItem) | [Repository](https://github.com/UI5/webcomponents) */ const UploadCollectionItem = withWebComponent<UploadCollectionItemPropTypes, UploadCollectionItemDomRef>( 'ui5-upload-collection-item', diff --git a/packages/main/src/webComponents/UserMenu/index.tsx b/packages/main/src/webComponents/UserMenu/index.tsx index 251a0197d80..c12a30dc44b 100644 --- a/packages/main/src/webComponents/UserMenu/index.tsx +++ b/packages/main/src/webComponents/UserMenu/index.tsx @@ -80,11 +80,15 @@ interface UserMenuPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<UserMenuAccount>` */ accounts?: UI5WCSlotsNode; /** * Defines the menu items. + * + * __Supported Node Type/s:__ `Array<UserMenuItem>` */ children?: ReactNode | ReactNode[]; /** @@ -180,7 +184,7 @@ interface UserMenuPropTypes * * `import "@ui5/webcomponents-fiori/dist/UserMenuItem.js";` (for `UserMenuItem`) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [UserMenu UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/UserMenu) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.5.0](https://github.com/UI5/webcomponents/releases/tag/v2.5.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/UserMenuAccount/index.tsx b/packages/main/src/webComponents/UserMenuAccount/index.tsx index 0286acd8cdd..564a2fb896e 100644 --- a/packages/main/src/webComponents/UserMenuAccount/index.tsx +++ b/packages/main/src/webComponents/UserMenuAccount/index.tsx @@ -57,7 +57,7 @@ interface UserMenuAccountPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [UserMenuAccount UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/UserMenuAccount) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.5.0](https://github.com/UI5/webcomponents/releases/tag/v2.5.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/UserMenuItem/index.tsx b/packages/main/src/webComponents/UserMenuItem/index.tsx index 31b25426c31..55718df201e 100644 --- a/packages/main/src/webComponents/UserMenuItem/index.tsx +++ b/packages/main/src/webComponents/UserMenuItem/index.tsx @@ -168,6 +168,8 @@ interface UserMenuItemPropTypes * Defines the items of this component. * * **Note:** Use `UserMenuItem` for the intended design. + * + * __Supported Node Type/s:__ `Array<UserMenuItem>` */ children?: ReactNode | ReactNode[]; @@ -184,6 +186,8 @@ interface UserMenuItemPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v1.9.0](https://github.com/UI5/webcomponents/releases/tag/v1.9.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<IButton>` */ deleteButton?: UI5WCSlotsNode; @@ -209,6 +213,8 @@ interface UserMenuItemPropTypes * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). * * **Note:** Available since [v2.0.0](https://github.com/UI5/webcomponents/releases/tag/v2.0.0) of **@ui5/webcomponents-fiori**. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ endContent?: UI5WCSlotsNode; /** @@ -292,7 +298,7 @@ interface UserMenuItemPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [UserMenuItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/UserMenuItem) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.5.0](https://github.com/UI5/webcomponents/releases/tag/v2.5.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/UserMenuItemGroup/index.tsx b/packages/main/src/webComponents/UserMenuItemGroup/index.tsx index c81ba0739f2..920a361b066 100644 --- a/packages/main/src/webComponents/UserMenuItemGroup/index.tsx +++ b/packages/main/src/webComponents/UserMenuItemGroup/index.tsx @@ -22,6 +22,8 @@ interface UserMenuItemGroupPropTypes /** * Defines the items of this component. * **Note:** The slot can hold any combination of components of type `ui5-menu-item` or `ui5-menu-separator` or both. + * + * __Supported Node Type/s:__ `Array<IMenuItem>` */ children?: ReactNode | ReactNode[]; } @@ -45,7 +47,7 @@ interface UserMenuItemGroupPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [UserMenuItemGroup UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/UserMenuItemGroup) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.12.0](https://github.com/UI5/webcomponents/releases/tag/v2.12.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/UserSettingsDialog/index.tsx b/packages/main/src/webComponents/UserSettingsDialog/index.tsx index 5a7998e4be5..632143b8b48 100644 --- a/packages/main/src/webComponents/UserSettingsDialog/index.tsx +++ b/packages/main/src/webComponents/UserSettingsDialog/index.tsx @@ -46,6 +46,8 @@ interface UserSettingsDialogPropTypes * Defines the user settings items. * * **Note:** If no setting item is set as `selected`, the first one will be selected. + * + * __Supported Node Type/s:__ `Array<UserSettingsItem>` */ children?: ReactNode | ReactNode[]; @@ -57,6 +59,8 @@ interface UserSettingsDialogPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<UserSettingsItem>` */ fixedItems?: UI5WCSlotsNode; /** @@ -106,7 +110,7 @@ interface UserSettingsDialogPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [UserSettingsDialog UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/UserSettingsDialog) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.8.0](https://github.com/UI5/webcomponents/releases/tag/v2.8.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/UserSettingsItem/index.tsx b/packages/main/src/webComponents/UserSettingsItem/index.tsx index 5c070b28a80..85bf77d85ae 100644 --- a/packages/main/src/webComponents/UserSettingsItem/index.tsx +++ b/packages/main/src/webComponents/UserSettingsItem/index.tsx @@ -72,6 +72,8 @@ interface UserSettingsItemPropTypes * Defines the tab views of the user settings item. * * The tab views are displayed by default if there is no selected page view. + * + * __Supported Node Type/s:__ `Array<UserSettingsView>` */ children?: ReactNode | ReactNode[]; @@ -86,6 +88,8 @@ interface UserSettingsItemPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<UserSettingsView>` */ pages?: UI5WCSlotsNode; /** @@ -110,7 +114,7 @@ interface UserSettingsItemPropTypes * * <b>Note:</b> Disabled and read-only states shouldn't be used together. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [UserSettingsItem UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/UserSettingsItem) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.8.0](https://github.com/UI5/webcomponents/releases/tag/v2.8.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/UserSettingsView/index.tsx b/packages/main/src/webComponents/UserSettingsView/index.tsx index b8eba9e949b..de78ff351fa 100644 --- a/packages/main/src/webComponents/UserSettingsView/index.tsx +++ b/packages/main/src/webComponents/UserSettingsView/index.tsx @@ -33,6 +33,8 @@ interface UserSettingsViewPropTypes Omit<CommonProps, keyof UserSettingsViewAttributes | 'children'> { /** * Defines the content of the view. + * + * __Supported Node Type/s:__ `Array<HTMLElement>` */ children?: ReactNode | ReactNode[]; } @@ -40,7 +42,7 @@ interface UserSettingsViewPropTypes /** * The `UserSettingsView` represents a view displayed in the `UserSettingsItem`. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [UserSettingsView UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/UserSettingsView) | [Repository](https://github.com/UI5/webcomponents) * * @since [2.8.0](https://github.com/UI5/webcomponents/releases/tag/v2.8.0) of __@ui5/webcomponents-fiori__. * @experimental diff --git a/packages/main/src/webComponents/ViewSettingsDialog/index.tsx b/packages/main/src/webComponents/ViewSettingsDialog/index.tsx index 3d033d10cb8..110ed689574 100644 --- a/packages/main/src/webComponents/ViewSettingsDialog/index.tsx +++ b/packages/main/src/webComponents/ViewSettingsDialog/index.tsx @@ -62,6 +62,8 @@ interface ViewSettingsDialogPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<FilterItem>` */ filterItems?: UI5WCSlotsNode; @@ -75,6 +77,8 @@ interface ViewSettingsDialogPropTypes * * __Note:__ When passing a custom React component to this prop, you have to make sure your component reads the `slot` prop and appends it to the most outer element of your component. * Learn more about it [here](https://ui5.github.io/webcomponents-react/v2/?path=/docs/knowledge-base-handling-slots--docs). + * + * __Supported Node Type/s:__ `Array<SortItem>` */ sortItems?: UI5WCSlotsNode; /** @@ -148,7 +152,7 @@ interface ViewSettingsDialogPropTypes * * * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [ViewSettingsDialog UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/ViewSettingsDialog) | [Repository](https://github.com/UI5/webcomponents) */ const ViewSettingsDialog = withWebComponent<ViewSettingsDialogPropTypes, ViewSettingsDialogDomRef>( 'ui5-view-settings-dialog', diff --git a/packages/main/src/webComponents/Wizard/index.tsx b/packages/main/src/webComponents/Wizard/index.tsx index d1aceba34f4..e04be669543 100644 --- a/packages/main/src/webComponents/Wizard/index.tsx +++ b/packages/main/src/webComponents/Wizard/index.tsx @@ -26,6 +26,8 @@ interface WizardPropTypes * Defines the steps. * * **Note:** Use the available `WizardStep` component. + * + * __Supported Node Type/s:__ `Array<WizardStep>` */ children?: ReactNode | ReactNode[]; /** @@ -113,7 +115,7 @@ interface WizardPropTypes * * (includes <ui5-wizard-step/>) * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [Wizard UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/Wizard) | [Repository](https://github.com/UI5/webcomponents) */ const Wizard = withWebComponent<WizardPropTypes, WizardDomRef>( 'ui5-wizard', diff --git a/packages/main/src/webComponents/WizardStep/index.tsx b/packages/main/src/webComponents/WizardStep/index.tsx index 144f4177a2e..5a4a842dba5 100644 --- a/packages/main/src/webComponents/WizardStep/index.tsx +++ b/packages/main/src/webComponents/WizardStep/index.tsx @@ -68,6 +68,8 @@ interface WizardStepDomRef extends Required<WizardStepAttributes>, Ui5DomRef {} interface WizardStepPropTypes extends WizardStepAttributes, Omit<CommonProps, keyof WizardStepAttributes | 'children'> { /** * Defines the step content. + * + * __Supported Node Type/s:__ `Array<Node>` */ children?: ReactNode | ReactNode[]; } @@ -87,7 +89,7 @@ interface WizardStepPropTypes extends WizardStepAttributes, Omit<CommonProps, ke * The `WizardStep` component should be used only as slot of the `Wizard` component * and should not be used standalone. * - * __Note__: This is a UI5 Web Component! [Repository](https://github.com/UI5/webcomponents) | [Documentation](https://ui5.github.io/webcomponents/) + * __Note:__ This is a UI5 Web Component! [WizardStep UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/WizardStep) | [Repository](https://github.com/UI5/webcomponents) * @abstract */ const WizardStep = withWebComponent<WizardStepPropTypes, WizardStepDomRef>(