You are currently on Anvil1, which is now in maintenance mode. Visit Anvil2 to get the latest version of the design system.
components / Structure

Flow Card

Unordered

Some flows allow the user to fill out sections independently from one another. Other flows allow sections to be optional. Unordered Flow Cards allow for both of these scenarios.


Ordered

Commonly Flow Cards are used so that a user fills out each step sequentially.


States

Default

Editing

Saved

Error

Disabled


Examples

Basic

Custom Order

Custom Header Icon

Custom Title

Custom Edit Area

When an edit state has significant amount of content, a Modal or Takeover can be used, and opening a new page should be considered.


Best Practices

  • Steps in a default state should show a description of the information the step is requesting
  • Saved steps should show a summary of the data that has been submitted
  • When one step is in an edit state, all other steps should be disabled.
  • Use a small Button for the header action
  • Avoid having large content. Break up flows into smaller steps or use a Custom Content method.

  • For ordered flows with large content on every step, consider using Takeover with Progress Tracker instead of Flow Card.

Importing

import { FlowCard, FlowCardStep } from '@servicetitan/design-system';