Skip to content

Design system

Documentation

DesignPatterns / CRUD

Patterns / CRUD

Beta

CRUD

A CRUD pattern keeps list, create, edit, and delete actions legible as one loop, with confirmation and feedback at the point of change.

On this page

Examples

Create, edit, and confirm delete

Keep record identity visible through each local change and confirm destructive actions in a shared Dialog.

Projects

Manage local example records. No service request is made.

  • Atlas onboarding

    Mai Nguyen

    Active
  • Orbit billing

    Phuc Tran

    Draft

Project records with create, edit, and confirmed delete actions

When to use

Use CRUD when a person can create or change records and needs to return to a list to compare the result. Start with local or fixture data while the interaction contract is being designed; do not add a service request just to make the documentation look complete.

The loop

  1. List. Show the identifying fields, status, owner, and last update needed to decide what to open.
  2. Create or edit. Use a focused form with a title that names the action and preserve the list context behind it.
  3. Confirm. Before an irreversible action, name the exact record and explain that the action cannot be undone.
  4. Report. Announce the result near the list and keep the updated record visible when possible.

The runnable Preview and Code/Copy tabs use src/components/design/examples/source/crud-pattern.tsx. The example edits local fixture data only and has no pattern-level property playground.

Destructive actions

Delete is not a menu decoration. Use a shared Dialog, put Cancel first, and disable or close the dialog only after the operation has completed. For bulk deletion, include the count and the scope in the confirmation copy.

Confirm

“Delete Lumen research?” names the exact record and says the action cannot be undone.

Do not surprise

Never delete on row click, on menu open, or through an unlabelled icon with no confirmation step.

Accessibility

  • Give each row a stable accessible name and make icon-only edit/delete controls name the record they affect.
  • Use a real heading in the edit and delete dialogs, and return focus to the triggering action when the dialog closes.
  • Announce create, update, and delete results with a status message that remains readable after the list re-renders.
  • Keep the list usable at narrow widths; allow content to wrap or scroll rather than clipping actions.

Do and don’t

Do

Keep the record identity in the edit title, preserve the list context, and make the next action explicit.

Don’t

Put a full multi-step workflow in a small Dialog or use color as the only record status.

  • Dialog provides focus management and the confirmation surface.
  • Badge labels status with readable text, not color alone.
  • IconButton supports compact row actions with required accessible names.