@salesforce-ux/c360-button-toggle

About

The Button Toggle provides feedback of its pressed and unpressed state.

Getting Started

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

npm i @salesforce-ux/c360-button-toggle

Distributable

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

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

c360-button-toggle 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-button-toggle. Hence, this needs to be embedded into your web app in order to make the c360-button-toggle 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-button-toggle/dist/button-toggle.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.

<c360-button-toggle>
  <button part="button">
    Toggle
    <c360-icon symbol="add" slot="end"></c360-icon>
    <c360-icon symbol="check" slot="end"></c360-icon>
    <c360-icon symbol="close" slot="end"></c360-icon>
  </button>
</c360-button>

For Non LWC Application

Dependency Inclusion Read the section above

Component Import

/* myComponent.js */
import C360ButtonToggle from '@salesforce-ux/c360-button-toggle/button-toggle';

Component Registration

/* myComponent.js */
customElements.define('c360-button-toggle', C360ButtonToggle);

Example

Below is one approach to integrate your c360-button-toggle component.

Script

/* myComponent.js */
import "@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css";
import C360Button from "@salesforce-ux/c360-button-toggle/dist/button-toggle";
window.customElements.define('c360-button-toggle', C360ButtonToggle);

HTML

<c360-button-toggle>Toggle</c360-button-toggle>

Interactive Demo

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