`@salesforce-ux/wes-image`

About

An Image component wraps an image in a figure and allows for visual and functional image treatments.

Getting Started

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

npm install @salesforce-ux/wes-image

Distributable

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

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

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

<figure part="figure">
  <img part="image">
  <figcaption part="caption">
    <slot></slot>
  </figcaption>
</figure>

For `Non LWC` Application

Dependency Inclusion Read the section above

Component Import

/* myComponent.js */
import WESImage from "@salesforce-ux/wes-image/dist/image";

Component Registration

/* myComponent.js */
customElements.define('wes-image', WESImage);

Example

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

Script

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

HTML

<wes-image
  src="path-to-image"
  alt="Description of the image"
  width="300"
  radius="1">
</wes-image>

Interactive Demo

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