Skip to content

CI-3097 DOC Proposal #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: CI-3097
Choose a base branch
from
Draft

CI-3097 DOC Proposal #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -766,29 +766,38 @@ interface CustomCodeComponent extends Node {
### Timeline

```ts
/**
* Allowed layout widths for a Timeline.
* @typedef {'full-width' | 'inset-left' | 'full-grid'} TimelineLayoutWidth
*/
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "inset-left" | "full-grid">

/**
* Timeline nodes display a timeline of events in arbitrary order.
*
* @typedef Timeline
* @property {TimelineLayoutWidth} layoutWidth - How the component should be presented.
**/
interface Timeline extends Parent {
type: "timeline"
layoutWidth: TimelineLayoutWidth
children: [Heading, ...TimelineEvent[]]
}
```

**Timeline** nodes display a timeline of events in arbitrary order.

### TimelineEvent

```ts
/**
* TimelineEvent is the representation of a single event
*
* @typedef TimelineEvent
* @property {string} title - The title of the event
* @property {(Paragraph | ImageSet)[]} children - Elements that describe the event
**/
interface TimelineEvent extends Parent {
type: "timeline-event"
title: string
children: (Paragraph | ImageSet)[]
}
```

**TimelineEvent** nodes represents a single event in a timeline.

## License

This software is published by the Financial Times under the [MIT licence](mit).
Expand Down