2.24.1Video Component in Bolt
Stylistic video. Part of the Bolt “Components” CSS framework that powers the Bolt Design System.
npm install @bolt/video
{% include "@bolt/video.twig" with {
videoId: "5609376179001",
accountId: "1900410236",
playerId: "r1CAdLzTW",
showMeta: true,
showMetaTitle: false
} only %}
Note: when assigning component props as HTML attributes on a web component, make sure to use kebab-case.
| Prop Name | Description | Type | Default Value | Option(s) |
|---|---|---|---|---|
| attributes | A Drupal-style attributes object with extra attributes to append to this component. |
object
| — |
|
| videoId | Brightcove ID for this video. |
string , number |
— |
|
| playerId | Brightcover Player ID. |
string
| — |
|
| accountID | ID of the Brightcove account that owns the video. |
string , number |
— |
|
| videoUuid | A unique identifying string, randomly generated if not provided. |
string
| — |
|
| share_description | A custom title to use in the share overlay |
string
|
Share This Video
|
|
| ratio | Maintain video ratio. |
boolean
| — |
|
| collapsed | Should the video be collapsed on load. |
boolean
| — |
|
| showMeta | Should the video show meta data. |
boolean
|
true
|
|
| showMetaTitle | Should the video show meta title. |
boolean
|
true
|
|
| controls | Should the video controls be available. |
boolean
|
true
|
|
| autoplay | Should the video auto-play on load. |
boolean
|
false
|
|
| loop | Should the video loop. |
boolean
|
false
|
|
| on_init | The |
string
| — |
|
| enabled_plugins | Space-separated list of built-in |
string
| — |
|
| disabled_plugins | Space-separated list of any built-in |
string
| — |
|
| errorMessage | A custom message to be display upon a brigthcove error, will default to "This video didnt load correctly. Refresh page to view." is this field is left blank. |
string
| — |
|
| isBackgroundVideo | Background video feature will be removed with Bolt v3.0 |
| — |
|
| default_plugins | An array of the default |
array
| — |
|
| available_plugins | The built-in |
array
| — |
|