Skip to content

Commit e4a224a

Browse files
committed
feat: add timeline and event components
1 parent ff3ec16 commit e4a224a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -766,28 +766,28 @@ interface CustomCodeComponent extends Node {
766766
### Timeline
767767

768768
```ts
769-
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "inset-left">
769+
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "inset-left" | "full-grid">
770770

771771
interface Timeline extends Parent {
772772
type: "timeline"
773773
layoutWidth: TimelineLayoutWidth
774-
children: [Heading, ...Event[]]
774+
children: [Heading, ...TimelineEvent[]]
775775
}
776776
```
777777

778-
**Timeline** nodes display events in arbitrary order.
778+
**Timeline** nodes display a timeline of events in arbitrary order.
779779

780-
### Event
780+
### TimelineEvent
781781

782782
```ts
783-
interface Event extends Parent {
784-
type: "event"
783+
interface TimelineEvent extends Parent {
784+
type: "timeline-event"
785785
dateLabel: string
786786
children: Paragraph[]
787787
}
788788
```
789789

790-
**Event** nodes represents an event. They can be used in timelines.
790+
**TimelineEvent** nodes represents a single event in a timeline.
791791

792792
## License
793793

0 commit comments

Comments
 (0)