@salesforce-ux/wes-button

v0.1.2

Published

a year ago

The button represent an control that should invoke an action

Downloads

0High
0Medium
0Low

salesforce-ux

`@salesforce-ux/wes-button`

About

The button represent an control that should invoke an action

Getting Started

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

npm i @salesforce-ux/wes-button

Distributable

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

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

`wes-button` 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-button. Hence, this needs to be embedded into the root of the web app in order to make the wes-button 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-button/dist/button.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-button>
  <button part="button">
    <slot name="start" part="start"></slot>
      Label
    <slot name="end" part="end"></slot>
  </button>
</wes-button>

For `Non LWC` Application

Dependency Inclusion Read the section above

Component Import

/* myComponent.js */
import WESButton from "@salesforce-ux/wes-button/dist/button";

Component Registration

/* myComponent.js */
customElements.define('wes-button', WESButton);

Example

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

Script

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

HTML

<wes-button variant="primary" size="small">
  Click
</wes-button>

Interactive Demo

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