@salesforce-ux/c360-card
v0.2.6
Published
A card is a summary of larger set of content with links that drive visitors to more content.
Downloads
17
Readme
@salesforce-ux/c360-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 c360-card as a dependency of your project with npm.
npm i @salesforce-ux/c360-card
Distributable
After installation, all the distributables for the c360-card
are found under /node_modules/@salesforce-ux/c360-card/dist/
folder.
|File Name |Description |
|- |- |
|card.css
|The CSS file specific to c360-card
only. It doesnot include the styles for it's parent sds-card
. c360-card
extends from sds-card
|
|card.compiled.css
|The Compiled CSS file for c360-card
.This file includes styles for both c360-card
and its parent sds-card
. This file is useful for LWC applications.(see below →)|
|card.js
|The bundled JS file for c360-card
component. This file is useful for Non LWC applications.(see below →)|
c360-card
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-card
. Hence, this needs to be embedded into your web app in order to make the c360-card
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-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 C360Card from "@salesforce-ux/c360-card/dist/card";
Component Registration
/* myComponent.js */
customElements.define('c360-card', C360Card);
Example
Below is one approach to integrate your c360-card
component.
Script
/* myComponent.js */
import "@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css";
import C360Card from "@salesforce-ux/c360-card/dist/card";
window.customElements.define('c360-card', C360Card);
HTML
<c360-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>
<c360-button slot="footer" variant="secondary">
Read Article
</c360-button>
</c360-card>
Interactive Demo
To see more examples with interactive demo, please visit c360 Subsytem
's Storybook Environment