Getting started with EJ2 TypeScript Timeline control

7 May 20256 minutes to read

This section explains how to create a simple Timeline control and configure its available functionalities in TypeScript using the Essential® JS 2 quickstart seed repository.

This application is integrated with the webpack.config.js configuration and uses the latest version of the webpack-cli. It requires node v14.15.0 or higher. For more information about webpack and its features, refer to the webpack documentation.

Dependencies

The following dependencies are required to use the Timeline control in your application:

|-- @syncfusion/ej2-layouts
    |-- @syncfusion/ej2-base

Set up development environment

Open the command prompt from the required directory, and run the following command to clone the Syncfusion® JavaScript (Essential® JS 2) quickstart project from GitHub.

git clone https://github.com/SyncfusionExamples/ej2-quickstart-webpack- ej2-quickstart

After cloning the application in the ej2-quickstart folder, run the following command line to navigate to the ej2-quickstart folder.

cd ej2-quickstart

Add Syncfusion® JavaScript packages

Syncfusion® JavaScript (Essential® JS 2) packages are available on the npmjs.com public registry. You can install all Syncfusion® JavaScript (Essential® JS 2) controls in a single @syncfusion/ej2 package or individual packages for each control.

The quickstart application is preconfigured with the dependent @syncfusion/ej2 package in the ~/package.json file. Use the following command to install the dependent npm packages from the command prompt.

npm install

Import the Syncfusion® CSS styles

To render Timeline control, need to import layouts and its dependent control styles as given below in the ~/src/styles/styles.css file, as shown below:

@import "../../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../../node_modules/@syncfusion/ej2-layouts/styles/material.css";

Adding Timeline control to the application

Open the application in Visual Studio Code and add the Syncfusion® JavaScript UI controls.

Add the HTML div tag with the id attribute as timeline to your index.html file.

[src/index.html]

<!DOCTYPE html>
<html lang="en">

  <head>
    <title>Essential JS 2 - Timeline</title>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no" />
    <meta name="description" content="Essential JS 2" />
    <meta name="author" content="Syncfusion" />
    <link rel="shortcut icon" href="resources/favicon.ico" />
    <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" />
  </head>

  <body>
    <div class="control-container" style="height: 300px;">
      <div id="timeline"></div>
    </div>
  </body>
</html>

Import the Timeline control in your app.ts file, define the items using items property, and initialize it with #timeline.

[src/app/app.ts]

import { Timeline } from '@syncfusion/ej2-layouts';

let timeline: Timeline = new Timeline({
  items: [{}, {}, {}, {}],
});
timeline.appendTo("#timeline");

Run the application

Run the application in the browser by using the following command:

npm start

The following example demonstrates the usage of a basic Timeline control.

import { Timeline } from '@syncfusion/ej2-layouts';

// Initializes the Timeline control
let timeline: Timeline = new Timeline({
  items: [{}, {}, {}, {}]
});

// Render initialized Timeline.
timeline.appendTo("#timeline");
<!DOCTYPE html>
<html lang="en">

<head>
    <title>Essential JS 2 - Timeline</title>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no" />
    <meta name="description" content="Essential JS 2" />
    <meta name="author" content="Syncfusion" />
    <link href="https://cdn.syncfusion.com/ej2/31.2.2/ej2-base/styles/material.css" rel="stylesheet" />
    <link href="https://cdn.syncfusion.com/ej2/31.2.2/ej2-layouts/styles/material.css" rel="stylesheet" />

    <!--system js reference and configuration-->
    <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
    <script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>

<body>
    <div id='loader'>LOADING....</div>
    <div id='container' style="height: 300px;">
        <div id="timeline"></div>
    </div>
</body>
<style>
    #container {
        visibility: hidden;
        margin-top: 30px;
        padding: 30px;
    }

    #loader {
        color: #008cff;
        height: 40px;
        left: 45%;
        position: absolute;
        top: 45%;
        width: 30%;
    }
</style>

</html>