Compliance Checklist

A generic pass/fail/warn/na readiness checklist card, modelled on Digital Waste Tracking compliance.

$bunx shadcn@latest add @nx-ui/compliance-checklist
Registry item
Installs withtooltiputils

Ready

Every required check passes; a not-applicable check is muted. The banner turns green when nothing required is missing.

DWT compliance

10/10 passed
  • Waste classification (EWC)
  • Producer identified
  • Licensed carrier
  • Permitted destination
  • Quantity recorded
  • Origin & destination
  • Movement date
  • Chain of custody
  • Hazardous consignment note
  • Source document on file
  • Reviewed & approved
DWT-ready — all required fields captured

Required fields missing

Failing checks flag red and drive the count in the banner; hover a status icon for the detail.

DWT compliance

5/10 passed
  • Waste classification (EWC)
  • Producer identified
  • Licensed carrier
  • Permitted destination
  • Quantity recorded
  • Origin & destination
  • Movement date
  • Chain of custody
  • Source document on file
  • Reviewed & approved
3 required fields missing for DWT

Warnings only

No hard failures, but optional checks are pending — the banner reflects the softer state.

DWT compliance

5/6 passed
  • Waste classification (EWC)
  • Producer identified
  • Licensed carrier
  • Quantity recorded
  • Chain of custody
  • Reviewed & approved
Some optional checks pending

API reference

Exported parts and their props, extracted from the component source.

PropTypeDefaultDescription
titlestring"Compliance"
checks*ComplianceCheck[]
readyLabelstring"DWT-ready — all required fields captured"Copy for the summary banner. Sensible defaults model Digital Waste Tracking readiness; override for other domains.
notReadyLabel(failing: number) => string(failing) => `${failing} required ${failing === 1 ? "field" : "fields"} missing`Called with the count of failing required checks to build the "not ready" copy.
classNamestring