Skip to content

Commit 4dd2dc3

Browse files
docs(hint): align README with project conventions
1 parent 67cc0da commit 4dd2dc3

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

elements/pf-hint/README.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Add a title to your hint to provide more context to the user.
6565
```html
6666
<pf-hint>
6767
<pf-dropdown slot="actions">
68-
<pf-button slot="trigger" plain aria-label="Actions">
68+
<pf-button slot="toggle" plain aria-label="Actions">
6969
<pf-icon icon="ellipsis-v"></pf-icon>
7070
</pf-button>
7171
<pf-dropdown-menu>
@@ -84,31 +84,29 @@ Add a title to your hint to provide more context to the user.
8484

8585
## Slots
8686

87-
| Slot | Description |
88-
| --------- | -------------------------------------------------------------------------- |
89-
| (default) | Body content of the hint |
90-
| `title` | Optional title for the hint |
91-
| `footer` | Optional footer content, typically containing action links or buttons |
92-
| `actions` | Optional actions menu (e.g., kebab dropdown menu in the top-right corner) |
87+
- `(default)` – Body content of the hint.
88+
- `title` – Optional title that appears above the body copy.
89+
- `footer` – Optional footer content, typically links or buttons.
90+
- `actions` – Optional actions menu (for example, a kebab dropdown in the top-right corner).
9391

9492
## CSS Custom Properties
9593

96-
| Property | Description | Default |
97-
| --------------------------------- | ------------------------------------ | ---------------------------------------------- |
98-
| `--pf-c-hint--BackgroundColor` | Background color of the hint | `var(--pf-global--BackgroundColor--light-300)` |
99-
| `--pf-c-hint--BorderRadius` | Border radius of the hint container | `var(--pf-global--BorderRadius--sm)` |
100-
| `--pf-c-hint--Padding` | Padding around the hint content | `var(--pf-global--spacer--md)` |
101-
| `--pf-c-hint__title--FontSize` | Font size of the title | `var(--pf-global--FontSize--md)` |
102-
| `--pf-c-hint__title--FontWeight` | Font weight of the title | `var(--pf-global--FontWeight--semi-bold)` |
103-
| `--pf-c-hint__body--FontSize` | Font size of the body text | `var(--pf-global--FontSize--sm)` |
104-
| `--pf-c-hint__body--Color` | Color of the body text | `var(--pf-global--Color--100)` |
94+
- `--pf-c-hint--BackgroundColor` – Background color (`var(--pf-global--palette--blue-50, #e7f1fa)`).
95+
- `--pf-c-hint--BorderColor` – Border color (`var(--pf-global--palette--blue-100, #bee1f4)`).
96+
- `--pf-c-hint--BorderWidth` – Border width (`1px`).
97+
- `--pf-c-hint--BorderRadius` – Border radius (`var(--pf-global--BorderRadius--sm, 3px)`).
98+
- `--pf-c-hint--PaddingTop/Right/Bottom/Left` – Padding around the container (`var(--pf-global--spacer--lg, 1.5rem)`).
99+
- `--pf-c-hint__title--FontSize` – Title font size (`1.125rem`).
100+
- `--pf-c-hint__title--FontWeight` – Title font weight (`var(--pf-global--FontWeight--semi-bold, 700)`).
101+
- `--pf-c-hint__body--FontSize` – Body font size (`1rem`).
102+
- `--pf-c-hint__body--Color` – Body text color (`var(--pf-global--Color--100, #151515)`).
103+
- `--pf-c-hint__footer--child--MarginRight` – Spacing between footer children (`1rem`).
104+
- `--pf-c-hint__actions--c-dropdown--MarginTop` – Offset for dropdown actions (`calc(0.375rem * -1)`).
105105

106106
## CSS Parts
107107

108-
| Part | Description |
109-
| ----------- | ------------------------ |
110-
| `container` | The hint container |
111-
| `title` | The title element |
112-
| `body` | The body element |
113-
| `footer` | The footer element |
114-
| `actions` | The actions element |
108+
- `container`
109+
- `title`
110+
- `body`
111+
- `footer`
112+
- `actions`

0 commit comments

Comments
 (0)