From f2d0ee0bda4ffb642f4089cf28ce6b4a4deda8fe Mon Sep 17 00:00:00 2001 From: Adam Kudrna Date: Tue, 7 Nov 2023 13:19:54 +0100 Subject: [PATCH] fixup! Docs(web-react): Extend `Header` README to be as detailed as in the Twig implementation --- .../web-react/src/components/Header/README.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/packages/web-react/src/components/Header/README.md b/packages/web-react/src/components/Header/README.md index ba27c2d22d..a5c4c7252d 100644 --- a/packages/web-react/src/components/Header/README.md +++ b/packages/web-react/src/components/Header/README.md @@ -88,11 +88,11 @@ To create a responsive header with top-level navigation, there are the following building blocks to use: 1. Inside Header: -1. mobile-only actions, including toggle button by default, -1. desktop-only actions with primary and secondary action slots. -1. Inside Header Dialog: -1. primary actions slot (all breakpoints), -1. secondary actions slot (all breakpoints). + 1. mobile-only actions, including toggle button by default, + 2. desktop-only actions with primary and secondary action slots. +2. Inside Header Dialog: + 1. primary actions slot (all breakpoints), + 2. secondary actions slot (all breakpoints). ## Header @@ -152,12 +152,12 @@ control here. #### API -| Name | Type | Default | Required | Description | -| ------------------ | -------------------------- | --------- | -------- | ----------------- | -| `children` | `ReactNode` | — | ✕ | Children node | -| `color` | [`primary` \| `secondary`] | `primary` | ✕ | Color variant | -| `UNSAFE_className` | `string` | — | ✕ | Custom class name | -| `UNSAFE_style` | `CSSProperties` | — | ✕ | Custom style | +| Name | Type | Default | Required | Description | +| ------------------ | -------------------------- | --------- | -------- | --------------------------- | +| `children` | `ReactNode` | — | ✕ | Children node | +| `color` | [`primary` \| `secondary`] | `primary` | ✕ | Color and alignment variant | +| `UNSAFE_className` | `string` | — | ✕ | Custom class name | +| `UNSAFE_style` | `CSSProperties` | — | ✕ | Custom style | The component implements the [`HTMLElement`][mdn-api-html-element] interface. @@ -398,7 +398,7 @@ The component further inherits properties from the [`
  • `][mdn-li-element] elem | `UNSAFE_className` | `string` | — | ✕ | Custom class name | | `UNSAFE_style` | `CSSProperties` | — | ✕ | Custom style | -The component further inherits properties from the [`