@salesforce-ux/c360-divider v0.2.6

@salesforce-ux/c360-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 c360-divider as a dependency of your project with npm.

npm i @salesforce-ux/c360-divider

Distributable

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

c360-divider 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-divider. Hence, this needs to be embedded into your web app in order to make the c360-divider 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-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 C360Divider from "@salesforce-ux/c360-divider/dist/divider";

Component Registration

/* myComponent.js */
customElements.define('c360-divider', C360Divider);

Example

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

Script

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

HTML

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

Interactive Demo

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