migrate-clickable-box

name: migrate-clickable-box description: Use when migrating ClickableBox or ClickableBox2 usages to ClickableBox3 in a given directory or file. Classifies usages, handles complex prop cases, and applies the migration safely.

Migrate ClickableBox / ClickableBox2 → ClickableBox3

See plans/clickablebox3.md for the full migration plan, directory checklist, and completion criteria.

What is ClickableBox3?

ClickableBox3 = ClickableBox2 + all Box2 layout props (direction optional). On desktop it renders a <div> with the Box2 CSS class system plus clickable-box2 cursor. On mobile it uses Pressable + box2SharedProps for layout.

Type: Box2Props & {onClick?, onLongPress?, hitSlop?} — direction is required.

Box2Props includes desktop mouse events: onMouseDown, onMouseUp, onMouseLeave, onMouseMove, onMouseOver, onMouseEnter, onContextMenu. CB3 passes all of these through to the desktop <div>. They are not forwarded on mobile (Pressable doesn't support them).

direction is always required. For Pattern B swaps (plain clickable wrapper, no layout needed), pass the direction that matches how children are stacked — usually "vertical" for a single child or vertically-stacked children.

Process

digraph migrate {
    "Identify target directory/file" [shape=box];
    "Grep for CB1/CB2 usages" [shape=box];
    "Read each file in full" [shape=box];
    "Classify each usage" [shape=box];
    "Present classified list + proposed changes" [shape=box];
    "User approves?" [shape=diamond];
    "Apply swaps" [shape=box];
    "yarn lint && yarn tsc" [shape=box];
    "Update plans/clickablebox3.md checklist" [shape=box];

    "Identify target directory/file" -> "Grep for CB1/CB2 usages";
    "Grep for CB1/CB2 usages" -> "Read each file in full";
    "Read each file in full" -> "Classify each usage";
    "Classify each usage" -> "Present classified list + proposed changes";
    "Present classified list + proposed changes" -> "User approves?";
    "User approves?" -> "Apply swaps" [label="yes"];
    "User approves?" -> "Present classified list + proposed changes" [label="revise"];
    "Apply swaps" -> "yarn lint && yarn tsc";
    "yarn lint && yarn tsc" -> "Update plans/clickablebox3.md checklist";
}

Step 1: Find Usages

From shared/:

grep -n "ClickableBox[^3]" <target-dir>/*.tsx

Read each matched file fully before classifying.

Step 2: Classify Each Usage

Pattern A — CB wraps an immediate Box2 (most common, biggest win)

<Kb.ClickableBox onClick={...}>
  <Kb.Box2 direction="horizontal" fullWidth alignItems="center" style={...}>
    ...
  </Kb.Box2>
</Kb.ClickableBox>

Action: Merge into one ClickableBox3. Move all Box2 props up, remove the Box2 wrapper.

<Kb.ClickableBox3 onClick={...} direction="horizontal" fullWidth alignItems="center" style={...}>
  ...
</Kb.ClickableBox3>

⚠️ fullWidth content-sizing gotcha (mobile): When the outer CB1 is content-sized (no explicit width, sitting alongside siblings in a justifyContent: center row), the inner Box2's fullWidth only stretched the Box2 to fill the CB1 — it did NOT make the CB1 itself full-width. Promoting fullWidth to CB3 changes this: CB3 gets width: '100%' on mobile, making it fill its entire parent and breaking the centered layout.

Diagnosis: Look at the CB's parent. If it's a horizontal container with justifyContent: center or centerChildren={true} that has OTHER siblings alongside this CB, the CB was content-sized. In that case, do NOT add fullWidth to CB3.

// ❌ Wrong — CB1 was content-sized, moving fullWidth to CB3 breaks centering
<Kb.ClickableBox3 direction="horizontal" fullWidth={true} gap="xsmall" onClick={...}>

// ✅ Correct — drop fullWidth since the old CB1 itself had no width
<Kb.ClickableBox3 direction="horizontal" gap="xsmall" onClick={...}>

Pattern B — CB with only click props, no style

<Kb.ClickableBox onClick={...}>
  <SomeOtherContent />
</Kb.ClickableBox>

Action: Swap to CB3. Always provide direction. Add fullWidth={true} if the original CB was filling its parent's width (e.g., list rows, banners, full-width wrappers).

<Kb.ClickableBox3 onClick={...} direction="vertical" fullWidth={true}>
  <SomeOtherContent />
</Kb.ClickableBox3>

⚠️ CB1 stretched by parent — CB3 doesn't (mobile): In RN, the default alignItems: stretch on a vertical flex parent made CB1 (TouchableOpacity/WithoutFeedback) fill the full width automatically. CB3 overrides this with alignSelf: center when neither fullWidth nor fullHeight is set. Any Pattern B or C conversion where the old CB1 filled its parent via the default stretch behavior now needs fullWidth={true} added explicitly. This is most common for rows in vertical lists, popup/menu headers, and full-width banner items.

⚠️ box2_centered / alignSelf: center gotcha: CB3 applies align-self: center (desktop: box2_centered CSS class; mobile: nativeStyles.centered = {alignSelf: 'center'}) whenever neither fullWidth nor fullHeight is set. CB1 did NOT do this. This affects both platforms. If the original CB was expected to fill its parent (e.g. list rows, banners, full-width wrappers), omitting fullWidth={true} will shrink it to content-width. Always check the parent layout context — when in doubt, add fullWidth={true}.

Pattern C — CB with style that encodes flex layout

<Kb.ClickableBox onClick={...} style={styles.row}>
// where row = { ...Kb.Styles.globalStyles.flexBoxRow, alignItems: 'center', ... }

Action: Move flex properties to CB3 props; keep non-flex properties in the style object.

<Kb.ClickableBox3 onClick={...} direction="horizontal" alignItems="center" style={styles.row}>
// row simplifies to: { height: ..., padding: ... }  — remove flexBoxRow, centered(), position:'relative'

See Style Cleanup section below.

Pattern D — CB with props not in CB3 (rare)

These CB1 props have no CB3 equivalent:

• hoverColor, underlayColor → add hover_background_color_* CSS className to CB3 instead
• feedback={false} → drop (Pressable doesn't have this)
• activeOpacity → drop
• onPressIn / onPressOut → not in CB3; leave as CB1 and note it
• tooltip → wrap with <Kb.WithTooltip> outside CB3
• onLongPress={(e) => ...} → remove the e param (CB3 signature is () => void)

Note: onMouseDown, onMouseUp, onMouseLeave, onMouseMove, onMouseOver, onMouseEnter are fully supported in CB3 via Box2Props — these are NOT Pattern D cases.

Step 3: Present Changes Before Touching Anything

For each usage show: file, line, pattern (A/B/C/D), proposed change. Flag any D cases and ask before acting. Wait for approval.

Step 4: Apply Swaps

1. Replace Kb.ClickableBox / Kb.ClickableBox2 → Kb.ClickableBox3
2. When merging an inner Box2 (Pattern A): move its props to CB3, delete the Box2 opening and closing tags
3. Simplify styles where flex props moved to CB3 props (Pattern C)
4. Remove now-unused imports if CB1/CB2 fully replaced in file

Step 5: Validate

From shared/:

yarn lint && yarn tsc

Both must pass with zero errors before reporting done. Fix any failures — including lint errors in files we touched or that were broken in a prior session. Do not skip lint or treat failures as pre-existing without verifying via git stash.

Step 6: Update Checklist

Mark the completed directory in plans/clickablebox3.md.

Style Cleanup (Pattern C)

When CB3 takes over flex layout via props, remove these from the style object passed to CB3:

Desktop (Electron) — safe to remove when CB3 handles them via props

Keep in the style object: fixed height, width values, padding, margin, borderRadius, backgroundColor, border*, and anything not covered by a CB3/Box2 prop.

Mobile (React Native)

flexBoxRow / flexBoxColumn on RN expand to only {flexDirection: 'row/column'} — no display:flex (RN doesn't use it). RN flex layout is unchanged between CB2 and CB3 when direction is provided.

CB3 on RN does NOT add borderRadius: 3 (CB1's old default). Remove it from styles only if it was purely inherited from CB1, not a design intent.

Note: direction is required in CB3

Always pass direction. For plain wrapper cases (Pattern B) with no layout need, use "vertical" as the default. Remember to add fullWidth={true} if the element should fill its parent.

What NOT to Do

• Don't swap cases where onPressIn/onPressOut is required — leave as CB1, note it
• Don't add hover CSS classes for colors not already in the design system — ask first
• Don't change surrounding logic, navigation, or state — component swap only
• Don't remove CB1/CB2 exports until the full migration is complete