Skip to content

Cross-cutting video-components usage guide #2432

Description

@catortora

Description

Findings in #2131 showed that authors were using sub-optimal components to embed video, while the components better suited to the task (including for accessibility) had no usage. This suggests authors would benefit from a single place telling them which video-related component or pattern to use for a given case, before they land on a specific component page.

This ticket proposes a single guide that routes each video-related use case to the right destination:

  • embedding a videovf-video (#2145)
  • embedding other content (map, form, slides, audio) → vf-embed (#2130)
  • thumbnails linking to videos hosted elsewhere → vf-video-teaser, which is not a player (#2411)
  • a video-section layout → a grid (embl-grid / vf-grid), rather than vf-video-container (#2410)

Guidance is written in recommendation style, not as a restriction, consistent with the per-component tickets. This includes the caveat that vf-video is not available in the WordPress version of VF.

Note

Deprecation is under discussion, not decided. vf-video-container and vf-video-teaser are candidates for deprecation, pending defined criteria. This guide does not pre-empt that decision; it documents the components as they exist today, so authors are not left without guidance while the discussion is open, and does not announce a deprecation.

Success criteria

  • A proposed general video-components guide routing each use case to the right component or pattern
  • The guide gives a recommended approach an author can follow without reading each component page
  • The guide is consistent with the four per-component tickets (#2130, #2145, #2410, #2411), with no conflicting advice
  • Guidance is suggestive, not prescriptive, and carries the WordPress caveat
  • The guide does not state or imply any component is deprecated

Definition of Done

  • "Which video component?" guide drafted
  • Recommended approach covers the four components and the grid alternative
  • Cross-checked against the four per-component tickets for consistency
  • Reviewed by UX/dev

Note: This guide summarises the four per-component drafts, so it should be finalised after they are agreed.

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