ToggleButton - Documentation | www.HtmlElements.com

Overview

This element is a clickable toggle button with two states: checked and unchecked. The state can be changed by clicking on the button or by setting the checked property.

Getting Started

Getting Started with ToggleButton 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 ToggleButton

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

  1. Download and install the package.

    npm install smart-webcomponents

  2. Once installed, import the ToggleButton module in your application.

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

  3. 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" />

  4. Add the ToggleButton tag to your Web Page

    <smart-toggle-button id="togglebutton">Click Me</smart-toggle-button>

  5. Create the ToggleButton Component

    	<script type="module">
		Smart('#togglebutton', class {
			get properties() {
				return { clickMode: "releast" }
			}
		});
	</script>

    Another option is to create the ToggleButton is by using the traditional Javascript way:
    	const togglebutton = document.createElement('smart-toggle-button');

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

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

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

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

	function init() { 
		const togglebutton = new Smart.ToggleButton('#togglebutton', { clickMode: "releast" });
	}

  6. Open the page in your web server.

Appearance

If the user wants to change the content of the check box, this can be accomplished by setting the innerHTML property of the element, like so:

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.button.js"></script>
 <script>
 window.onload = function () {
    document.querySelector('smart-toggle-button').checked = true;
 }
 </script>
</head>
<body>
 <smart-toggle-button>Toggle button</smart-toggle-button>
</body>
</html>

Behavior

Using the checked property the user can change the check state of the element dynamically as well.

By default the checked of the check box is set to false. It could be set to true or false

The element offers multiple click modes:

  • hover
  • press
  • release
  • pressAndRelease

clickMode is a property of the button that can be changed either from the HTML tag by setting the attribute click-mode and assigning a new value to it or by following the earlier approach and change it dynamically via javascript during the onload stage of the window object or later

Here's how to set a new clickMode on element initialiation:

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.button.js"></script>
</head>
<body>
 <smart-toggle-button click-mode="press">Toggle button</smart-toggle-button>
</body>
</html>

And here's how to change it via javascript after the element has been initialized:

<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.button.js"></script>
 <script>
 window.onload = function () {
    document.querySelector('smart-toggle-button').clickMode = 'pressAndRelease';
 }
 </script>
</head>
<body>
 <smart-toggle-button>Toggle button</smart-toggle-button>
</body>
</html>

Keyboard Support

Smart.ToggleButton check state could be changed via Space. Space should change the state only to Checked or Unchecked. The element is focusable and can be focused using the Tab button.

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


Create a new element:
	const togglebutton = document.createElement('smart-toggle-button');

Append it to the DOM: 
	document.body.appendChild(togglebutton);

Remove it from the DOM: 
	togglebutton.parentNode.removeChild(togglebutton);

Set a property: 
	togglebutton.propertyName = propertyValue;

Get a property value: 
	const propertyValue = togglebutton.propertyName;

Invoke a method: 
	togglebutton.methodName(argument1, argument2);

Add Event Listener: 
	const eventHandler = (event) => {
	   // your code here.
	};

	togglebutton.addEventListener(eventName, eventHandler);

Remove Event Listener: 
	togglebutton.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

Read more about using Smart UI with Typescript.

Getting Started with Angular ToggleButton 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-togglebutton

Navigate to the created project folder 

cd smart-angular-togglebutton

Setup the ToggleButton

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

  1. Download and install the package.
    npm install smart-webcomponents-angular
  2. Once installed, import the ToggleButtonModule in your application root or feature module.

    app.module.ts

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

import { ToggleButtonModule } from 'smart-webcomponents-angular/togglebutton';

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

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

export class AppModule { }

  3. 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"
	]
  4. Example


    app.component.html

     
<div class="demo-horizontal-layout">
    <div>
        <div class="demo-buttons-group">
            <smart-toggle-button #togglebutton class="primary">Toggle Button</smart-toggle-button>
            <smart-toggle-button #togglebutton2
            class="primary raised">Raised Toggle Button</smart-toggle-button>
            <smart-toggle-button #togglebutton3
            class="primary outlined">Outlined Toggle Button</smart-toggle-button>
            <smart-toggle-button #togglebutton4
            class="primary flat">Flat Toggle Button</smart-toggle-button>
            <smart-toggle-button #togglebutton5
            class="primary floating"><span class="glyphicon glyphicon-cloud"></span>
            </smart-toggle-button>
        </div>
    </div>
</div>

    app.component.ts

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


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

export class AppComponent implements AfterViewInit, OnInit {	
	@ViewChild('togglebutton', { read: ToggleButtonComponent, static: false }) togglebutton!: ToggleButtonComponent;
	@ViewChild('togglebutton2', { read: ToggleButtonComponent, static: false }) togglebutton2!: ToggleButtonComponent;
	@ViewChild('togglebutton3', { read: ToggleButtonComponent, static: false }) togglebutton3!: ToggleButtonComponent;
	@ViewChild('togglebutton4', { read: ToggleButtonComponent, static: false }) togglebutton4!: ToggleButtonComponent;
	@ViewChild('togglebutton5', { read: ToggleButtonComponent, static: false }) togglebutton5!: ToggleButtonComponent;
	
 
	ngOnInit(): void {
		// onInit code.
	}

	ngAfterViewInit(): void {
		// afterViewInit code.
		this.init();
    }
		
	init(): void {
		// init code.
	    

	}	
}

    app.module.ts

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

import { ToggleButtonModule } from 'smart-webcomponents-angular/togglebutton';

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

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

export class AppModule { }


Running the Angular application

After completing the steps required to render a ToggleButton, 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 ToggleButton Component

Setup React Environment

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

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

Setup the ToggleButton

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

  1. Download and install the package.
    npm install smart-webcomponents-react
    2. Once installed, import the React ToggleButton 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";

class App extends React.Component {

	init() {
	
	}


	componentDidMount() {

	}

	render() {
		return (
			<div>
			    <div class="demo-horizontal-layout">
			        <div>
			            <div class="demo-buttons-group">
			                <ToggleButton class="primary">Toggle Button</ToggleButton>
			                <ToggleButton class="primary raised">Raised Toggle Button</ToggleButton>
			                <ToggleButton class="primary outlined">Outlined Toggle Button</ToggleButton>
			                <ToggleButton class="primary flat">Flat Toggle Button</ToggleButton>
			                <ToggleButton class="primary floating"><span class="glyphicon glyphicon-cloud"></span>
			                </ToggleButton>
			            </div>
			        </div>
			    </div>
			</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/.

Getting Started with Vue ToggleButton Component


Setup Vue Environment

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

Setup the ToggleButton

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 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">
    <div class="demo-horizontal-layout">
      <div>
        <div class="demo-buttons-group">
          <smart-toggle-button class="primary">Toggle Button</smart-toggle-button>
          <smart-toggle-button class="primary raised">Raised Toggle Button</smart-toggle-button>
          <smart-toggle-button class="primary outlined">Outlined Toggle Button</smart-toggle-button>
          <smart-toggle-button class="primary flat">Flat Toggle Button</smart-toggle-button>
          <smart-toggle-button class="primary floating">
            <span class="glyphicon glyphicon-cloud"></span>
          </smart-toggle-button>
        </div>
      </div>
    </div>
  </div>
</template>

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

export default {
  name: "app",
  setup() {
    onMounted(() => {});
  }
};
</script>

<style>
.demo-horizontal-layout {
  display: flex;
  flex-direction: column;
  width: 300px;
}
label {
  font-size: 14px;
  font-family: Roboto, "Helvetica Neue", sans-serif;
}
.demo-buttons-group {
  margin: 8px;
  display: flex;
  flex-direction: column;
  justify-content: space-between;
  height: 300px;
  width: 200px;
}
.demo-buttons-group smart-button {
  margin: 8px;
}
.glyphicon {
  display: flex;
  justify-content: center;
  font-size: 30px;
}
</style>
    We can now use the smart-toggle-button 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-toggle-button'
]

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 

    <template>
  <div>
    <div class="toggle-button-container toggle-button-no-selection">
      <div>
        <smart-toggle-button><i class="material-icons">format_align_left</i></smart-toggle-button>
        <smart-toggle-button><i class="material-icons">format_align_center</i></smart-toggle-button>
        <smart-toggle-button><i class="material-icons">format_align_right</i></smart-toggle-button>
        <smart-toggle-button><i class="material-icons">format_align_justify</i></smart-toggle-button>
      </div>
    </div>
    <p>No options are selected</p>

    <div class="toggle-button-container toggle-button-multiple-selection">
      <div>
        <smart-toggle-button checked><i class="material-icons">format_bold</i></smart-toggle-button>
        <smart-toggle-button checked><i class="material-icons">format_italic</i></smart-toggle-button>
        <smart-toggle-button checked><i class="material-icons">format_underlined</i></smart-toggle-button>
        <smart-toggle-button><i class="material-icons">format_color_fill</i> <i class="material-icons">arrow_drop_down</i></smart-toggle-button>
      </div>
    </div>
    <p>Multiple selection</p>
    <p>Logically-grouped options, like Bold, Italic, and Underline, allow multiple options to be selected.</p>
  </div>
</template>

<script>
import "smart-webcomponents/source/modules/smart.button.js";
import "smart-webcomponents/source/styles/smart.default.css";

export default {
  name: "app"
};
</script>

<style>
</style>
    We can now use the smart-toggle-button with Vue. Data binding and event handlers will just work right out of the box.
    We have bound the properties of the smart-toggle-button to values in our Vue component.

Running the Vue application

Start the app with 
npm run dev
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/.