Live example

Overlay Content is an invisible trigger layer. It has no width, columns, placement, or container settings. Each item has a trigger id (a hash fragment such as overlay-video-hosted), optional video, and HTML before/after the media. Front-end JS walks a[href*="#"], maps the fragment to overlay JSON at /apb/overlay-content/item/{id}, and opens GLightbox. Same-page hashes work; a hash on another URL navigates away. Duplicate trigger IDs last-write-wins.

Use it to open media from a hash in tabs, feature boxes, or links. It cannot be placed — it always stays in field order. Overlay JSON does not follow host moderation or language cache (see Known limitations).

Overview

APB-DOCS-COMP-OVERLAYCONTENT

Overlay Content is an invisible trigger layer. It has no width, columns, placement, or container settings. Each item has a trigger id (a hash fragment such as overlay-video-hosted), optional video, and HTML before/after the media. Front-end JS walks a[href*="#"], maps the fragment to overlay JSON at /apb/overlay-content/item/{id}, and opens GLightbox. Same-page hashes work; a hash on another URL navigates away. Duplicate trigger IDs last-write-wins.

Use it to open media from a hash in tabs, feature boxes, or links. It cannot be placed — it always stays in field order. Overlay JSON does not follow host moderation or language cache (see Known limitations).

Adding the component

Click Add Overlay Content. Add items with a unique trigger id matching hashes on this page. Link to #your-trigger-id from other components. Save. There is no Config row for width or placement.

Component configuration

Parent bundle apb_pb_overlay_content (Overlay Content). Shared fields (section title, placement, width, custom class, intro, container settings, access control) are documented once. Component-specific fields are listed in full from the live Field API dump dated 2026-09-03T03:15:35+00:00.

This component has no container-settings plugin. There is no padding/margin/border/background JSON on the parent.

FieldLabelTypeRequiredAccepted valuesDefaultNotes
field_apb_section_titleSection TitlestringnoemptyShared. See Shared settings.
field_apb_overlay_content_itemsOverlay Content Itemsentity_reference_revisionsnoentity: paragraph (apb_pi_overlay_video)empty

Component items

APB Overlay Video Items apb_pi_overlay_video

FieldLabelTypeRequiredAccepted valuesDefaultNotes
field_apb_pi_trigger_idTrigger ID (without the '#' symbol)stringyesempty<ul> <li><strong>Please add an ID for this content, avoiding special characters and spaces.</strong></li> <li>You can use '-' or '_' when creating the ID. For example: "about-us-video"</li> <li><strong>Then, create a link and point to this ID. </strong></li> <li>Remember to include the '#' symbol before the ID when creating the link.</li> </ul>
field_apb_pi_titleTitlestringyesempty
field_apb_pi_videoOverlay Videoentity_referencenoentity: media (remote_video, video)empty
field_apb_pi_bodyText Beforetext_longnoempty
field_apb_pi_body2Text Aftertext_longnoempty
statusPublishedbooleanno[{"value":true}]

Examples

Live working examples are on the demo site. Open https://demo.apb.aero.net/components/overlay-content for configurations of this component. That page links back here as View documentation.

Related documentation