Video
Usage
The ShVideo constructor creates a display format for embedding a video with customizable styles.
Basic
::ShVideo
---
src: "https://www.youtube.com/watch?v=8A5AMiskxvQ"
---
::
Advanced settings
An example with customized ui attributes for enhanced display:
::ShVideo
---
ui:
wrapper: "shadow-2xl mx-auto max-w-screen-lg" # custom styles for the wrapper
src: "https://www.youtube.com/watch?v=8A5AMiskxvQ"
---
::
Props
| Prop | Type | Default | Description |
|---|---|---|---|
description | string | "" | Note for content writers. It is not rendered on the website. |
srcrequired | string | "" | The source URL of the video to be embedded. This property is mandatory. |
ui | Record<string, any> | – | Overrides the default classes of the UI config below. Values are merged with the defaults using tailwind-merge. |
Slots
This component has no slots.
UI config
Default classes of every styled element. Override any key through the ui prop.
| Key | Default classes | Description |
|---|---|---|
wrapper | mx-5 ring-1 ring-neutral-300 dark:ring-neutral-700 | Defines the overall styling for the container that holds the video. |
