Custom Elements Documentation

Getting Started

jqxCheckBox is a HTML Element which displays a check box that allows the end-user to select a true, false or indeterminate condition.

Every UI element from jQWidgets toolkit needs its JavaScript files to be included in order to work properly.

The first step is to create html page and add links to the javascript files and css dependencies to your project.

The jqxCheckBox element requires the following files: 

<script type="text/javascript" src="../scripts/webcomponents-lite.min.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxcore.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxcore.elements.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxdata.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxcheckbox.js"></script>
The next step is to add the html element within the body of the html page.

<jqx-check-box settings="elementSettings"></jqx-check-box>
The last step is to initialize the element settings: 
<script type="text/javascript">
    JQXElements.settings["elementSettings"] =
    {
        animationShowDelay:300, theme:"light"
    }
</script>
To call a function(method), you need to pass the method name and parameters(if any) in the jqxCheckBox's instance. 
<script>
	window.onload = function () {
		var element = document.querySelector("jqx-check-box");
		element.check();
	}
</script>
To get the result of a function after calling it, you can use the following syntax: 
<script>
	window.onload = function () {
		var element = document.querySelector("jqx-check-box");
		var result = element.val();
	}
</script>
To set a property(option), you need to use the property name and value(s) along with the jqxCheckBox's instance. 
window.onload = function() {
	document.querySelector("jqx-check-box").animationShowDelay = 250;
}
You can also set properties of HTML Elements by using Attributes. Traditionally, attributes are used to set the initial state of an element. Properties with camelCase naming have dash-based attributes. For example: A property "dataSource" will have an attribute called "data-source".

To get a property(option), you need to use the property name along with the jqxCheckBox's instance. 
window.onload = function() {
	var propertyValue = document.querySelector("jqx-check-box").animationShowDelay;
}

Event binding can be defined in the HTML as an attribute. The syntax is: 'on-' and the event's name. Event Names with camelCase naming have dash-based attributes. The attribute's value is the event handler's name. The addEventListener function can also be used for event binding. 

<script>
	window.onload = function () {
		var element = document.querySelector("jqx-check-box");
		element.addEventListener("checked", function(event){
		// Your code here
		});
	}
</script>

Example

<!DOCTYPE html>
<html lang="en">
<head>
    <title id='Description'>Checkbox Custom Element Settings</title>
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
    <meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1 minimum-scale=1" />
    <link rel="stylesheet" href="../../jqwidgets/styles/jqx.base.css" type="text/css" />
    <link rel="stylesheet" href="../../jqwidgets/styles/jqx.light.css" type="text/css" />
    <link rel="stylesheet" href="../../styles/demos.css" type="text/css" />
    <script type="text/javascript" src="../../scripts/webcomponents-lite.min.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxcore.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxcore.elements.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxcheckbox.js"></script>
    <script type="text/javascript">
        JQXElements.settings["checkboxSettings"] =
        {
            animationShowDelay:300, theme:"light"
        }
    </script>
</head>
<body>
   <jqx-check-box settings="checkboxSettings">Click me</jqx-check-box>
</body>
</html>

The result of the above code is: