diff --git a/packages/web-react/src/components/Accordion/README.md b/packages/web-react/src/components/Accordion/README.md index c3ab428abc..039b7fe551 100644 --- a/packages/web-react/src/components/Accordion/README.md +++ b/packages/web-react/src/components/Accordion/README.md @@ -175,6 +175,7 @@ import { AccordionOpenStateType } from '@lmc-eu/spirit-web-react/types'; | Name | Type | Default | Required | Description | | ------------------ | --------------- | ------- | -------- | ------------------------ | | `children` | `ReactNode` | — | ✔ | Header children node | +| `elementType` | `ElementType` | `h3` | ✕ | Type of element | | `slot` | `ReactNode` | — | ✕ | Side slot in the header | | `UNSAFE_className` | `string` | — | ✕ | Header custom class name | | `UNSAFE_style` | `CSSProperties` | — | ✕ | Header custom style | diff --git a/packages/web-react/src/components/Breadcrumbs/README.md b/packages/web-react/src/components/Breadcrumbs/README.md index 3e5884837f..a6b6ea5079 100644 --- a/packages/web-react/src/components/Breadcrumbs/README.md +++ b/packages/web-react/src/components/Breadcrumbs/README.md @@ -56,6 +56,7 @@ Use custom content for ordered list as component's children instead of passing b | Name | Type | Default | Required | Description | | ------------------ | ------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `children` | `ReactNode` | — | ✕ | Custom content to override items rendering from array | +| `elementType` | `ElementType` | `nav` | ✕ | Type of element used as wrapper | | `goBackTitle` | `string` | — | ✔ | Title/translation for back link to previous page on mobile. It's essential to be set along with items. If items property is not passed, backlink is to be created within children property. | | `items` | `BreadcrumbsItem[]` | — | ✕ | Navigation menu items | | `UNSAFE_className` | `string` | — | ✕ | Wrapper custom class name | diff --git a/packages/web-react/src/components/Collapse/README.md b/packages/web-react/src/components/Collapse/README.md index 203c11b60d..fad6806b9b 100644 --- a/packages/web-react/src/components/Collapse/README.md +++ b/packages/web-react/src/components/Collapse/README.md @@ -125,15 +125,16 @@ import { Button, UncontrolledCollapse } from '@lmc-eu/spirit-web-react/component ## API -| Name | Type | Default | Required | Description | -| ------------------------- | -------------------------------------------- | ---------- | -------- | -------------------------------------- | -| `collapsibleToBreakpoint` | [`mobile` \| `tablet` \| `desktop`] | — | ✕ | Handle for responsive breakpoint | -| `id` | `string` | `` | ✕ | Component id | -| `isOpen` | `bool` | — | ✕ | Is open on initialization | -| `hideOnCollapse` | `bool` | — | ✕ | Hides button when content is displayed | -| `renderTrigger` | `(render: CollapseRenderProps) => ReactNode` | — | ✕ | Properties for trigger render | -| `UNSAFE_className` | `string` | — | ✕ | Wrapper custom classname | -| `UNSAFE_style` | `CSSProperties` | — | ✕ | Wrapper custom style | +| Name | Type | Default | Required | Description | +| ------------------------- | -------------------------------------------- | ---------- | -------- | ------------------------------------------- | +| `collapsibleToBreakpoint` | [`mobile` \| `tablet` \| `desktop`] | — | ✕ | Handle for responsive breakpoint | +| `elementType` | [`span` \| `div`] | `div` | ✕ | Type of element used as wrapper and content | +| `id` | `string` | `` | ✕ | Component id | +| `isOpen` | `bool` | — | ✕ | Is open on initialization | +| `hideOnCollapse` | `bool` | — | ✕ | Hides button when content is displayed | +| `renderTrigger` | `(render: CollapseRenderProps) => ReactNode` | — | ✕ | Properties for trigger render | +| `UNSAFE_className` | `string` | — | ✕ | Wrapper custom classname | +| `UNSAFE_style` | `CSSProperties` | — | ✕ | Wrapper custom style | ## Render Toggle API diff --git a/packages/web-react/src/types/breadcrumbs.ts b/packages/web-react/src/types/breadcrumbs.ts index cf9ad2b1e7..5a512d1267 100644 --- a/packages/web-react/src/types/breadcrumbs.ts +++ b/packages/web-react/src/types/breadcrumbs.ts @@ -8,7 +8,7 @@ export type BreadcrumbsItem = { export interface AriaBreadcrumbsElementTypeProps { /** - * The HTML element or React element used to render the alert, e.g. 'div', 'span'. + * The HTML element or React element used to render the breadcrumbs, e.g. 'div', 'span'. * * @default 'nav' */