@salesforce-ux/c360-image v0.2.6

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

npm install @salesforce-ux/c360-image

Distributable

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

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

Component Registration

/* myComponent.js */
customElements.define('c360-image', C360Image);

Example

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

Script

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

HTML

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

Interactive Demo

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