Skip to main content
wiz-video component in emails
eWizard Team avatar
Written by eWizard Team
Updated over a year ago

Use the wiz-video component to add links to videos in your email.

Installation

To install the wiz-video component, run the following command in the root directory of your email project:

wiz install @email/wiz-video

For more information, see Install components.

Usage


TIP: As best practice, use eWizard Editor to add and edit the components.


To use the wiz-video component in the email template:

1) Add the <wiz-video></wiz-video> tag to the email template in the App.vue file.

<!-- ./App.vue --><template>
<div>
<wiz-root align="center" style="background: #ffffff; width: 700px;">
<wiz-video id="wiz-video-395c" data-asset-id="0a1intgycd" video-poster="./common/media/images/poster.png" :video-alt="'My video'" :video-url="'https://viseven.com/'"></wiz-video>
</wiz-root>
</div>
</template>

The id attribute is required for correct display of the component styles in eWizard Editor.

The data-asset-id attribute is required for the Veeva Vault modules in the assets.json file. For more information, see Veeva Vault publish settings.

2) Change the attributes of the wiz-video component.

Attributes

You can change the wiz-video component appearance and behavior using the following attributes within the <wiz-video></wiz-video> tag:

video-poster

Add the path to the poster image that appears in your video:

<wiz-video video-poster="./common/media/images/poster.png"></wiz-video>

video-alt

Add the alternative text for the video (max 100 characters):

<wiz-video :video-alt="'My video'"></wiz-video>

video-url

Add the video URL address:

<wiz-video :video-url="'https://viseven.com/'"></wiz-video>

Properties

The wiz-video component has the following properties:


Property


Type


Default


Description

videoUrl

String

''

The video URL address. The video opens in a new browser tab.

videoAlt

String

'eWizard'

The video alternative text. The maximum length is 100 characters.

videoPoster

String

'./media/images/default-poster.jpg'

The path to the video poster.

For more information, see Component properties.

Did this answer your question?