Skip to content

[Sub-task] vf-video-container (update usage documentation) #2410

Description

@catortora

Note: This is a sub-task of #2131 [Task] Clarify the overlap in the functionalities of vf-embed, vf-video and vf-video-teaser.

Description

vf-video-container renders nothing of its own: it is a layout that arranges a section header, a vf-video and a vf-video-teaser. #2131 found no on-pattern use of it. The single instance kept the container shell and replaced its entire internal structure, and the "video with adjacent content" layouts on the reviewed sites were built by hand with vf-embed plus vf-grid instead. Both benchmarks keep layout outside the video component.

We recommend to keep this component, but update the documentation to reframe it as what it is: one specific section layout among many a page may need. Authors who need that exact arrangement can use it; authors who need a different layout should build it themselves with vf-grid or embl-grid. This is framed as a recommendation rather than prescribing one grid over the other.

Independently of that framing, #2131 identified two defects that hold as long as the component exists, which the documentation should note and which need matching code changes raised separately:

  • The declared section-title is not passed through to vf-section-header, so the author's configured value has no effect on the output.
  • The section heading level is fixed and cannot be matched to the surrounding page hierarchy (WCAG 1.3.1 A).

Success criteria

  • Reframe the documentation to present the component as one specific section layout, and direct authors needing a different layout to build it with vf-grid or embl-grid
  • Ensure the grid guidance is framed as a recommendation across embl-grid and vf-grid, not as prescribing one over the other
  • Ensure the documentation notes the section-title and fixed-heading-level defects, and raise the corresponding code changes as a technical follow-up

Definition of Done

  • Documentation created or updated
  • Documentation reframes the component as one specific layout and points to the grid for alternatives
  • Known current technical issues raised as a technical follow-up

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions