Skip to content

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.

View as Markdown

Preview

Deal to job An ordNX deal became a checkNX job.

ordNX to checkNXJob createdOpen job
<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>

API

React props (NxKit)

React (NxKit) props
PropTypeDefaultRequiredDescription
from{ product: NxSuiteProduct; name: string }RequiredSource product: key (drives the --nx-family-* tint) and display name.
to{ product: NxSuiteProduct; name: string }RequiredTarget product.
status"in-transit" | "arrived" | "converted" | "failed"RequiredDrives icon and tone.
statusLabelstringRequiredVisible, translated status text. Status is never colour alone.
directionLabelstringundefinedScreen-reader-only word between the products, e.g. "to"; the arrow is decorative.
link{ href: string; label: string }undefinedLink to the counterpart object in the other product.
linkComponentReact.ElementType"a"Framework/locale link for `link`.
detailReactNodeundefinedDetail line: a time, or why it failed.
classNamestringundefinedLayout class.

Classes

Framework-agnostic classes
ClassDescription
.nx-handoffRow; modifier --in-transit/--arrived/--converted/--failed
.nx-suite-productProduct mark + name; --<product> sets the family tint
.nx-handoff__arrowLucide ArrowRight, aria-hidden, mirrored in RTL
.nx-handoff__statusStatus chip: neutral, success or danger tint, icon + text
.nx-handoff__linkCounterpart link

States

in-transit

ordNX to checkNXIn transit

failed

ordNX to checkNXFailedcheckNX rejected the address

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.

View in spec