pixelize-design-library 2.4.2-beta.50 → 2.4.2-beta.51
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/COMPONENT-GOTCHAS.md +46 -0
- package/DESIGN-GUIDE.md +4 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,10 @@ Versions follow semver. The `beta` dist-tag is released manually from the active
|
|
|
7
7
|
`^2.4.2-beta.43`) — a caret range on a prerelease is satisfied by the next stable publish, which
|
|
8
8
|
silently downgrades you.
|
|
9
9
|
|
|
10
|
+
Found a bug or a gap? Report it as a GitHub issue and track it to closure — see
|
|
11
|
+
[COMPONENT-GOTCHAS.md](COMPONENT-GOTCHAS.md#found-a-gap-or-a-bug-report-it-then-track-it). A fix's
|
|
12
|
+
line below names its issue number.
|
|
13
|
+
|
|
10
14
|
## [Unreleased] — 2.4.2-beta.x
|
|
11
15
|
|
|
12
16
|
The theme-tokens/dark-mode line. Still in beta; the breaking items below land together in the
|
package/COMPONENT-GOTCHAS.md
CHANGED
|
@@ -11,6 +11,52 @@ so it's available without checking out the library's source repo. Its companion
|
|
|
11
11
|
|
|
12
12
|
---
|
|
13
13
|
|
|
14
|
+
## Found a gap or a bug? Report it, then track it
|
|
15
|
+
|
|
16
|
+
The library exists so a UI change is made **once, here** — not patched per app. So when a component
|
|
17
|
+
is wrong, missing a prop, or can't express what a screen needs, **don't work around it in your app
|
|
18
|
+
and move on.** Report it upstream; a workaround nobody knows about is a bug that gets rediscovered
|
|
19
|
+
in every other app.
|
|
20
|
+
|
|
21
|
+
**What counts:** a component that renders wrong (misaligned, clipped, wrong size or colour, off the
|
|
22
|
+
control scale), a prop you need that doesn't exist, a silent-failure trap that isn't listed below, or
|
|
23
|
+
a doc that contradicts what you measured.
|
|
24
|
+
|
|
25
|
+
**How to report** — one GitHub issue on `pixelize-tech/Micro-Components`, with the label `bug` or
|
|
26
|
+
`enhancement`. From a terminal (AI agents included) this is one command:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
gh issue create --repo pixelize-tech/Micro-Components --label bug \
|
|
30
|
+
--title "[consumer] <Component>: <what is wrong>" \
|
|
31
|
+
--body "Version: <output of: npm ls pixelize-design-library>
|
|
32
|
+
App / screen: <where you saw it>
|
|
33
|
+
Expected: <what should happen>
|
|
34
|
+
Actual: <what happens, with measured numbers if it is visual>
|
|
35
|
+
Repro: <props / minimal snippet>
|
|
36
|
+
Workaround in the app: <none, or what you did and where, so it can be removed>"
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Measure, don't eyeball: for a visual bug give the rendered size and offset (`getBoundingClientRect`)
|
|
40
|
+
and the `size` prop — "icon 1.5px above centre at `sm`" gets fixed; "looks off" doesn't.
|
|
41
|
+
|
|
42
|
+
**How it is tracked** — the issue is the record; there is no second list.
|
|
43
|
+
|
|
44
|
+
| State | What it means | What you do |
|
|
45
|
+
| --- | --- | --- |
|
|
46
|
+
| Open | Reported, not yet fixed | Keep any workaround, and comment its file path on the issue |
|
|
47
|
+
| Closed with a version | Fixed in the named beta/release, and the fix is under `### Fixed` in [CHANGELOG.md](CHANGELOG.md) citing the issue | Bump the pin to that version (exact, never a caret on a prerelease), **delete the workaround**, close your own follow-up |
|
|
48
|
+
| Closed as `wontfix` / `invalid` / `duplicate` | Not changing, or already covered | Read the reason; the workaround stays, or use the issue it points to |
|
|
49
|
+
|
|
50
|
+
Before reporting, search first — `gh issue list --repo pixelize-tech/Micro-Components --search "<component>" --state all`
|
|
51
|
+
— and check the [CHANGELOG.md](CHANGELOG.md) shipped with your installed version; the gap may already
|
|
52
|
+
be fixed in a newer beta.
|
|
53
|
+
|
|
54
|
+
**Maintainers:** a fix closes its issue in the same change that lands it, and its CHANGELOG line
|
|
55
|
+
names the issue number and the version that ships it. A workaround someone left in an app is only
|
|
56
|
+
removable if the issue says which version fixes it, so never close without naming one.
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
14
60
|
## A colour rung flips direction between light and dark
|
|
15
61
|
|
|
16
62
|
`colors.primary[700]` is a deep purple in light mode and a **pale** lavender in dark. The scales are
|
package/DESIGN-GUIDE.md
CHANGED
|
@@ -192,6 +192,10 @@ hides its primary; when only one section is empty on a populated page, that sect
|
|
|
192
192
|
- Centered page titles, hero-sized headings, `size="lg"` buttons, or `size` props restating the default.
|
|
193
193
|
- More than one solid button in a view; a destructive action without `AlertDialog`.
|
|
194
194
|
- A page with only the data state.
|
|
195
|
+
- **Work around a library gap silently.** If a component is wrong or can't do what the screen
|
|
196
|
+
needs, report it (see "Found a gap or a bug?" in [COMPONENT-GOTCHAS.md](COMPONENT-GOTCHAS.md)) so
|
|
197
|
+
it is fixed once, here, and remove your workaround when the issue closes.
|
|
198
|
+
|
|
195
199
|
|
|
196
200
|
## 9. Reference pages
|
|
197
201
|
|
package/package.json
CHANGED