mcpField
S
syncfusion-angular-timeline

syncfusion-angular-timeline

github.com/syncfusionDesign & UI0267 installsUpdated 1w ago
Repository

About syncfusion-angular-timeline

A reference skill for building chronological timelines with Syncfusion’s Angular Timeline component. It guides Angular developers through layouts, item content, styling, templates, and events for displays such as roadmaps and activity feeds.

Key features

  1. 01Vertical and horizontal layouts
  2. 02Four content alignment modes
  3. 03Reverse item order
  4. 04Customize dots and connectors
  5. 05Templates and render events

Use cases

  1. 01Show product milestones
  2. 02Visualize project phases
  3. 03Build reverse-chronological activity feeds
  4. 04Present career or education history

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/syncfusion/angular-ui-components-skills --skill syncfusion-angular-timeline

After installing, type/syncfusion-angular-timelinein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
alignment.md
api-reference.md
customization.md
events.md
getting-started.md
items-and-content.md
orientations-and-reverse.md
templates.md

Details

From the project README

Implementing Syncfusion Angular Timeline

The Timeline component displays a sequence of events or milestones in chronological order, supporting both vertical and horizontal layouts with rich customization options.

When to Use This Skill

  • Product Roadmaps: Display product evolution and release milestones
  • Project Timelines: Show project phases and deliverables
  • Activity Feeds: Display recent activities in reverse chronological order
  • Career/Education: Show career progression or educational achievements
  • Business Events: Visualize company history, important milestones, or processes
  • Trip Itineraries: Display scheduled activities and events
  • News Timelines: Show chronological news items or announcements

Component Overview

The Timeline component provides:

  • Flexible orientation (vertical/horizontal)
  • Multiple content alignments (Before, After, Alternate, AlternateReverse)
  • Dual-sided content with oppositeContent
  • Event handlers for lifecycle and rendering
  • Extensive dot and connector customization
  • Template support for complete layout control
  • Item-level customization (disabled, styling, content)

Documentation and Navigation Guide

Getting Started

📄 Read: references/getting-started.md

  • Installation and package setup
  • Creating a basic Timeline
  • Angular 21 standalone architecture setup
  • Importing TimelineModule and TimelineAllModule
  • First working example with items
Items and Content

📄 Read: references/items-and-content.md

  • String content and opposite content configuration
  • Template-based content rendering
  • CSS classes for item styling
  • Disabled state and dot-item property
  • Data binding from arrays
  • Content property usage
Alignment

📄 Read: references/alignment.md

  • Content positioning with align property
  • Before alignment (horizontal & vertical behavior)
  • After alignment
  • Alternate alignment (zigzag pattern)
  • AlternateReverse alignment
  • Combining alignment with orientation
Orientations and Reverse

📄 Read: references/orientations-and-reverse.md

  • Vertical orientation (default, top-to-bottom)
  • Horizontal orientation (left-to-right)
  • Reverse property for reversed sequence
  • Recent-first timelines
  • Reverse with different alignments
  • Use cases for activity feeds and news
Customization

📄 Read: references/customization.md

  • Connector styling (common and individual item connectors)
  • Dot appearance: size, color, outline, shadow, variant
  • Dot icons with dotCss property (Material Icons, FontAwesome)
  • Item spacing and borders
  • CSS class-based customization
  • Per-item vs global connector styling
  • Advanced visual styling examples
Events

📄 Read: references/events.md

  • Created event (component initialization)
  • BeforeItemRender event (pre-render customization)
  • Event handler setup and binding
  • Dynamic item modification via events
  • Conditional styling during render
  • Event arguments and properties
Templates

📄 Read: references/templates.md

  • Template property for complete customization
  • Template context (item, itemIndex)
  • Custom dot indicator design
  • Content area layout restructuring
  • Custom connectors via templates
  • Advanced layout examples
API Reference

📄 Read: references/api-reference.md

  • Complete property documentation with examples
  • All component properties explained (including advanced: enablePersistence, enableRtl, locale)
  • All item properties documented
  • Event binding and handling
  • Enumeration values (TimelineAlign, TimelineOrientation)
  • Working code examples for every property and event

Quick Start Example

import { Component } from '@angular/core';
import { TimelineItemModel, TimelineModule, TimelineAllModule } from "@syncfusion/ej2-angular-layouts";
import { CommonModule } from '@angular/common';

@Component({
  imports: [CommonModule, TimelineModule, TimelineAllModule],
  standalone: true,
  selector: 'app-root',
  template: `
    <div class="container">
      <ejs-timeline orientation="Vertical" align="Before">
        <e-items>
          <e-item *ngFor="let item of milestones" [content]="item.content" [oppositeContent]="item.oppositeContent"></e-item>
        </e-items>
      </ejs-timeline>
    </div>
  `,
  styles: [`.container { padding: 20px; }`]
})
export class AppComponent {
  public milestones: TimelineItemModel[] = [
    { content: 'Q1 2024', oppositeContent: 'Planning phase' },
    { content: 'Q2 2024', oppositeContent: 'Development' },
    { content: 'Q3 2024', oppositeContent: 'Testing' },
    { content: 'Q4 2024', oppositeContent: 'Launch' }
  ];
}

Common Patterns

Pattern 1: Activity Feed (Reverse Chronological)
<ejs-timeline [reverse]="true" align="Before">
  <e-items>
    <e-item *ngFor="let activity of recentActivities" [content]="activity.time" [oppositeContent]="activity.description"></e-item>
  </e-items>
</ejs-timeline>

When to use: Display latest activities first, news feeds, log entries.

Pattern 2: Alternate Timeline (Balanced Layout)
<ejs-timeline align="Alternate" orientation="Horizontal">
  <e-items>
    <e-item *ngFor="let event of events" [content]="event.title" [oppositeContent]="event.description"></e-item>
  </e-items>
</ejs-timeline>

When to use: Visual balance, alternating left/right content, company history.

Pattern 3: Custom Styled Timeline
<ejs-timeline align="Before" [cssClass]="'custom-timeline'">
  <e-items>
    <e-item *ngFor="let item of items" [content]="item.content" [cssClass]="item.cssClass" [disabled]="item.disabled"></e-item>
  </e-items>
</ejs-timeline>

When to use: Branded styling, visual differentiation of item states, custom themes.

Key Properties

PropertyTypeDefaultPurpose
Layout & Display
orientationVertical | HorizontalVerticalTimeline layout direction
alignBefore | After | Alternate | AlternateReverseAfterContent alignment
reversebooleanfalseReverse item order (newest first)
itemsTimelineItemModel[][]Timeline items array
Item Content
contentstring | object-Main item text/content
oppositeContentstring | object-Opposite-side content
dotCssstring-CSS class for dot icons
cssClassstring-CSS class for item styling
disabledbooleanfalseDisable individual item
Customization
templatestring | object-Custom item template
cssClass (component)string-Component CSS class
Advanced
enablePersistencebooleanfalsePersist state to localStorage
enableRtlbooleanfalseRight-to-left layout support
localestringen-USLocalization settings
Events
createdEvent-Triggered after component renders
beforeItemRenderEvent-Triggered before item renders

See references/api-reference.md for complete details, examples, and advanced configurations.

Common Use Cases

  1. Product Roadmap: Horizontal timeline with milestones and features
  2. Project Status: Alternate timeline showing phases and progress
  3. Career Timeline: Vertical timeline with job positions and dates
  4. Company History: Reverse timeline showing company evolution
  5. Trip Itinerary: Vertical timeline with location and activity information
  6. User Activity Log: Reverse timeline with timestamps and actions
  7. News Feed: Horizontal reverse timeline with headlines
  8. Educational Path: Vertical alternate timeline showing degrees and courses

Comments

Markdown supported