Commit 4c5935f
authored
docs: rework React theming — capture harness + tutorial example (#3133)
## Summary
Two sets of changes that together bring the React SDK's theming story up
to date with v14:
1. **Rework the Playwright screenshot pipeline** used for the React
theming doc (`docs-content:
chat-sdk/react/v14-latest/02-ui-components/02-theming/01-themingv2.md`).
2. **Sync `examples/tutorial`** so its per-step `layout.css` + `App.tsx`
match the revised tutorial published in getstream.io-tutorials.
Companion doc-content PR: **GetStream/docs-content#1213** — rewrites the
theming doc with working v14 tokens and regenerates every screenshot
using the harness in this PR.
### 1. Capture-harness rework (`examples/vite/docs-playwright/`)
**Pipeline reliability**
- Shared capture context across all screenshots (previously each page
spun up a fresh context, racing an empty channel list on themed
variants).
- Viewport bumped to 1280×1200 at 1× DPR (portrait framing fits more of
the conversation).
- `scrollToLatest()` before every screenshot so both users' latest
bubbles are in frame.
- `waitForChatUI()` now also waits for at least one rendered
`.str-chat__li` before the capture fires.
- Explicit channel create with both members + friendly name + truncate
so reruns don't accumulate duplicate seed messages.
- Headless by default. Set `HEADED=1` to override.
- Fixed `ASSETS_DIR` — previous path (`../../docs/...`) resolved to a
non-existent directory.
**Content**
- Extracted CSS override blocks to
`docs-playwright/theming-variants.mjs` so the harness and the doc stay
in lockstep.
- Rewrote the seed conversation: two-user dialogue, markdown
(`**bold**`, `*italic*`, `` `code` ``), GitHub URL preview, images,
richer reaction variety.
- Dropped obsolete capture flows (link-attachment text color,
layout-only CSS) — neither applies to v14.
**Deps**
- Added `@playwright/test@^1.59.1` as a devDep of `examples/vite`.
### 2. `examples/tutorial` sync
The per-step tutorial example was still using tokens that have **zero
consumers** in v14's built CSS (`--brand-50..900`, `--radius-full`) and
scoped the custom theme to `.str-chat__theme-custom`, which colonizes
the SDK's `str-chat__` namespace for a user-defined class.
- `layout.css` for steps 3–7 (byte-identical before this change):
replaced the dead overrides with the semantic-token block used in the
published tutorial.
- `App.tsx` for steps 3/4/5: renamed `theme='str-chat__theme-custom'` →
`theme='custom-theme'`.
### Test plan
**Capture harness:**
```bash
cd examples/vite
yarn install
yarn dev
# in another shell
node docs-playwright/seed-channel-and-screenshot.mjs # seed + capture
node docs-playwright/seed-channel-and-screenshot.mjs --skip-seed # just recapture
```
Output lands in
`../../../../docs/data/docs/chat-sdk/react/v14-latest/_assets/`. Use
`HEADED=1 node ...` to watch the browser.
**Tutorial example:**
```bash
cd examples/tutorial
yarn install
yarn dev
# visit each step and confirm the themed screens render with the new
# deep-blue palette (navy outgoing bubbles, light-blue incoming,
# pale-blue panel tint)
```1 parent eac76dc commit 4c5935f
File tree
18 files changed
+625
-389
lines changed- examples
- tutorial
- src
- 1-client-setup
- 2-core-component-setup
- 3-channel-list
- 4-custom-ui-components
- 5-custom-attachment-type
- 6-emoji-picker
- 7-livestream
- vite
- docs-playwright
18 files changed
+625
-389
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
1 | 2 | | |
2 | | - | |
3 | | - | |
4 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
| 2 | + | |
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
2 | 19 | | |
3 | | - | |
4 | | - | |
5 | | - | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | | - | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
| 42 | + | |
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
9 | | - | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
19 | 30 | | |
20 | 31 | | |
21 | 32 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
20 | | - | |
| 20 | + | |
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| |||
118 | 118 | | |
119 | 119 | | |
120 | 120 | | |
121 | | - | |
| 121 | + | |
122 | 122 | | |
123 | 123 | | |
124 | 124 | | |
| |||
151 | 151 | | |
152 | 152 | | |
153 | 153 | | |
154 | | - | |
| 154 | + | |
155 | 155 | | |
156 | 156 | | |
157 | 157 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
9 | | - | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
19 | 30 | | |
20 | 31 | | |
21 | 32 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
| 22 | + | |
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| |||
76 | 76 | | |
77 | 77 | | |
78 | 78 | | |
79 | | - | |
| 79 | + | |
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
| |||
118 | 118 | | |
119 | 119 | | |
120 | 120 | | |
121 | | - | |
| 121 | + | |
122 | 122 | | |
123 | 123 | | |
124 | 124 | | |
| |||
Lines changed: 25 additions & 14 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
9 | | - | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
19 | 30 | | |
20 | 31 | | |
21 | 32 | | |
| |||
0 commit comments