@salesforce-ux/wes-chip

v0.1.1

Published

8 months ago

A Chip is used to dynamically display selected information.

Downloads

0High
0Medium
0Low

salesforce-ux

`@salesforce-ux/wes-chip`

About

A Chip is used to dynamically display selected information.

Getting Started

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

npm i @salesforce-ux/wes-chip

Distributable

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

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

`wes-chip` 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-chip. Hence, this needs to be embedded into the root of the web app in order to make the wes-chip 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-chip/dist/chip.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.

<wes-chip>
  <div part="chip">
    <slot name="start"></slot>
    <span part="content">
      Label
    </span>
    <slot name="end">
      <sds-button-icon symbol="close" aria-label="Clear the chip" part="clear"></sds-button-icon>
    </slot>
  </div>
</wes-chip>

For `Non LWC` Application

Dependency Inclusion Read the section above

Component Import

/* myComponent.js */
import WESChip from "@salesforce-ux/wes-chip/chip";

Component Registration

/* myComponent.js */
customElements.define('wes-chip', WESChip);

Example

Below is one approach to integrate your wes-chip component.

Script

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

HTML

<wes-chip>
  Favorites
</wes-chip>

Interactive Demo

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