# @salesforce-ux/c360-card

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

Latest version **0.2.6** (published 2022-03-22) · SEE LICENSE IN README.md license · 0 weekly downloads

## Install

```sh
npm install @salesforce-ux/c360-card
pnpm add @salesforce-ux/c360-card
yarn add @salesforce-ux/c360-card
bun add @salesforce-ux/c360-card
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.6 |
| Published | 2022-03-22 |
| First published | 2021-07-29 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN README.md |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 153.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Salesforce UX |
| Maintainers | salesforce-ux |

## Links

- npm: https://www.npmjs.com/package/@salesforce-ux/c360-card
- npm.io page: https://npm.io/package/@salesforce-ux/c360-card

## Dependencies (2)

- [@salesforce-ux/sds-card](https://npm.io/package/@salesforce-ux/sds-card.md) ^0.2.1
- [@salesforce-ux/sds-utils](https://npm.io/package/@salesforce-ux/sds-utils.md) ^0.1.1

## Recent versions

- 0.2.6 (latest) — 2022-03-22
- 0.2.5 — 2022-02-01
- 0.2.4 — 2022-01-05
- 0.2.3 — 2021-12-15
- 0.2.2 — 2021-09-29
- 0.2.1 — 2021-09-08
- 0.2.0 — 2021-08-19
- 0.1.0 — 2021-07-29

## README

# `@salesforce-ux/c360-card`
[![npm (custom registry)](https://img.shields.io/npm/v/@salesforce-ux/c360-card/latest?color=green&label=npm%20package)](https://www.npmjs.com/package/@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](https://www.npmjs.com/package/@salesforce-ux/c360-card).

```
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](#for-lightning-web-componentlwc-application) →)|
|`card.js` |The bundled JS file for `c360-card` component. This file is useful for **Non LWC** applications.([see below](#for-non-lwc-application) →)|

## `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`](https://www.npmjs.com/package/@salesforce-ux/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.

```css
/* myComponent.css */
@import "@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css";
```

There are also other ways [`c360-styling-hooks`](https://www.npmjs.com/package/@salesforce-ux/c360-styling-hooks) can be embedded. Please checkout the [`c360-styling-hooks` Integration Guide](https://www.npmjs.com/package/@salesforce-ux/c360-styling-hooks) to learn more.


> #### Component CSS Import
```css
/* 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](./card.spec.md).


### For `Non LWC` Application

> #### Dependency Inclusion [Read the section above](#dependency-inclusion)

> #### Component Import
```js
/* myComponent.js */
import C360Card from "@salesforce-ux/c360-card/dist/card";
```

> ####  Component Registration
```js
/* myComponent.js */
customElements.define('c360-card', C360Card);
```

#### Example

Below is one approach to integrate your `c360-card` component.
##### Script
```js
/* 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

```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](https://c360-subsystem-storybook.herokuapp.com/?path=/story/c360-subsystem-components-card--default)

---
_Source: https://npm.io/package/@salesforce-ux/c360-card · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._