smart-html-elements

Timeline - Documentation | www.HtmlElements.com

Overview

Smart.Timeline element represents single row editable text box, supported two different display modes.

Getting Started

JavaScript (ES6) & TypeScript
Angular
React
Vue

;

Getting Started with Timeline Web Component

Smart UI for Web Components is distributed as smart-webcomponents NPM package. You can also get the full download from our website with all demos from the Download page.

Setup the Timeline

Smart UI for Web Components is distributed as smart-webcomponents NPM package

Download and install the package.
```
npm install smart-webcomponents
```

Once installed, import the Timeline module in your application.

<script type="module" src="node_modules/smart-webcomponents/source/modules/smart.timeline.js"></script>

Adding CSS reference

The smart.default.css CSS file should be referenced using following code.

<link rel="stylesheet" type="text/css" href="node_modules/smart-webcomponents/source/styles/smart.default.css" />

Add the Timeline tag to your Web Page

<smart-timeline id="timeline"></smart-timeline>

Create the Timeline Component

	<script type="module">
		Smart('#timeline', class {
			get properties() {
				return [object Object]
			}
		});
	</script>

Another option is to create the Timeline is by using the traditional Javascript way:

	const timeline = document.createElement('smart-timeline');

	timeline.disabled = true;
	document.body.appendChild(timeline);

Smart framework provides a way to dynamically create a web component on demand from a DIV tag which is used as a host. The following imports the web component's module and creates it on demand, when the document is ready. The #timeline is the ID of a DIV tag.

	import "../../source/modules/smart.timeline.js";

	document.readyState === 'complete' ? init() : window.onload = init;

	function init() { 
		const timeline = new Smart.Timeline('#timeline', [object Object]);
	}

Open the page in your web server.

Create, Append, Remove, Get/Set Property, Invoke Method, Bind to Event

Create a new element:

	const timeline = document.createElement('smart-timeline');

Append it to the DOM:

	document.body.appendChild(timeline);

Remove it from the DOM:

	timeline.parentNode.removeChild(timeline);

Set a property:

	timeline.propertyName = propertyValue;

Get a property value:

	const propertyValue = timeline.propertyName;

Invoke a method:

	timeline.methodName(argument1, argument2);

Add Event Listener:

	const eventHandler = (event) => {
	   // your code here.
	};

	timeline.addEventListener(eventName, eventHandler);

Remove Event Listener:

	timeline.removeEventListener(eventName, eventHandler, true);

Using with Typescript

Smart Web Components package includes TypeScript definitions which enables strongly-typed access to the Smart UI Components and their configuration.

Inside the download package, the typescript directory contains .d.ts file for each web component and a smart.elements.d.ts typescript definitions file for all web components. Copy the typescript definitions file to your project and in your TypeScript file add a reference to smart.elements.d.ts

Getting Started with Angular Timeline Component

Setup Angular Environment

Angular provides the easiest way to set angular CLI projects using Angular CLI tool.

Install the CLI application globally to your machine.

npm install -g @angular/cli

Create a new Application

ng new smart-angular-timeline

Navigate to the created project folder

cd smart-angular-timeline

Setup the Timeline

Smart UI for Angular is distributed as smart-webcomponents-angular NPM package

Download and install the package.
```
npm install smart-webcomponents-angular
```
Adding CSS reference

The following CSS file is available in ../node_modules/smart-webcomponents-angular/ package folder. This can be referenced in [src/styles.css] using following code.
```
@import 'smart-webcomponents-angular/source/styles/smart.default.css';
```
Another way to achieve the same is to edit the angular.json file and in the styles add the style.
```
"styles": [
		"node_modules/smart-webcomponents-angular/source/styles/smart.default.css"
	]
```
If you want to use Bootstrap, Fluent or other themes available in the package, you need to add them after 'smart.default.css'.

Example with Angular Standalone Components

app.component.html

 <smart-timeline [dataSource]="travelPlans"></smart-timeline>

app.component.ts

 import { Component, ViewChild, OnInit, AfterViewInit } from '@angular/core';


import { CommonModule } from '@angular/common';
import { RouterOutlet } from '@angular/router';
import { TimelineModule } from 'smart-webcomponents-angular/timeline';

@Component({
    selector: 'app-root',
	standalone: true,
	imports: [CommonModule, TimelineModule, RouterOutlet],
	templateUrl: './app.component.html',
	styleUrls: ['./app.component.css']
})

export class AppComponent implements AfterViewInit, OnInit {	
	
	travelPlans = [
        { date: "May 15, 2024", description: "Flight: Reserving airline tickets", subtitle: "May 15, 2024", title: "Flight Reservation", icon: "material-icons flight", dotCSS: "" },
        { date: "June 22, 2024", description: "Hotel: Booking for the trip", subtitle: "June 22, 2024", title: "Booking", icon: "material-icons hotel", dotCSS: "" },
        { date: "July 12, 2024", description: "Flight: Take off", subtitle: "July 12, 2024", title: "Flight", icon: "material-icons flight-takeoff", dotCSS: "" },
        { date: "July 13, 2024", description: "Excursion Plans: Hiking", subtitle: "July 13, 2024", title: "Plans", icon: "material-icons hiking", dotCSS: "" },
        { date: "Aug 14, 2024", description: "Return Journey: Flight Confirmation", subtitle: "Aug 14, 2024", title: "Flight Confirmation", icon: "material-icons flight-land", dotCSS: "" }
    ];
 
	ngOnInit(): void {
		// onInit code.
	}

	ngAfterViewInit(): void {
		// afterViewInit code.
	 }
}

Example with Angular NGModule

app.component.html

 <smart-timeline [dataSource]="travelPlans"></smart-timeline>

app.component.ts

 import { Component, ViewChild, OnInit, AfterViewInit } from '@angular/core';


@Component({
    selector: 'app-root',
	templateUrl: './app.component.html',
	styleUrls: ['./app.component.css']
})

export class AppComponent implements AfterViewInit, OnInit {	
	
	travelPlans = [
        { date: "May 15, 2024", description: "Flight: Reserving airline tickets", subtitle: "May 15, 2024", title: "Flight Reservation", icon: "material-icons flight", dotCSS: "" },
        { date: "June 22, 2024", description: "Hotel: Booking for the trip", subtitle: "June 22, 2024", title: "Booking", icon: "material-icons hotel", dotCSS: "" },
        { date: "July 12, 2024", description: "Flight: Take off", subtitle: "July 12, 2024", title: "Flight", icon: "material-icons flight-takeoff", dotCSS: "" },
        { date: "July 13, 2024", description: "Excursion Plans: Hiking", subtitle: "July 13, 2024", title: "Plans", icon: "material-icons hiking", dotCSS: "" },
        { date: "Aug 14, 2024", description: "Return Journey: Flight Confirmation", subtitle: "Aug 14, 2024", title: "Flight Confirmation", icon: "material-icons flight-land", dotCSS: "" }
    ];
 
	ngOnInit(): void {
		// onInit code.
	}

	ngAfterViewInit(): void {
		// afterViewInit code.
	 }
}

app.module.ts

 import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { TimelineModule } from 'smart-webcomponents-angular/timeline';

import { AppComponent } from './app.component';

@NgModule({
    declarations: [ AppComponent ],
    imports: [ BrowserModule,  TimelineModule],
    bootstrap: [ AppComponent ]
})

export class AppModule { }

Running the Angular application

After completing the steps required to render a Timeline, run the following command to display the output in your web browser

ng serve

and open localhost:4200 in your favorite web browser.

Read more about using Smart UI for Angular: https://www.htmlelements.com/docs/angular-cli/.

Getting Started with React Timeline Component

Setup React Environment

The easiest way to start with React is to use NextJS Next.js is a full-stack React framework. It’s versatile and lets you create React apps of any size—from a mostly static blog to a complex dynamic application.

npx create-next-app my-app
cd my-app
npm run dev

yarn create next-app my-app
cd my-app
yarn run dev

Preparation

Setup the Timeline

Smart UI for React is distributed as smart-webcomponents-react package

Download and install the package.

In your React Next.js project, run one of the following commands to install Smart UI Timeline for React
With NPM:
```
npm install smart-webcomponents-react
```
With Yarn:
```
yarn add smart-webcomponents-react
```

Once installed, import the React Timeline Component and CSS files in your application and render it. app.js

import 'smart-webcomponents-react/source/styles/smart.default.css';
import React from "react";
import ReactDOM from 'react-dom/client';
import { Timeline } from 'smart-webcomponents-react/timeline';

export default function App() {
	const travelPlans = [
        { date: "May 15, 2024", description: "Flight: Reserving airline tickets", subtitle: "May 15, 2024", title: "Flight Reservation", icon: "material-icons flight", dotCSS: "" },
        { date: "June 22, 2024", description: "Hotel: Booking for the trip", subtitle: "June 22, 2024", title: "Booking", icon: "material-icons hotel", dotCSS: "" },
        { date: "July 12, 2024", description: "Flight: Take off", subtitle: "July 12, 2024", title: "Flight", icon: "material-icons flight-takeoff", dotCSS: "" },
        { date: "July 13, 2024", description: "Excursion Plans: Hiking", subtitle: "July 13, 2024", title: "Plans", icon: "material-icons hiking", dotCSS: "" },
        { date: "Aug 14, 2024", description: "Return Journey: Flight Confirmation", subtitle: "Aug 14, 2024", title: "Flight Confirmation", icon: "material-icons flight-land", dotCSS: "" }
    ];
	
	return (
		<div>
			<Timeline dataSource={travelPlans}/>
		</div >
	)
}

Running the React application

Start the app with

npm run dev

yarn run dev

and open localhost:3000 in your favorite web browser to see the output.

Setup with Vite

Vite (French word for "quick", pronounced /vit/, like "veet") is a build tool that aims to provide a faster and leaner development experience for modern web projects
With NPM:

npm create vite@latest

With Yarn:

yarn create vite

Then follow the prompts and choose React as a project.

Navigate to your project's directory. By default it is 'vite-project' and install Smart UI for React

In your Vite project, run one of the following commands to install Smart UI Timeline for React

With NPM:

npm install smart-webcomponents-react

With Yarn:

yarn add smart-webcomponents-react

Open src/App.tsx App.tsx

import 'smart-webcomponents-react/source/styles/smart.default.css';
import React from "react";
import ReactDOM from 'react-dom/client';
import { Timeline } from 'smart-webcomponents-react/timeline';

export default function App() {
	const travelPlans = [
        { date: "May 15, 2024", description: "Flight: Reserving airline tickets", subtitle: "May 15, 2024", title: "Flight Reservation", icon: "material-icons flight", dotCSS: "" },
        { date: "June 22, 2024", description: "Hotel: Booking for the trip", subtitle: "June 22, 2024", title: "Booking", icon: "material-icons hotel", dotCSS: "" },
        { date: "July 12, 2024", description: "Flight: Take off", subtitle: "July 12, 2024", title: "Flight", icon: "material-icons flight-takeoff", dotCSS: "" },
        { date: "July 13, 2024", description: "Excursion Plans: Hiking", subtitle: "July 13, 2024", title: "Plans", icon: "material-icons hiking", dotCSS: "" },
        { date: "Aug 14, 2024", description: "Return Journey: Flight Confirmation", subtitle: "Aug 14, 2024", title: "Flight Confirmation", icon: "material-icons flight-land", dotCSS: "" }
    ];
	
	return (
		<div>
			<Timeline dataSource={travelPlans}/>
		</div >
	)
}

Read more about using Smart UI for React: https://www.htmlelements.com/docs/react/.

Getting Started with Vue Timeline Component

Setup Vue with Vite

In this section we will introduce how to scaffold a Vue Single Page Application on your local machine. The created project will be using a build setup based on Vite and allow us to use Vue Single-File Components (SFCs). Run the following command in your command line

npm create vue@latest

This command will install and execute create-vue, the official Vue project scaffolding tool. You will be presented with prompts for several optional features such as TypeScript and testing support:

✔ Project name: … 
✔ Add TypeScript? … No / Yes
✔ Add JSX Support? … No / Yes
✔ Add Vue Router for Single Page Application development? … No / Yes
✔ Add Pinia for state management? … No / Yes
✔ Add Vitest for Unit testing? … No / Yes
✔ Add an End-to-End Testing Solution? … No / Cypress / Playwright
✔ Add ESLint for code quality? … No / Yes
✔ Add Prettier for code formatting? … No / Yes

Scaffolding project in ./...
Done.

If you are unsure about an option, simply choose No by hitting enter for now. Once the project is created, follow the instructions to install dependencies and start the dev server:

cd 
npm install
npm install smart-webcomponents
npm run dev

Make Vue ignore custom elements defined outside of Vue (e.g., using the Web Components APIs). Otherwise, it will throw a warning about an Unknown custom element, assuming that you forgot to register a global component or misspelled a component name.

Open vite.config.js in your favorite text editor and change its contents to the following:

vite.config.js

import { fileURLToPath, URL } from 'node:url'

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    vue({
      template: {
        compilerOptions: {
          isCustomElement: tag => tag.startsWith('smart-')
        }
      }
    })
  ],
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url))
    }
  }
})

Open src/App.vue in your favorite text editor and change its contents to the following:

App.vue

<template>
  <div class="vue-root">		
    <smart-timeline ref="timeline">
    </smart-timeline>
  </div>
</template>
<style>
/* This is the CSS used in the demo */

/* fallback */
@font-face {
	font-family: 'Material Icons';
	font-style: normal;
	font-weight: 400;
	src: url(https://fonts.gstatic.com/s/materialicons/v31/2fcrYFNaTjcS6g4U3t-Y5ZjZjT5FdEJ140U2DJYC3mY.woff2) format('woff2');
}

.material-icons {
	font-family: 'Material Icons';
	font-weight: normal;
	font-style: normal;
	font-size: inherit;
	line-height: 1;
	letter-spacing: normal;
	text-transform: none;
	display: inline-block;
	white-space: nowrap;
	word-wrap: normal;
	direction: ltr;
	-webkit-font-feature-settings: 'liga';
	-webkit-font-smoothing: antialiased;
}

.hotel::after {
	content: "\e53a";
}
.flight::after {
	content: "\e539";
}
.flight-takeoff::after {
	content: "\e905";
}
.flight-land::after {
	content: "\e904";
}
.hiking::after {
	content: "\e50a";
}	
</style>
<script>
import { ref, onMounted } from "vue";
import "smart-webcomponents/source/styles/smart.default.css";
import "smart-webcomponents/source/modules/smart.timeline.js";

export default {
  name: 'App',
  setup() {
    const timeline = ref(null);

    onMounted(() => {
      const travelPlans = [
        { date: 'May 15, 2024', description: 'Flight: Reserving airline tickets', subtitle: 'May 15, 2024', title: 'Flight Reservation', icon: 'material-icons flight', dotCSS: '' },
        { date: 'June 22, 2024', description: 'Hotel: Booking for the trip', subtitle: 'June 22, 2024', title: 'Booking', icon: 'material-icons hotel', dotCSS: '' },
        { date: 'July 12, 2024', description: 'Flight: Take off', subtitle: 'July 12, 2024', title: 'Flight', icon: 'material-icons flight-takeoff', dotCSS: '' },
        { date: 'July 13, 2024', description: 'Excursion Plans: Hiking', subtitle: 'July 13, 2024', title: 'Plans', icon: 'material-icons hiking', dotCSS: '' },
        { date: 'Aug 14, 2024', description: 'Return Journey: Flight Confirmation', subtitle: 'Aug 14, 2024', title: 'Flight Confirmation', icon: 'material-icons flight-land', dotCSS: '' },
      ];

      if (timeline.value) {
        timeline.value.dataSource = travelPlans;
      }
    });

    return {
      timeline
    };
  },
};
</script>

<style>
</style>

We can now use the smart-timeline with Vue 3. Data binding and event handlers will just work right out of the box.

Running the Vue application

Start the app with

npm run dev

and open http://localhost:5173/ in your favorite web browser to see the output below:
When you are ready to ship your app to production, run the following:

npm run build

This will create a production-ready build of your app in the project's ./dist directory.

Read more about using Smart UI for Vue: https://www.htmlelements.com/docs/vue/.

Complex Components

Core Components

Smart.Timeline - configuration and usage

Overview

Getting Started

Getting Started with Timeline Web Component

Setup the Timeline

Create, Append, Remove, Get/Set Property, Invoke Method, Bind to Event

Using with Typescript

Getting Started with Angular Timeline Component

Setup Angular Environment

Create a new Application

Setup the Timeline

Running the Angular application

Getting Started with React Timeline Component

Setup React Environment

Preparation

Setup the Timeline

Running the React application

Setup with Vite

Getting Started with Vue Timeline Component

Setup Vue with Vite

Running the Vue application