#
Embed
The embed
component helps with content embedding.
The embed component syntax is similar to many other Retype components. The !embed
keyword is used to specify the component and a link to the resource is included.
[!embed](link)
The link is the full URL to the embedded resource. For instance, embeding a YouTube or Vimeo video would require the following component syntax:
[!embed](https://www.youtube.com/embed/C0DPdy98e4c)
The above Retype component would render as follows:
The following options allow for customization of the embed component.
#
AllowFullScreen
Typically, this attribute is used by embeded videos, such as a YouTube or Vimeo, to enable the Full screen button.
The default value of allowFullScreen
is true
. Setting to false
will remove or disable the full screen button.
You do not need to explicitly enable the full screen option for videos. By default, the button will be enabled when a Retype [!embed]
component is used.
[!embed](https://www.youtube.com/embed/C0DPdy98e4c)
To explicitly remove or disable the full screen option, include allowFullScreen="false"
in your [!embed]
component configuration.
[!embed allowFullScreen="false"](https://www.youtube.com/embed/C0DPdy98e4c)
#
Aspect
Specifies the video's pixel aspect ratio.
[!embed aspect="4:3"](https://www.youtube.com/embed/C0DPdy98e4c)
The setting accepts a number of keyword values according to the list below, each reflecting the embedded area's aspect ratio:
#
El
Specifies which HTML element should be used to wrap the embedded content.
[!embed el="embed"](https://www.youtube.com/embed/C0DPdy98e4c)
The setting accepts a number of keyword values according to the list below, each resembling its respective HTML tag in the rendered page:
#
Height
Specifies a height for the embedded content's area.
[!embed height="120"](https://www.youtube.com/embed/C0DPdy98e4c)
#
Text
Adds a caption to the embedded content.
[!embed text="Test Video"](https://www.youtube.com/embed/C0DPdy98e4c)
#
Width
Specifies a width for the embedded content's area.
[!embed width="300"](https://www.youtube.com/embed/C0DPdy98e4c)