@salesforce-ux/wes-divider NPM

`@salesforce-ux/wes-divider`

About

Dividers are used to represent thematic breaks between paragraph-level elements. Dividers helps categorize and organize the content in a page

Getting Started

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

npm i @salesforce-ux/wes-divider

Distributable

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

File Name	Description
`divider.css`	The CSS file for `wes-divider` component.
`divider.js`	The bundled JS file for `wes-divider` component.This file is useful for Non LWC applications.(see below →)

`wes-divider` 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-divider. Hence, this needs to be embedded into the root of the web app in order to make the wes-divider 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-divider/dist/divider.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="divider">
  <div part="content">
    <slot name="icon"></slot>
    <span part="label">
      <slot></slot>
    </span>
  </div>
</div>

For `Non LWC` Application

Dependency Inclusion Read the section above
Component Import

/* myComponent.js */
import WESDivider from "@salesforce-ux/wes-divider/dist/divider";

Component Registration

/* myComponent.js */
customElements.define('wes-divider', WESDivider);

Example

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

Script

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

HTML

<wes-divider variant="primary" direction="horizontal" color="red"></wes-divider>

Interactive Demo

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

@salesforce-ux/sds-common @salesforce-ux/sds-utils elix

@infinitebrahmanuniverse/nolb-_sal @everything-registry/sub-chunk-803 @zalastax/nolb-_sal

0.1.1

8 months ago

0.1.0

2 years ago