DevactionUI.Timeline (devaction_ui v0.2.3)

Copy Markdown View Source

Things that happened, in order, on a thin line: each item has a dot in a tone, a title, its time on the line below and optional text. The colour of the dot is decoration; give an item a tone_label ("Failed") so assistive technology reads what the colour says, and a datetime to make its time a machine-readable <time>.

Summary

Functions

The list of events on a line.

Functions

timeline(assigns)

@spec timeline(map()) :: Phoenix.LiveView.Rendered.t()

The list of events on a line.

Attributes

  • class (:any) - Defaults to nil.
  • Global attributes are accepted.

Slots

  • item (required) - Accepts attributes:
    • tone (:atom) - risk, warn, ok, info or neutral (the default, a muted dot).
    • title (:string) (required)
    • time (:string) - when it happened, as the person reads it.
    • datetime (:string) - the same moment as an ISO 8601 value, for the <time> element.
    • tone_label (:string) - what the tone of the dot means, read out before the title.