# @incrowd/article-rendering-engine
> A component for rendering article from the CMS.
Latest version **2.10.9** (published 2023-07-14) · 0 weekly downloads
## Install
```sh
npm install @incrowd/article-rendering-engine
pnpm add @incrowd/article-rendering-engine
yarn add @incrowd/article-rendering-engine
bun add @incrowd/article-rendering-engine
```
## Health
**Score 20/100 (F)** — status: abandoned.
Positive: esm support; no vulnerabilities.
Warnings: low downloads; no types.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.10.9 |
| Published | 2023-07-14 |
| First published | 2019-02-21 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 181.4 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | virgus66, horacekeung, josh_clement, saelora |
| Keywords | svelte |
## Links
- npm: https://www.npmjs.com/package/@incrowd/article-rendering-engine
- npm.io page: https://npm.io/package/@incrowd/article-rendering-engine
## Dependencies (1)
- [marked](https://npm.io/package/marked.md) ^0.8.2
## Recent versions
- 2.10.9 (latest) — 2023-07-14
- 2.10.8 — 2023-07-14
- 2.10.5 — 2022-03-17
- 2.10.4 — 2022-03-17
- 2.10.3 — 2020-03-02
- 2.10.2 — 2020-02-21
- 2.10.1 — 2020-02-20
- 2.10.0 — 2020-02-07
- 2.9.1 — 2020-01-28
- 2.9.0 — 2020-01-02
- 2.8.0 — 2019-12-02
- 2.7.0 — 2019-11-20
- 2.6.5 — 2019-11-14
- 2.6.4 — 2019-11-04
- 2.6.3 — 2019-10-22
- … 25 more at https://npm.io/package/@incrowd/article-rendering-engine/versions
## README
# InCrowd Article Rendering Engine (ICARE)
A component for rendering article from the CMS.
## Motivation
To reuse this component across all web apps.
## Getting Started
`npm i @incrowd/article-rendering-engine`
Then import `@incrowd/article-rendering-engine/public/icare_example.css` in global scope.
```css
/* .icare {} */
.icare * {
box-sizing: border-box;
}
.icare-body {
padding: 0 1rem 1rem;
}
.icare h1 {
font-size: 2rem;
font-weight: bold;
margin-bottom: 1.5rem;
}
.icare h2 {
font-size: 1.5rem;
font-weight: 500;
margin-bottom: 1rem;
}
.icare-metadata {
display: flex;
margin-bottom: 1rem;
}
.icare-metadata img {
width: 3.5rem;
height: 3.5rem;
margin-right: 0.5rem;
border-radius: 9999px;
}
.icare-metadata p {
margin: 0.25rem 0;
}
.icare-content-block {
margin-bottom: 1rem;
}
.icare-content-block-sponsor {
display: flex;
}
.icare-content-block-sponsor span {
font-size: 0.875rem;
margin-top: auto;
margin-bottom: auto;
margin-right: 0.5rem;
}
.icare-content-block-sponsor img {
height: 2rem;
}
/* .icare-image {} */
/* .icare-video-youtube {} */
/* .icare-video-media {} */
.icare-text * {
margin-bottom: 1rem;
}
.icare-text iframe {
width: 100%;
display: block;
}
/* .icare-gallery {} */
.icare-quote {
margin: 0 auto;
padding: 1.5rem 0 0 2rem;
font-weight: 700;
}
.icare-quote-text::before {
content: '\201C';
font-size: 4rem;
position: absolute;
left: -2rem;
top: -2rem;
}
.icare-quote-text {
position: relative;
font-size: 1.25rem;
text-align: center;
margin: 0;
}
.icare-quote-footer {
text-transform: uppercase;
text-align: right;
margin-top: 0.5rem;
}
.icare-quote-author::before {
content: "\2013\00A0";
}
.icare-quote-author {
margin: 0;
}
.icare-quote-title {
margin: 0;
font-size: 0.5rem;
opacity: 0.5;
}
.icare-cm {
display: grid;
grid-gap: 0.5rem;
grid-template-columns: repeat(auto-fill, minmax(300px, 1fr));
}
.icare-cm-video-column {
grid-column: auto / span 2;
display: flex;
}
.icare-cm-playlist-column {
display: flex;
margin-bottom: 1rem;
}
.icare-cm-playlist-container {
width: 100%;
outline: 1px solid grey;
display: flex;
flex-direction: column;
}
.icare-cm-playlist-title {
margin: 0.5rem;
font-size: 1.25rem;
font-weight: 500;
}
.icare-cm-playlist {
outline: 1px solid grey;
flex: 1 1 0%;
max-height: 400px;
overflow-y: auto;
}
.icare-cm-playlist-item {
display: flex;
padding: 0.25rem 0.5rem;
cursor: pointer;
}
.icare-cm-playlist-item img {
width: 100px;
height: auto;
margin: 0 0.5rem;
}
.icare-cm-playlist-item p {
margin: auto 0;
font-size: 0.875rem;
}
.icare-cm-playlist-item-active {
background-color: lightgrey;
}
.icare-related-content-list {
margin: 0
}
.icare-related-content-list-item {
cursor: pointer;
margin-bottom: 1rem;
}
.icare-footer-author {
border-top: 1px solid lightgray;
padding-top: 1rem;
display: flex;
}
.icare-footer-author-image {
width: 5rem;
height: 5rem;
margin-right: 1rem;
border-radius: 9999px;
}
.icare-footer-author-name {
margin: 0 0 0.25rem;
font-size: 1.25rem;
font-weight: bold;
}
.icare-footer-author-title {
margin: 0 0 0.25rem;
}
.icare-social-icon {
display: block;
width: 1.5rem;
height: 1.5rem;
margin-right: 0.25rem;
}
```
Or copy the class names and customize them.
## Usage
### In Svelte.js
```html
```
### In all other environment
```html
```
`accessToken` is optional. It is used for executing campaign (PROMO block) and fetching KSession for stream videos.
`apiUrl` is set to `https://article-cms-api.incrowdsports.com/v2/articles` by default.
`campaignApiUrl` is set to `https://promoblocks-cms-api.incrowdsports.com/v1` by default.
`onRelatedContentClick` should be a function that has `content` as the first argument which will be called when a related content is clicked. For example:
```javascript
const onRelatedContentClick = content => {
console.log(JSON.stringify(content, null, 4))
}
```
Can call `icareInstance.$destroy()` to destroy the element. For more information, please read the [Svelte.js documentation](https://svelte.dev/docs).
---
_Source: https://npm.io/package/@incrowd/article-rendering-engine · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._