standards-ui
Version:
A foundational design system built with native Web Components. Includes comprehensive TypeScript types, JSDoc documentation, and component examples.
567 lines (99 loc) • 5.91 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: DsCheckbox</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: DsCheckbox</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>DsCheckbox<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">ds-checkbox - A checkbox component that wraps native checkbox input elements</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="DsCheckbox"><span class="type-signature"></span>new DsCheckbox<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ds-checkbox.js.html">ds-checkbox.js</a>, <a href="ds-checkbox.js.html#line4">line 4</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="checked"><span class="type-signature"></span>checked<span class="type-signature"></span></h4>
<div class="description">
Property getters and setters to mirror the internal checkbox
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ds-checkbox.js.html">ds-checkbox.js</a>, <a href="ds-checkbox.js.html#line131">line 131</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".observedAttributes"><span class="type-signature">(static) </span>observedAttributes<span class="type-signature"></span></h4>
<div class="description">
Define which attributes should trigger attributeChangedCallback
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ds-checkbox.js.html">ds-checkbox.js</a>, <a href="ds-checkbox.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="attributeChangedCallback"><span class="type-signature"></span>attributeChangedCallback<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
React to attribute changes and apply corresponding properties to the internal checkbox
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ds-checkbox.js.html">ds-checkbox.js</a>, <a href="ds-checkbox.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h4 class="name" id="connectedCallback"><span class="type-signature"></span>connectedCallback<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Called when the element is connected to the DOM
Apply initial attributes
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ds-checkbox.js.html">ds-checkbox.js</a>, <a href="ds-checkbox.js.html#line183">line 183</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setupEventListeners"><span class="type-signature"></span>setupEventListeners<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Set up event listeners to re-dispatch events from the host element
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ds-checkbox.js.html">ds-checkbox.js</a>, <a href="ds-checkbox.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="DsCheckbox.html">DsCheckbox</a></li><li><a href="DsFieldset.html">DsFieldset</a></li><li><a href="DsLabel.html">DsLabel</a></li><li><a href="DsLegend.html">DsLegend</a></li><li><a href="DsOption.html">DsOption</a></li><li><a href="DsSelect.html">DsSelect</a></li><li><a href="DsTextarea.html">DsTextarea</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Wed Jun 25 2025 21:24:48 GMT-0700 (Pacific Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>