@salesforce-ux/c360-input-checkbox v0.1.3

@salesforce-ux/c360-input-checkbox

About

A checkable input that communicates if an option is true, false or indeterminate.

Getting Started

Let's start by installing c360-input-checkbox as a dependency of your project with npm.

npm i @salesforce-ux/c360-input-checkbox

Distributable

After installation, all the distributables for the c360-input-checkbox are found under /node_modules/@salesforce-ux/c360-input-checkbox/dist/ folder.

c360-input-checkbox Integration

For the sake of understanding, we will categorize the development environment into LWC and Non LWC application.
This Guide will cover the integration approach for these two types of application.

For Lightning Web Component(LWC) Application

Dependency Inclusion

c360-styling-hooks is a styling dependency for c360-input-checkbox. Hence, this needs to be embedded into your web app in order to make the c360-input-checkbox render properly.

/* myComponent.css */
@import "@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css";

There are also other ways c360-styling-hooks can be embedded. Please checkout the c360-styling-hooks Integration Guide to learn more.

Component CSS Import

/* myComponent.css */
@import "@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css";
@import '@salesforce-ux/c360-input-checkbox/dist/input-checkbox.compiled.css'

HTML Decoration

After that,the HTML of your LWC component template needs to be decorated to have all the named part attributes as per the component's specification. Below is a reference to the component's structure.

<div part="input-checkbox">
  <input type="checkbox" id="checkbox-id" part="checkbox" />
  <div part="indicator">
    <slot name="indicator">
      <sds-icon></sds-icon>
    </slot>
  </div>
  <label part="label" for="checkbox-id">
    <slot></slot>
  </label>
</div>

### For `Non LWC` Application


> #### Dependency Inclusion [Read the section above](#dependency-inclusion)


> #### Component Import
```JS
/* myComponent.js */
import C360InputCheckbox from '@salesforce-ux/c360-input-checkbox/dist/input-checkbox';

Component Registration

/* myComponent.js */
customElements.define('c360-input-checkbox', C360InputCheckbox);

Example

Below is one approach to integrate your c360-input-checkbox component.

Script

/* myComponent.js */
import '@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css';
import C360InputCheckbox from '@salesforce-ux/c360-input-checkbox/dist/input-checkbox';
window.customElements.define('c360-input-checkbox', C360InputCheckbox);

HTML

<c360-input-checkbox>Checkbox</c360-input-checkbox>

Interactive Demo

To see more examples with interactive demo, please visit c360 Subsytem's Storybook Environment