Skip to content

Commit bc38a2b

Browse files
committed
docs: add upgrade prompt for @open-elements/ui 0.5.x to 0.6.0
Signed-off-by: Hendrik Ebbers <hendrik.ebbers@open-elements.com>
1 parent 8f8f07b commit bc38a2b

2 files changed

Lines changed: 8 additions & 10 deletions

File tree

.github/workflows/ci.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,5 @@ jobs:
2525

2626
- run: pnpm run typecheck
2727
- run: pnpm run lint
28-
- run: pnpm run format:check
2928
- run: pnpm run test
3029
- run: pnpm run build

docs/upgrade-to-0.6.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ You are working inside an app that depends on `@open-elements/ui`. Goal: upgrade
1919

2020
Six new components are exported from `@open-elements/ui`. They use semantic tokens (`primary`, `destructive`, `muted-foreground`) so brand overrides keep working from `brand.css`.
2121

22-
| Export | Purpose |
23-
| --- | --- |
24-
| `ActionIconButton` | Tiny inline icon button with `default` \| `success` tones. Auto-`stopPropagation`, no chrome. Building block for the buttons below. |
25-
| `CopyToClipboardButton` | Composes `ActionIconButton` with a 2 s `Copy``Check` feedback animation. |
26-
| `MailtoButton` | Opens a `mailto:` URL via `ActionIconButton`. |
27-
| `ExternalLinkButton` | Opens a URL in a new tab with `noopener,noreferrer`. |
28-
| `TooltipIconButton` | Ghost icon `Button` wrapped in `Tooltip`, `default` \| `destructive` tones. Includes the disabled-button-needs-`<span>` Tooltip workaround and an `asChild` variant for navigation use cases. Also exports `TooltipIconButtonProps`. |
29-
| `TablePagination` | `Select` + per-page label + plural-aware total + prev/next (only when `totalPages > 1`). Owns the `localStorage` write for the page-size preference. Also exports `PaginationTranslations`. |
22+
| Export | Purpose |
23+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
24+
| `ActionIconButton` | Tiny inline icon button with `default` \| `success` tones. Auto-`stopPropagation`, no chrome. Building block for the buttons below. |
25+
| `CopyToClipboardButton` | Composes `ActionIconButton` with a 2 s `Copy``Check` feedback animation. |
26+
| `MailtoButton` | Opens a `mailto:` URL via `ActionIconButton`. |
27+
| `ExternalLinkButton` | Opens a URL in a new tab with `noopener,noreferrer`. |
28+
| `TooltipIconButton` | Ghost icon `Button` wrapped in `Tooltip`, `default` \| `destructive` tones. Includes the disabled-button-needs-`<span>` Tooltip workaround and an `asChild` variant for navigation use cases. Also exports `TooltipIconButtonProps`. |
29+
| `TablePagination` | `Select` + per-page label + plural-aware total + prev/next (only when `totalPages > 1`). Owns the `localStorage` write for the page-size preference. Also exports `PaginationTranslations`. |
3030

3131
There are **no** breaking changes, **no** removed exports, and **no** dependency manifest changes. If you only bump the version and run `pnpm install`, everything will still work.
3232

@@ -56,7 +56,6 @@ There are **no** breaking changes, **no** removed exports, and **no** dependency
5656
- **Local file imports from a relative path** (`./action-icon-button`, `../components/...`) → the import target is the candidate; rewrite to `@open-elements/ui`.
5757

5858
4. **For each candidate local component, verify behavioural parity** before deleting. Open the local file alongside the library version and confirm:
59-
6059
- Same props, same defaults (`tone = "default"`, etc.).
6160
- Same className strings / tone tokens.
6261
- Same side effects (e.g. `event.stopPropagation()`, `noopener,noreferrer`, `localStorage.setItem`).

0 commit comments

Comments
 (0)