mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-02 12:08:50 +00:00
docs: make Catalog visual and reproducible
This commit is contained in:
@@ -3,23 +3,24 @@ title: "News Ticker"
|
||||
description: "Premium broadcast-style lower-third ticker with live label, headline ribbon, and scrolling news crawl."
|
||||
---
|
||||
|
||||
# News Ticker
|
||||
|
||||
Premium broadcast-style lower-third ticker with live label, headline ribbon, and scrolling news crawl.
|
||||
|
||||
`lower-third` `overlay` `news` `ticker`
|
||||
|
||||
<video className="w-full aspect-video rounded-xl object-cover bg-zinc-100 dark:bg-zinc-800" src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/news-ticker.mp4" poster="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/news-ticker.png" autoPlay muted loop playsInline />
|
||||
|
||||
## Install
|
||||
## Add it to a project
|
||||
|
||||
<CodeGroup>
|
||||
### Ask your agent
|
||||
|
||||
```bash Terminal
|
||||
npx hyperframes add news-ticker
|
||||
```text
|
||||
Add the News Ticker block from the HyperFrames Catalog to this project.
|
||||
Replace the demo content with mine and match the existing design and timing.
|
||||
```
|
||||
|
||||
</CodeGroup>
|
||||
### Install from the terminal
|
||||
|
||||
```bash
|
||||
npx hyperframes add news-ticker
|
||||
```
|
||||
|
||||
## Details
|
||||
|
||||
@@ -29,16 +30,24 @@ npx hyperframes add news-ticker
|
||||
| Dimensions | 1920×1080 |
|
||||
| Duration | 7s |
|
||||
|
||||
## Files
|
||||
**Installed files**
|
||||
|
||||
| File | Target | Type |
|
||||
| --- | --- | --- |
|
||||
| `news-ticker.html` | `compositions/news-ticker.html` | hyperframes:composition |
|
||||
|
||||
## Usage
|
||||
## Use it
|
||||
|
||||
After installing, add the block to your host composition:
|
||||
Ask your agent to replace the example content, match the project style, and place the block at the right moment in the video.
|
||||
|
||||
**Wiring it by hand.** The installed block can be added to a host composition with:
|
||||
|
||||
```html
|
||||
<div data-composition-id="news-ticker" data-composition-src="compositions/news-ticker.html" data-start="0" data-duration="7" data-track-index="1" data-width="1920" data-height="1080"></div>
|
||||
```
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Browse the complete Catalog](/catalog)
|
||||
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
|
||||
- [Build a richer composition](/go-further)
|
||||
|
||||
Reference in New Issue
Block a user