Timeline Item
<afp-timeline-item>
A timeline item component for displaying a single event within a timeline.
Your basic information has been saved.
Examples #
Shapes #
Use the shape attribute to define the shape of the timeline item.
Sizes #
Use the size attribute to change a timeline item's size.
Orientation #
Use the orientation attribute to specify the direction in which timeline items are displayed.
States #
Use the variant attribute to justify the state of the timeline item.
Use the inheritMarkerColor (inheritmarkercolor) attribute to display the connectors as the state defined.
Outlined #
Use the outlined attribute to display the timeline item markers outlined.
No Connector #
Use the noConnector (noconnector) attribute to display the timeline with no connector. This attribute is mainly used for the last timeline item.
Placement #
Use the placement attribute to align the timeline item content.
Disabled #
Use the disabled attribute to disable the timeline item.
Opposite Content #
Use the opposite-content slot to display the content on the opposite side of the timeline item.
Custom Marker #
Use the marker slot to display a customized marker in the timeline item.
Properties
Learn more about properties.
| Name | Description | Reflects | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
outlined
|
Outlined marker of the timeline item
Type
boolean
Default
false |
|
||||||||||||||||||||||||||
noConnector
noconnector
|
Avoid displaying the connector
Type
boolean
Default
false |
|
||||||||||||||||||||||||||
disabled
|
Disabled state of the timeline item
Type
boolean
Default
false |
|
||||||||||||||||||||||||||
tabIndex
tabindex
|
html tabIndex property of timeline item
Type
number
Default
0 |
|||||||||||||||||||||||||||
shape
|
Shape of the timeline item
Type
AfpShape
Default
AfpShape.PILL |
|
||||||||||||||||||||||||||
size
|
Size of the timeline item
Type
AfpSize
Default
AfpSize.MEDIUM |
|
||||||||||||||||||||||||||
orientation
|
Orientation of the timeline item
Type
AfpOrientation
Default
AfpOrientation.VERTICAL |
|
||||||||||||||||||||||||||
placement
|
Placement of the timeline item
For vertical orientation, allowed values are `left` and `right`.
For horizontal orientation, allowed values are `top` and `bottom`.
Type
AfpPlacement
|
|
||||||||||||||||||||||||||
variant
|
State of the timeline item.
Type
AfpVariant
|
|
||||||||||||||||||||||||||
inheritMarkerColor
inheritmarkercolor
|
The color of the timeline connector (line)
Type
boolean
Default
false |
|
Slots
Learn more about slots.
| Name | Description |
|---|---|
default
|
The default slot for the timeline item content.
|
opposite-content
|
The timeline item content on the opposite side.
|
marker
|
The marker of the timeline item.
|
marker-icon
|
The icon marker of the timeline item when a state is present.
|
Internationalization
Learn more about internationalization.
| Key | Description |
|---|---|
timeline-item.aria-label
|
The aria-label of the timeline item.
|
CSS Parts
Learn more about CSS Parts.
| Name | Description | Selector |
|---|---|---|
base
|
The timeline item's base wrapper.
|
::part(base)
|
content
|
The content of the timeline item.
|
::part(content)
|
opposite-content
|
The content of the timeline item on the opposite side.
|
::part(opposite-content)
|
separator
|
The container for the timeline item's marker and connector.
|
::part(separator)
|
marker
|
The marker of the timeline item.
|
::part(marker)
|
marker-icon
|
The icon marker of the timeline item.
|
::part(marker-icon)
|
connector
|
The connector (line) of the timeline item.
|
::part(connector)
|
CSS Custom Properties
| Name | Description | Default |
|---|---|---|
--afp-timeline-item-disabled-opacity
|
The opacity of the timeline item when disabled.
|
0.5
|
Dependencies
The component automatically brings in the listed items, including any nested dependencies that may exist.
| Component | CSS Part Prefix |
|---|---|
|
|
marker-icon
- The icon marker of the timeline item.
|
Importing
Using the bundle is the recommended method to include components. If you’d rather handle imports manually, you can use the code examples below.
import '@afp-design-system/core/dist/components/timeline-item/timeline-item.js';