edgevoid/vue-tui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(divergences): correct Ink behavior in display-reset and react-concurrent

Browse Source 
Verified against real Ink v7.0.4 (react 19.2) instead of source-reading:

- display-reset: Ink does not "persist" a withdrawn `display`. Its diff
  emits a removed key as `display: undefined`, and applyDisplayStyles
  sets DISPLAY_NONE for any non-`'flex'` value, so clearing a previously
  set `display` hides the box (verified: flex -> removed goes visible ->
  hidden). Describe the real behavior and the common-toggle consequence.
- react-concurrent: drop "Suspense" from the React-only list. Vue ships a
  built-in `<Suspense>`; the genuine gap is interruptible concurrent
  rendering / `useTransition`.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Yunfei He
2026-06-08 19:55:16 +08:00
parent d7e6898745
commit c75c6497d4
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.agents/docs/ink-divergences.md
+10 -5
View File
@@ -224,7 +224,8 @@ current-props model, or API conventions.
#### React concurrent mode #### React concurrent mode
- **Ink:** built on React; Suspense / `useTransition` are React features. - **Ink:** built on React; `useTransition` and interruptible concurrent rendering are
React features.
- **vue-tui:** no equivalent. - **vue-tui:** no equivalent.
- **Why:** this is a React-only concept with no Vue equivalent, so it is N/A rather than a - **Why:** this is a React-only concept with no Vue equivalent, so it is N/A rather than a
parity gap. parity gap.
@@ -245,10 +246,14 @@ current-props model, or API conventions.
#### Removing `display` resets to the default (visible) #### Removing `display` resets to the default (visible)
- **Ink:** `applyDisplayStyles` (`styles.ts`) sets `DISPLAY_NONE` whenever an explicit - **Ink:** `applyDisplayStyles` (`styles.ts`) calls `setDisplay(DISPLAY_NONE)` whenever the
`display` is present and not `'flex'`, so a present-but-undefined prop diff carries a `display` that is not `'flex'`, and Ink's reconciler diff emits a
`display={undefined}` **hides** the box, and an omitted `display` **persists** the prior withdrawn key as `display: undefined`. So clearing a previously-set `display` (`'none'` or
value. `'flex'` → removed) **hides** the box: Ink treats the withdrawn prop as `none`, neither
keeping the prior value nor restoring the default. (`display={undefined}` on a box that
never set `display` is a no-op and stays visible — the diff registers no change.) In the
common toggle `display={hidden ? 'none' : undefined}`, Ink stays hidden on the `undefined`
branch; you must set `display="flex"` to show it again.
- **vue-tui:** a removed/undefined `display` resets to the Box default `DISPLAY_FLEX` - **vue-tui:** a removed/undefined `display` resets to the Box default `DISPLAY_FLEX`
(visible): the same state as if the prop had never been set. (visible): the same state as if the prop had never been set.
- **Why:** render = f(current props): no `display` set means the default (visible). - **Why:** render = f(current props): no `display` set means the default (visible).