Checkbox - Documentation | www.HtmlElements.com

Overview

Smart.CheckBox represents a check box that has three states: checked, unchecked and indeterminate. The state can be changed by clicking on the box or by setting the checked property.

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

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

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

    <smart-check-box id="checkbox"></smart-check-box>

  5. Create the CheckBox Component

    	<script type="module">
    		Smart('#checkbox', class {
    			get properties() {
    				return { checked: true }
    			}
    		});
    	</script>	   
    		

    Another option is to create the CheckBox is by using the traditional Javascript way:
    	const checkbox = document.createElement('smart-check-box');
    
    	checkbox.disabled = true;
    	document.body.appendChild(checkbox);
    		

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

    	import "../../source/modules/smart.checkbox.js";
    
    	document.readyState === 'complete' ? init() : window.onload = init;
    
    	function init() { 
    		const checkbox = new Smart.CheckBox('#checkbox', { checked: true });
    	}
    	

  6. Open the page in your web server.

Appearance

smart-check-box could contain a label. If the user wants to change this label, 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.elements.js"></script>
 <script>
     window.onload = function () {
        document.querySelector('smart-check-box').innerHTML = 'CheckBox 1';
     }
 </script>
</head>
<body>
 <smart-check-box>Check Box</smart-check-box>
</body>
</html>

Demo

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. This property could be set to true, false or null.

The element offers multiple click modes:

  • press - the element is checked / uncheked on press
  • release - the element is checked / uncheked on release
  • pressAndRelease - the element is checked on press and unchecked on release.

clickMode is a property of the check box 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.elements.js"></script>
</head>
<body>
 <smart-check-box click-mode="press">Check Box</smart-check-box>
</body>
</html>

Demo

Using the enableContainerClick property the user can change the behavior when different parts of the element are clicked.

By default the enableContainerClick is set to false and the element changes it's state only when the check box is clicked. When this property is set to true, clicking the element's label also changes it's state.

Demo

Keyboard Support

Smart.CheckBox 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 key.

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


Create a new element:
	const checkbox = document.createElement('smart-check-box');
	

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

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

Set a property:
	checkbox.propertyName = propertyValue;
	

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

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

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

	checkbox.addEventListener(eventName, eventHandler);
	

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

Navigate to the created project folder

cd smart-angular-checkbox

Setup the CheckBox

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 CheckBoxModule in your application root or feature module.

    app.module.ts

    import { NgModule } from '@angular/core';
    import { BrowserModule } from '@angular/platform-browser';
    
    import { CheckBoxModule } from 'smart-webcomponents-angular/checkbox';
    
    import { AppComponent } from './app.component';
    
    @NgModule({
        declarations: [ AppComponent ],
        imports: [ BrowserModule, CheckBoxModule ],
        bootstrap: [ AppComponent ],
    	entryComponents: [ 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

     
    <smart-check-box #checkbox id="checkBox">Check Box</smart-check-box>
    		

    app.component.ts

     
    import { Component, ViewChild, OnInit, AfterViewInit } from '@angular/core';
    import { CheckBoxComponent } from 'smart-webcomponents-angular/checkbox';
    
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
    	styleUrls: ['./app.component.css']
    })
    
    export class AppComponent implements AfterViewInit, OnInit {	
    	@ViewChild('checkbox', { read: CheckBoxComponent, static: false }) checkbox: CheckBoxComponent;
    	
     
    	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 { CheckBoxModule } from 'smart-webcomponents-angular/checkbox';
    
    import { AppComponent } from './app.component';
    
    @NgModule({
        declarations: [ AppComponent ],
        imports: [ BrowserModule, CheckBoxModule ],
        bootstrap: [ AppComponent ],
    	entryComponents: [ AppComponent ]
    })
    
    export class AppModule { }
    		


Running the Angular application

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

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 CheckBox 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 { CheckBox } from 'smart-webcomponents-react/checkbox';
    
    class App extends React.Component {
    
    	componentDidMount() {
    
    	}
    
    	render() {
    		return (
    			<div>
    			    <CheckBox id="checkBox">Check Box</CheckBox>
    			</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 CheckBox 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 CheckBox

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-check-box id="checkBox">Check Box</smart-check-box>
      </div>
    </template>
    
    <script>
    import { onMounted } from "vue";
    import "smart-webcomponents/source/styles/smart.default.css";
    import "smart-webcomponents/source/modules/smart.checkbox.js";
    
    export default {
      name: "app",
      setup() {
        onMounted(() => {});
      }
    };
    </script>
    
    <style>
    </style>
    		
    We can now use the smart-check-box 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-check-box'
    ]
    
    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>
        <section id="check-box">
          <div>
            <p>Checkboxes allow the user to select multiple options from a set.</p>
            <br />
            <p>If you have multiple options appearing in a list, you can preserve space by using checkboxes instead of on/off switches.</p>
            <br />
            <p>If you have a single option, avoid using a checkbox and use an on/off switch instead.</p>
            <br />
          </div>
          <br />
          <div>
            <div class="check-box-container-light">
              <smart-check-box checked></smart-check-box>
              <smart-check-box></smart-check-box>
            </div>
          </div>
        </section>
        <br />
        <section id="check-box-light">
          <div>
            <div class="check-box-table-light">
              <table>
                <tbody>
                  <tr>
                    <td>
                      <p></p>
                    </td>
                    <td>
                      <p>hover</p>
                    </td>
                    <td>
                      <p>focused</p>
                    </td>
                    <td>
                      <p>pressed</p>
                    </td>
                    <td>
                      <p>disabled</p>
                    </td>
                  </tr>
                  <tr>
                    <td colspan="5">
                      <p>On</p>
                    </td>
                  </tr>
    
                  <tr>
                    <td>
                      <p></p>
                    </td>
                    <td>
                      <smart-check-box hover checked></smart-check-box>
                    </td>
                    <td>
                      <smart-check-box focus checked></smart-check-box>
                    </td>
                    <td>
                      <smart-check-box active checked></smart-check-box>
                    </td>
                    <td>
                      <smart-check-box checked disabled></smart-check-box>
                    </td>
                  </tr>
                  <tr>
                    <td colspan="5">
                      <p>Off</p>
                    </td>
                  </tr>
                  <tr>
                    <td>
                      <p></p>
                    </td>
                    <td>
                      <smart-check-box hover></smart-check-box>
                    </td>
                    <td>
                      <smart-check-box focus></smart-check-box>
                    </td>
                    <td>
                      <smart-check-box active></smart-check-box>
                    </td>
                    <td>
                      <smart-check-box disabled></smart-check-box>
                    </td>
                  </tr>
                </tbody>
              </table>
            </div>
          </div>
        </section>
      </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-check-box with Vue. Data binding and event handlers will just work right out of the box.
    We have bound the properties of the smart-check-box 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/.