# Hand-off status

> A hand-off between two suite products: source to target, its status as text and tone, and a link to the counterpart.

- Group: Feedback
- Status: stable
- Aliases: handoff, transfer-status
- HTML page: https://design.ipmnx.com/components/handoff-status/
- Spec: https://design.ipmnx.com/design/#nx-handoff-status

## Preview

**Deal to job** An ordNX deal became a checkNX job.

```html
<div class="nx-handoff nx-handoff--converted"
    data-status="converted">
  <span class="nx-handoff__route">
    <span class="nx-suite-product nx-suite-product--ord">
      <span class="nx-suite-product__mark"
          aria-hidden="true"></span>
      <bdi class="nx-suite-product__name">ordNX</bdi>
    </span>
    <svg xmlns="http://www.w3.org/2000/svg" width="14" height="14"
        viewBox="0 0 24 24" fill="none" stroke="currentColor"
        stroke-width="2" stroke-linecap="round"
        stroke-linejoin="round"
        class="lucide lucide-arrow-right nx-handoff__arrow"
        aria-hidden="true" focusable="false">
      <path d="M5 12h14"></path>
      <path d="m12 5 7 7-7 7"></path>
    </svg>
    <span class="nx-sr-only"> to </span>
    <span class="nx-suite-product nx-suite-product--check">
      <span class="nx-suite-product__mark"
          aria-hidden="true"></span>
      <bdi class="nx-suite-product__name">checkNX</bdi>
    </span>
  </span>
  <span class="nx-handoff__status">
    <span class="nx-handoff__icon" aria-hidden="true">
      <svg xmlns="http://www.w3.org/2000/svg" width="14" height="14"
          viewBox="0 0 24 24" fill="none" stroke="currentColor"
          stroke-width="2" stroke-linecap="round"
          stroke-linejoin="round" class="lucide lucide-circle-check"
          aria-hidden="true">
        <circle cx="12" cy="12" r="10"></circle>
        <path d="m9 12 2 2 4-4"></path>
      </svg>
    </span>
    <span class="nx-handoff__label">Job created</span>
  </span>
  <a class="nx-handoff__link" href="#handoff-status">Open job</a>
</div>
```

```tsx
<NxHandoffStatus
  from={{ product: "ord", name: "ordNX" }}
  to={{ product: "check", name: "checkNX" }}
  status="converted"
  statusLabel="Job created"
  directionLabel="to"
  link={{ href: "#handoff-status", label: "Open job" }}
/>
```

## API

### React props (NxKit)

| Prop | Type | Default | Required | Description |
| --- | --- | --- | --- | --- |
| `from` | `{ product: NxSuiteProduct; name: string }` |   | yes | Source product: key (drives the --nx-family-\* tint) and display name. |
| `to` | `{ product: NxSuiteProduct; name: string }` |   | yes | Target product. |
| `status` | `"in-transit" \| "arrived" \| "converted" \| "failed"` |   | yes | Drives icon and tone. |
| `statusLabel` | `string` |   | yes | Visible, translated status text. Status is never colour alone. |
| `directionLabel` | `string` | `undefined` |   | Screen-reader-only word between the products, e.g. "to"; the arrow is decorative. |
| `link` | `{ href: string; label: string }` | `undefined` |   | Link to the counterpart object in the other product. |
| `linkComponent` | `React.ElementType` | `"a"` |   | Framework/locale link for `link`. |
| `detail` | `ReactNode` | `undefined` |   | Detail line: a time, or why it failed. |
| `className` | `string` | `undefined` |   | Layout class. |

### Classes

| Class | Description |
| --- | --- |
| `.nx-handoff` | Row; modifier --in-transit/--arrived/--converted/--failed |
| `.nx-suite-product` | Product mark + name; --`<product>` sets the family tint |
| `.nx-handoff__arrow` | Lucide ArrowRight, aria-hidden, mirrored in RTL |
| `.nx-handoff__status` | Status chip: neutral, success or danger tint, icon + text |
| `.nx-handoff__link` | Counterpart link |

## States

### in-transit

```html
<div class="nx-handoff nx-handoff--in-transit" data-status="in-transit"><span class="nx-handoff__route"><span class="nx-suite-product nx-suite-product--ord"><span class="nx-suite-product__mark" aria-hidden="true"></span><bdi class="nx-suite-product__name">ordNX</bdi></span><svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right nx-handoff__arrow" aria-hidden="true" focusable="false"><path d="M5 12h14"></path><path d="m12 5 7 7-7 7"></path></svg><span class="nx-sr-only"> to </span><span class="nx-suite-product nx-suite-product--check"><span class="nx-suite-product__mark" aria-hidden="true"></span><bdi class="nx-suite-product__name">checkNX</bdi></span></span><span class="nx-handoff__status"><span class="nx-handoff__icon" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-clock" aria-hidden="true"><circle cx="12" cy="12" r="10"></circle><path d="M12 6v6l4 2"></path></svg></span><span class="nx-handoff__label">In transit</span></span></div>
```

### failed

```html
<div class="nx-handoff nx-handoff--failed" data-status="failed"><span class="nx-handoff__route"><span class="nx-suite-product nx-suite-product--ord"><span class="nx-suite-product__mark" aria-hidden="true"></span><bdi class="nx-suite-product__name">ordNX</bdi></span><svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right nx-handoff__arrow" aria-hidden="true" focusable="false"><path d="M5 12h14"></path><path d="m12 5 7 7-7 7"></path></svg><span class="nx-sr-only"> to </span><span class="nx-suite-product nx-suite-product--check"><span class="nx-suite-product__mark" aria-hidden="true"></span><bdi class="nx-suite-product__name">checkNX</bdi></span></span><span class="nx-handoff__status"><span class="nx-handoff__icon" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-circle-x" aria-hidden="true"><circle cx="12" cy="12" r="10"></circle><path d="m15 9-6 6"></path><path d="m9 9 6 6"></path></svg></span><span class="nx-handoff__label">Failed</span></span><span class="nx-handoff__detail">checkNX rejected the address</span></div>
```

## Accessibility

- The status is always visible text next to its icon; tone only repeats it (WCAG 1.4.1).
- The arrow is a Lucide icon with aria-hidden; pass directionLabel so a screen reader hears "ordNX to checkNX". Product names are isolated in bdi.

## Do / Don't

- Do: Link to the counterpart once it exists (job, request, file).
- Don't draw the arrow as a text glyph or show the status as a coloured dot alone.

## Related

- [Move notice](https://design.ipmnx.com/components/move-notice.md)
- [Badge](https://design.ipmnx.com/components/badge.md)

---

Source: registry.js (NX Design System)
