@salesforce-ux/wes-card NPM

`@salesforce-ux/wes-card`

About

A card is a summary of larger set of content with links that drive visitors to more content.

Getting Started

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

npm i @salesforce-ux/wes-card

Distributable

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

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

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

For `Non LWC` Application

Dependency Inclusion Read the section above
Component Import
/* myComponent.js */
import WESCard from "@salesforce-ux/wes-card/dist/card";
Component Registration
/* myComponent.js */
customElements.define('wes-card', WESCard);

Example

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

Script

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

HTML

<wes-card direction="2" depth="vertical" media="fill">
    <img slot="header-start" src="/img.jpg" width="100%">
    <h2 type-style="display-6" slot="header">Automating Your Business</h2>
    <div type-style="body-2">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus auctor elit vel nulla pharetra   gravida. Sed scelerisque pretium dui, ac commodo ante blandit non.</div>
    <wes-button slot="footer" variant="secondary">
      Read Article
    </wes-button>
</wes-card>

Interactive Demo

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

@salesforce-ux/sds-card @salesforce-ux/sds-utils

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

0.1.1

2 years ago

0.1.0

3 years ago