smart-html-elements

JavaScript (ES6) & TypeScript
Angular
React
Vue

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.

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 Breadcrumb module in your application.

<script type="module" src="node_modules/smart-webcomponents/source/modules/smart.breadcrumb.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 Breadcrumb tag to your Web Page

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

Create the Breadcrumb Component

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

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

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

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

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 #breadcrumb is the ID of a DIV tag.

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

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

	function init() { 
		const breadcrumb = new Smart.Breadcrumb('#breadcrumb', [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 breadcrumb = document.createElement('smart-breadcrumb');

Append it to the DOM:

	document.body.appendChild(breadcrumb);

Remove it from the DOM:

	breadcrumb.parentNode.removeChild(breadcrumb);

Set a property:

	breadcrumb.propertyName = propertyValue;

Get a property value:

	const propertyValue = breadcrumb.propertyName;

Invoke a method:

	breadcrumb.methodName(argument1, argument2);

Add Event Listener:

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

	breadcrumb.addEventListener(eventName, eventHandler);

Remove Event Listener:

	breadcrumb.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

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

ng new smart-angular-breadcrumb

Navigate to the created project folder

cd smart-angular-breadcrumb

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

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

Once installed, import the BreadcrumbModule in your application root or feature module.

app.module.ts

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

import { BreadcrumbModule } from 'smart-webcomponents-angular/breadcrumb';

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

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

export class AppModule { }

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"
	]
	
```

Example

app.component.html

 
<smart-breadcrumb #breadcrumb id="breadcrumb1" add-new-item allow-drag
allow-drop close-buttons data-source='[{ "label": "Planets", "value": "A" }, { "label": "Continents", "value": "B" }, { "label": "Countries", "value": "C" }, { "label": "States", "value": "D" }, { "label": "Cities", "value": "E" }]'></smart-breadcrumb>
<br />
<smart-breadcrumb #breadcrumb2 id="breadcrumb2" allow-drag allow-drop
close-buttons data-source='[{ "label": "Email", "value": "alternate_email" }, { "label": "Phone", "value": "phone" }, { "label": "TV", "value": "tv" }, { "label": "Video game", "value": "videogame_asset" }, { "label": "Laptop", "value": "laptop" }]'
item-template="breadcrumb2Template"></smart-breadcrumb>
<br />
<smart-breadcrumb #breadcrumb3 id="breadcrumb3" minimize-width="150" allow-drag
allow-drop close-buttons data-source='[{ "label": "Planets", "value": "A" }, { "label": "Continents", "value": "B" }, { "label": "Countries", "value": "C" }, { "label": "States", "value": "D" }, { "label": "Cities", "value": "E" }]'></smart-breadcrumb>

app.component.ts

 
import { Component, ViewChild, OnInit, AfterViewInit } from '@angular/core';
import { BreadcrumbComponent } from 'smart-webcomponents-angular/breadcrumb';


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

export class AppComponent implements AfterViewInit, OnInit {	
	@ViewChild('breadcrumb', { read: BreadcrumbComponent, static: false }) breadcrumb: BreadcrumbComponent;
	@ViewChild('breadcrumb2', { read: BreadcrumbComponent, static: false }) breadcrumb2: BreadcrumbComponent;
	@ViewChild('breadcrumb3', { read: BreadcrumbComponent, static: false }) breadcrumb3: BreadcrumbComponent;
	
 
	ngOnInit(): void {
		// onInit code.
	}

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

app.module.ts

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

import { BreadcrumbModule } from 'smart-webcomponents-angular/breadcrumb';

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

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

export class AppModule { }

After completing the steps required to render a Breadcrumb, 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/.

The easiest way to start with React is to use create-react-app. To scaffold your project structure, follow the installation instructions.

	npm install -g create-react-app
	create-react-app my-app
	cd my-app
	npm start

Preparation

Open src/App.js andsrc/App.css

Remove everything inside the App div tag in src/App.js:
```
<div className="App"> </div>
```
Remove the logo.svg import
Remove the contents of src/App.css
Remove src/logo.svg

Setup the Breadcrumb

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

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

Once installed, import the React Breadcrumb 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";
import { Breadcrumb } from 'smart-webcomponents-react/breadcrumb';

class App extends React.Component {

	componentDidMount() {
	}

	render() {
		return (
			<div>
			    <Breadcrumb ref="breadcrumb" id="breadcrumb1" addNewItem allowDrag
			    allowDrop closeButtons dataSource='[{ "label": "Planets", "value": "A" }, { "label": "Continents", "value": "B" }, { "label": "Countries", "value": "C" }, { "label": "States", "value": "D" }, { "label": "Cities", "value": "E" }]'></Breadcrumb>
			    <br />
			    <Breadcrumb ref="breadcrumb2" id="breadcrumb2" allowDrag allowDrop closeButtons
			    data-source='[{ "label": "Email", "value": "alternate_email" }, { "label": "Phone", "value": "phone" }, { "label": "TV", "value": "tv" }, { "label": "Video game", "value": "videogame_asset" }, { "label": "Laptop", "value": "laptop" }]'
			    ></Breadcrumb>
			    <br />
			    <Breadcrumb ref="breadcrumb3" id="breadcrumb3" minimizeWidth="150" allowDrag
			    allowDrop closeButtons dataSource='[{ "label": "Planets", "value": "A" }, { "label": "Continents", "value": "B" }, { "label": "Countries", "value": "C" }, { "label": "States", "value": "D" }, { "label": "Cities", "value": "E" }]'></Breadcrumb>
			    
			</div>
		);
	}
}

ReactDOM.render(<App />, document.querySelector("#root"));

export default App;

Running the React application

Start the app with

npm start

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

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

We will use vue-cli to get started. Let's install vue-cli

npm install -g @vue/cli

Then we can start creating our Vue.js projects with:

vue create my-project

Open the "my-project" folder and run:

npm install smart-webcomponents

Setup with Vue 3.x

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 src/main.js in your favorite text editor and change its contents to the following:

main.js
```
import { createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)

app.config.isCustomElement = tag => tag.startsWith('smart-');
app.mount('#app')
		
```

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

App.vue

<template>
  <div class="vue-root">
    <smart-breadcrumb
      id="breadcrumb1"
      add-new-item
      allow-drag
      allow-drop
      close-buttons
      data-source="[{ 'label': 'Planets', 'value': 'A' }, { 'label': 'Continents', 'value': 'B' }, { 'label': 'Countries', 'value': 'C' }, { 'label': 'States', 'value': 'D' }, { 'label': 'Cities', 'value': 'E' }]"
    ></smart-breadcrumb>
    <br />
    <smart-breadcrumb
      id="breadcrumb2"
      allow-drag
      allow-drop
      close-buttons
      data-source="[{ 'label': 'Email', 'value': 'alternate_email' }, { 'label': 'Phone', 'value': 'phone' }, { 'label': 'TV', 'value': 'tv' }, { 'label': 'Video game', 'value': 'videogame_asset' }, { 'label': 'Laptop', 'value': 'laptop' }]"
      item-template="breadcrumb2Template"
    ></smart-breadcrumb>
    <br />
    <smart-breadcrumb
      id="breadcrumb3"
      minimize-width="150"
      allow-drag
      allow-drop
      close-buttons
      data-source="'[{ 'label': 'Planets', 'value': 'A' }, { 'label': 'Continents', 'value': 'B' }, { 'label': 'Countries', 'value': 'C' }, { 'label': 'States', 'value': 'D' }, { 'label': 'Cities', 'value': 'E' }]"
    ></smart-breadcrumb>
    <template id="breadcrumb2Template">
      <i class="material-icons">{{value}}</i>
      {{label}}
    </template>
  </div>
</template>

<script>
import { onMounted } from "vue";
import "smart-webcomponents/source/styles/smart.default.css";
import "smart-webcomponents/source/modules/smart.breadcrumb.js";

export default {
  name: "app",
  setup() {
    onMounted(() => {
      const breadcrumb1 = document.getElementById("breadcrumb1");
      let newItems = 0;

      breadcrumb1.addEventListener("addNewItem", function() {
        if (newItems === 0) {
          breadcrumb1.addItem({
            index: this.dataSource.length,
            label: "Districts",
            value: "F"
          });
          newItems++;
        } else if (newItems === 1) {
          breadcrumb1.addItem({
            index: this.dataSource.length,
            label: "Blocks",
            value: "G"
          });
          breadcrumb1.addNewItem = false;
        }
      });

      breadcrumb1.addEventListener("dragEnd", function(event) {
        if (!breadcrumb1.contains(event.detail.target)) {
          breadcrumb1.removeItem(event.detail.item);
        }
      });
    });
  }
};
</script>

<style>
#breadcrumb2 {
  --smart-breadcrumb-item-height: 50px;
  width: 800px;
}

#breadcrumb2 .smart-breadcrumb-item-label {
  display: flex;
  align-items: center;
}

.material-icons {
  margin-right: 5px;
  padding: 5px;
  width: 34px;
  height: 34px;
  background-color: var(--smart-success);
  border-radius: 100%;
}

#breadcrumb3 {
  width: 100px;
}
</style>

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

Setup with Vue 2.x

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 src/main.js in your favorite text editor and change its contents to the following:

main.js
```
import Vue from 'vue'
import App from './App.vue'

Vue.config.productionTip = false
Vue.config.ignoredElements = [
'smart-breadcrumb'
]

new Vue({
  render: h => h(App),
}).$mount('#app')
```
Open src/App.vue in your favorite text editor and change its contents to the following:

App.vue
```
		
```
We can now use the smart-breadcrumb with Vue. Data binding and event handlers will just work right out of the box.
We have bound the properties of the smart-breadcrumb to values in our Vue component.

Running the Vue application

Start the app with

npm run serve

and open localhost:8080 in your favorite web browser to see the output below:

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