@salesforce-ux/wes-input-checkbox

v0.1.1

Published

a year ago

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

Downloads

0High
0Medium
0Low

salesforce-ux

`@salesforce-ux/wes-input-checkbox`

About

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

Getting Started

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

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

Distributable

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

|File Name |Description | |- |- | |input-checkbox.css |The CSS file specific to wes-input-checkbox only. It doesnot include the styles for it's parent sds-input-checkbox. wes-input-checkbox extends from sds-input-checkbox| |input-checkbox.compiled.css |The Compiled CSS file for wes-input-checkbox. This file includes styles for both wes-input-checkbox and its parent sds-input-checkbox. This file is useful for LWC applications.(see below →)| |input-checkbox.js |The bundled JS file for wes-input-checkbox component. This file is useful for Non LWC applications.(see below →)|

`wes-input-checkbox` Integration

For the sake of understanding, we have categorized the development environment into LWC and Non LWC application. If you are using the Salesforce Experience Cloud platform, WES is supported through an Unlocked Package, see the Confluence page for the WES Unlocked Package.

This Guide covers the integration approach for these two types of application.

For `Lightning Web Component(LWC)` Application

Dependency Inclusion

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

<html>
  <head>
    <link rel="stylesheet" href="/node_modules/@salesforce-ux/wes-styling-hooks/dist/hooks.custom-props.css">
    <!-- Your application's other stylesheets go below -->
    <link rel="stylesheet" href="...">
  </head>
  <body>
    <!-- Your application -->
  </body>
</html>

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

Component CSS Import

/* myComponent.css */
@import '@salesforce-ux/wes-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

Component Import

/* myComponent.js */
import WESInputCheckbox from '@salesforce-ux/wes-input-checkbox/dist/input-checkbox';

Component Registration

/* myComponent.js */
customElements.define('wes-input-checkbox', WESInputCheckbox);

Example

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

Script

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

HTML

<wes-input-checkbox>Checkbox</wes-input-checkbox>

Interactive Demo

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