Tassos Marinos Developer of Joomla Extensions

The Vimeo Field

Updated 03 Jul, 2023

The Vimeo custom field gives you the ability to display a Vimeo video at your frontend just by filling out the URL or just the ID of the Vimeo video.

How to add a Vimeo Custom Field to Joomla! Articles

The Vimeo field provides you all of the customization options of the player which will display the video at your frontend.


Let's see what each option does.

Name Description
Name The name will be used to identify the field. Leave this blank and Joomla will fill in a default value from the title.
Label The label of the field to display.
Description A description of the field that will be displayed in the label tooltip.
Required Is this a mandatory field?
Video Size Set the size of the embedded video.

Fixed: The video will be embedded at a fixed size.
Responsive: The video will be embedded responsively, so it will adapt to the height and width of its container.
Video Width If you prefer to use percentage you have to type the percentage sign '%' at the end of your value like so, 90%.
Video Height The video's height in pixels. You can also use a percentage here the same way as you do with the width.

Pro Only

Name Description
Autoplay Choose if you want the video to start playing when the page finishes loading.
Loop Choose if you want the video to start playing from the beginning once it finishes.
Display Title Choose if you want to display the video's title inside the player.
Display Byline Choose if you want to display the byline inside the player. The byline is the informative text under the title which in most occassions is the creator's username.
Display Portrait Choose if you want to display the creator's portrait.
UI Color Choose the player's UI color. This color will be used for the title, the byline and the player's controls.


Once you are in your Article's Edit screen, choose the "Fields" Tab to see the Vimeo custom field as you can see in the screenshot below.


In this textbox you can type in the full URL or just the ID of the Vimeo video that you are interested in.

Frontend Display

Take a look at the screenshot below to see how it could be displayed in your frontend.


Frequently Asked Questions

How do i make my video responsive?

By default, the video will have a Fixed video size. Meaning the width and height of the video can be set in the Video Width and Video Height settings.

If you desire to make the video responsive which will make it auto resize in mobile devices, select the option Responsive in the setting Video Size. This will remove the settings Video Width and Video Height and make it's width the same as the parents (full width). This way you will get the best experience in mobile devices.

How can I override the layout of "ACF - Vimeo" custom field?

To override the "ACF - Vimeo" custom field, read here: How to override the "ACF - Vimeo" custom field.