Skip to main content

Timeline

A timeline step displays a single event or action of the timeline tracker.

Submit feedback
github
import { Timeline } from '@uhg-abyss/mobile';
        <Timeline
        currentStep={1}
        paragraph="Paragraph text in the active step card"
        >
        <Timeline.Step
        heading="Application Received and Processing"
        date={new Date(2024, 6, 17)}
        paragraph="Paragraph would go here"
        />
        <Timeline.Step
        heading="CMS Determination"
        date={new Date(2024, 6, 19)}
        paragraph="Paragraph would go here"
        />
        <Timeline.Step
        heading="Determination Outcome"
        />
        <Timeline.Step heading="UCard Shipped" />
        <Timeline.Step
        heading="Plan coverage begins"
        date={new Date(2025, 1, 1)}
        paragraph="Paragraph would go here"
        content={
        <Button size="small" variant="secondary">
        Button
        </Button>
        }
        />
        </Timeline>

        Timeline Props & Usage

        The currentStep prop is used to define the active timeline step. currentStep is required. To get the fully complete state for the timeline, currentStep should be set to be greater than the total number of steps. For example, if there are 3 steps, currentStep should be set to 4 to show the timeline as fully complete.

        variant is used to select the step variant, The options are default, warning, error, and info.

        Use the type prop to select what timeline type is most appropriate for you. The default type is combo.

        • combo displays the active step card with the steps contained in a card directly below.
        • card wraps the steps within a card. card does NOT contain the active step card.
        • progress displays only the timeline steps without any wrapper.

        headingWeight is used to modify the heading's fontWeight of every non-active step.

        Use content to add custom components inside of the active step card.

        Use button to add a button to the active step card.

        Timeline.Step Props & Usage

        Timeline.Step is used to display an individual step, each step has access to the props below providing the ability to manipulate the data displayed. Timeline.Step must be a direct child of Timeline.

        isDisabled will disable the step. When a step is disabled, it can still be accessed by Timeline via currentStep. A disabled step will not animate when active/complete.

        heading defines the step's Heading.

        date defines the date value displayed below heading, if a Date object is passed into date it will be formatted MM/DD/YYYY.

        Use paragraph to add a paragraph below date.

        content is used to add custom components to the bottom of the step.

        Timeline Props

        Prop NameTypeDefaultDescription
        buttonnode-Button lives inside the top card of type 'combo'. The button is placed at the bottom of the card below 'content'
        childrennode-Timeline steps
        contentnode-Content lives inside the top card of type 'combo'. The content is placed at the bottom of the card above 'button'
        currentStepnumber-The active timeline step
        footernode-content placed at the bottom of the timeline
        headingWeightstring | number$core.font-weight.regularDefines the heading weight of all inactive timeline steps
        paragraphstring-Custom description placed inside the active step card
        type'combo' | 'card' | 'progress'comboDefines the layout type of the timeline (combo, card, or progress)
        variant'default' | 'warning' | 'error' | 'info'defaultDefines the color palette of timeline

        Timeline.Step Props

        Prop NameTypeDefaultDescription
        contentnode-Customizable content that is displayed at the bottom of the step
        datestring | Date-The date displayed under title and above paragraph
        headingstring-The step heading, a heading is required for every step
        paragraphstring-Text displayed below step

        Timeline Classes

        Class NameDescription
        abyss-timeline-cardTimeline card root
        abyss-timeline-card-headingTimeline card heading
        abyss-timeline-combo-cardTimeline active step card root
        abyss-timeline-combo-card-button-wrapperTimeline active step card button wrapper
        abyss-timeline-combo-card-contentTimeline active step card content
        abyss-timeline-combo-card-headingTimeline active step card heading
        abyss-timeline-combo-card-paragraphTimeline active step card paragraph
        abyss-timeline-rootTimeline root element
        abyss-timeline-step-wrapperTimeline step wrapper

        Timeline.Step Classes

        Class NameDescription
        abyss-timeline-step-contentTimeline step content
        abyss-timeline-step-dashed-trackTimeline step dashed track
        abyss-timeline-step-date-statusTimeline step date status
        abyss-timeline-step-headingTimeline step heading
        abyss-timeline-step-paragraphTimeline step paragraph
        abyss-timeline-step-rootTimeline step root element
        abyss-timeline-step-solid-trackTimeline step solid track
        abyss-timeline-step-status-indicatorTimeline step status indicator

        Timeline Translations

        Translation KeyValue
        disabledDisabled
        Timeline.historyTimeline History
        Timeline.currentStepCurrent Step
        Timeline.stepStep
        Timeline.activeIn Progress
        Timeline.incompleteNot Completed
        Timeline.completeCompleted

        Timeline Tokens

        Token NameValue
        timeline.color.icon.complete
        #002677
        timeline.color.icon.active
        #FFFFFF
        timeline.color.surface.container
        #FFFFFF
        timeline.color.surface.track.default
        #002677
        timeline.color.surface.track.error
        #990000
        timeline.color.surface.track.warning
        #C24E14
        timeline.color.surface.track.info
        #196ECF
        timeline.color.surface.track.complete
        #002677
        timeline.color.surface.indicator.default
        #002677
        timeline.color.surface.indicator.error
        #990000
        timeline.color.surface.indicator.warning
        #C24E14
        timeline.color.surface.indicator.info
        #196ECF
        timeline.color.surface.indicator.complete
        #002677
        timeline.color.surface.indicator.active
        #002677
        timeline.color.text.heading
        #002677
        timeline.color.text.paragraph.default
        #002677
        timeline.color.text.paragraph.warning
        #C24E14
        timeline.color.text.paragraph.error
        #990000
        timeline.color.text.paragraph.info
        #196ECF
        timeline.color.text.paragraph.complete
        #323334
        timeline.color.text.paragraph.incomplete
        #323334
        timeline.color.text.status.default
        #002677
        timeline.color.text.status.warning
        #C24E14
        timeline.color.text.status.error
        #990000
        timeline.color.text.status.info
        #196ECF
        timeline.color.text.status.complete
        #323334
        timeline.color.text.status.incomplete
        #323334
        timeline.color.text.step-heading.default
        #002677
        timeline.color.text.step-heading.warning
        #C24E14
        timeline.color.text.step-heading.error
        #990000
        timeline.color.text.step-heading.info
        #196ECF
        timeline.color.text.step-heading.complete
        #323334
        timeline.color.text.step-heading.incomplete
        #323334
        timeline.color.border.container
        #CBCCCD
        timeline.color.border.heading
        #CBCCCD
        timeline.color.border.indicator
        #4B4D4F
        timeline.color.border.track
        #4B4D4F
        timeline.border-radius.all.container
        12
        timeline.border-radius.all.indicator
        500
        timeline.border-radius.all.track
        500
        timeline.border-width.all.container
        0.5
        timeline.border-width.all.indicator
        1
        timeline.border-width.all.track
        1
        timeline.border-width.bottom.heading
        0.5
        timeline.sizing.all.icon.complete
        24
        timeline.sizing.all.icon.active
        24
        timeline.sizing.all.indicator.width
        32
        timeline.sizing.all.indicator.height
        32
        timeline.spacing.padding.all.container
        16
        timeline.spacing.padding.all.complete-indicator
        8
        timeline.spacing.padding.top.heading
        24
        timeline.spacing.padding.bottom.heading
        16
        timeline.spacing.padding.bottom.step
        24
        timeline.spacing.padding.bottom.date-status
        4
        timeline.spacing.padding.right.container
        16
        timeline.spacing.gap.horizontal.heading
        16
        timeline.spacing.gap.horizontal.indicator
        8
        timeline.spacing.gap.horizontal.date-status
        4
        timeline.spacing.gap.vertical.track
        8
        timeline.spacing.gap.vertical.copy
        4
        timeline.spacing.gap.vertical.content
        12
        timeline.spacing.gap.vertical.container
        16
        timeline.box-shadow.container
        • Shadow Color: rgba(0,0,0,0.16)
        • Shadow Offset:
          • Width: 0
          • Height: 2
        • Shadow Opacity: 1
        • Shadow Radius: 4

        Timeline Classes

        V2V1Status
        timeline-cardtimeline-cardUnchanged
        -timeline-card-dividerRemoved
        timeline-card-headingtimeline-card-headingUnchanged
        timeline-combo-cardtimeline-combo-cardUnchanged
        timeline-combo-card-button-wrappertimeline-combo-card-button-wrapperUnchanged
        timeline-combo-card-contenttimeline-combo-card-contentUnchanged
        -timeline-combo-card-dateRemoved
        -timeline-combo-card-eyebrowRemoved
        timeline-combo-card-headingtimeline-combo-card-titleRenamed
        timeline-combo-card-paragraphtimeline-combo-card-descriptionRenamed
        -timeline-combo-card-text-wrapperRemoved
        timeline-roottimeline-rootUnchanged
        timeline-step-wrappertimeline-step-wrapperUnchanged

        Timeline.Step Classes

        V2V1Status
        -timeline-step-bottom-wrapperRemoved
        -timeline-step-bottom-wrapper-leftRemoved
        timeline-step-content-Added
        -timeline-step-content-wrapperRemoved
        timeline-step-dashed-track-Added
        -timeline-step-dateRemoved
        timeline-step-date-description-Added
        timeline-step-headingtimeline-step-titleRenamed
        -timeline-step-iconRemoved
        -timeline-step-icon-wrapperRemoved
        timeline-step-paragraphtimeline-step-descriptionRenamed
        -timeline-step-progress-bar-dashRemoved
        -timeline-step-progress-bar-wrapperRemoved
        timeline-step-root-Added
        timeline-step-solid-track-Added
        timeline-step-status-indicator-Added
        -timeline-step-top-wrapperRemoved
        -timeline-step-top-wrapper-leftRemoved

        Timeline Props

        V2V1Status
        buttonbuttonUnchanged
        childrenchildrenUnchanged
        contentcontentUnchanged
        currentStepcurrentStepUnchanged
        footerfooterUnchanged
        headingWeighttitleWeightRenamed
        paragraphdescriptionRenamed
        typetypeUnchanged
        variantvariantUnchanged

        Timeline.Step Props

        V2V1Status
        contentcontentUnchanged
        datedateUnchanged
        headingtitleRenamed
        -isDisabledRemoved
        paragraphdescriptionRenamed
        Table of Contents