Custom Elements Documentation
Getting Started
jqxKanban is a HTML Element which can be used to implement the kanban method for a project.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 jqxKanban element requires the following
files:
The next step is to add the html element within the body of the html page.<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/jqxsortable.js"></script><script type="text/javascript" src="../jqwidgets/jqxkanban.js"></script>
The last step is to initialize the element settings:<jqx-kanban settings="elementSettings"></jqx-kanban>
To call a function(method), you need to pass the method name and parameters(if any) in the jqxKanban's instance.<script type="text/javascript">JQXElements.settings["elementSettings"] ={columns:columns, source:adapter, resources:resources,headerHeight:50, theme:"light"}</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-kanban");element.addItem(0,[object Object]);}</script>
To set a property(option), you need to use the property name and value(s) along with the jqxKanban's instance.<script>window.onload = function () {var element = document.querySelector("jqx-kanban");var result = element.getColumn();}</script>
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".window.onload = function() {document.querySelector("jqx-kanban").headerHeight = 30;}
To get a property(option), you need to use the property name along with the jqxKanban's instance.
window.onload = function() {var propertyValue = document.querySelector("jqx-kanban").headerHeight;}
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-kanban");element.addEventListener("columnAttrClicked", function(event){// Your code here});}</script>
Example
<!DOCTYPE html><html lang="en"><head><title id='Description'>Kanban Custom Element</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/jqxdata.js"></script><script type="text/javascript" src="../../jqwidgets/jqxcore.elements.js"></script><script type="text/javascript" src="../../jqwidgets/jqxkanban.js"></script><script type="text/javascript" src="../../jqwidgets/jqxsortable.js"></script><script type="text/javascript" src="../../scripts/demos.js"></script><script type="text/javascript">var columnRenderer = function (element, collapsedElement, column) {}var resources = new jqx.dataAdapter({localData: [{ id: 0, name: "No name", image: "../../jqwidgets/styles/images/common.png", common: true },{ id: 1, name: "Andrew Fuller", image: "../../images/andrew.png" },{ id: 2, name: "Janet Leverling", image: "../../images/janet.png" },{ id: 3, name: "Steven Buchanan", image: "../../images/steven.png" },{ id: 4, name: "Nancy Davolio", image: "../../images/nancy.png" },{ id: 5, name: "Michael Buchanan", image: "../../images/Michael.png" },{ id: 6, name: "Margaret Buchanan", image: "../../images/margaret.png" },{ id: 7, name: "Robert Buchanan", image: "../../images/robert.png" },{ id: 8, name: "Laura Buchanan", image: "../../images/Laura.png" },{ id: 9, name: "Laura Buchanan", image: "../../images/Anne.png" }],dataType: "array",dataFields: [{ name: "id", type: "number" },{ name: "name", type: "string" },{ name: "image", type: "string" },{ name: "common", type: "boolean" }]});var adapter = new jqx.dataAdapter( {localData: [{ id: "1161", state: "new", label: "Combine Orders", tags: "orders, combine", hex: "#5dc3f0", resourceId: 3 },{ id: "1645", state: "work", label: "Change Billing Address", tags: "billing", hex: "#f19b60", resourceId: 1 },{ id: "9213", state: "new", label: "One item added to the cart", tags: "cart", hex: "#5dc3f0", resourceId: 3 },{ id: "6546", state: "done", label: "Edit Item Price", tags: "price, edit", hex: "#5dc3f0", resourceId: 4 },{ id: "9034", state: "new", label: "Login 404 issue", tags: "issue, login", hex: "#6bbd49" }],dataType: "array",dataFields: [{ name: "id", type: "string" },{ name: "status", map: "state", type: "string" },{ name: "text", map: "label", type: "string" },{ name: "tags", type: "string" },{ name: "color", map: "hex", type: "string" },{ name: "resourceId", type: "number" }]});var columns = [{ text: "Backlog", dataField: "new" },{ text: "In Progress", dataField: "work" },{ text: "Done", dataField: "done" }];JQXElements.settings["kanbanSettings"] ={columns:columns, source:adapter, resources:resources,headerHeight:50, theme:"light"}</script></head><body><jqx-kanban settings="kanbanSettings"></jqx-kanban></body></html>
