Block Type Video Carousel - NCIOCPL/cgov-digital-platform GitHub Wiki

A set of related videos put together in one collection that can be added to a page.

Properties

  • Display Name: Video Carousel
  • Machine-readable Name: cgov_video_carousel

Additional Behaviors

Fields

Title (Block Description)

Need details ❓ ❓ ❓

  • Field Name:
  • Label: Block description
  • Type: Text
  • Required: Yes
  • Tooltip Text: A brief description of your block.
  • Translatable:
  • Cardinality: 1

Youtube Playlist ID

  • Field Name: field_carousel_video
  • Label: Youtube Playlist ID
  • Type: link (to youtube)
  • Required: Yes
  • Tooltip Text: Add a valid youtube playlist ID
  • Translatable: yes
  • Cardinality: 1

FUTURE REQUIREMENTS (When we build a content type)

Common Fields

Local Fields

YouTube Playlist ID

  • Field Name: field_youtube_playlist_id
  • Label: YouTube Playlist ID
  • Type: Text (plain)
  • Required: Yes
  • Max Characters: 100
  • Translatable:

Form Display Order

How the fields should display on the form:

  • Language Dropdown
  • Site Section
  • Pretty URL
  • Page Title
  • Short Title
  • Browser Title
  • Card Title
  • Meta Description
  • List Description
  • Feature Card Description
  • YouTube Playlist ID
  • Body
  • Posted Date
  • Updated Date
  • Reviewed Date
  • Date Display Mode
  • Related Resources
  • Search Engine Restrictions

Example URLs

Front-end Display Rules/Requirements:

  • Video carousel will be centered when added to a page
  • Video carousel will display thumbnail images for every video, and the page title for each video
  • Users select the thumbnail image for the video to load a selected video within the player window for the carousel
  • The carousel should have a number that displays, letting users know how many videos are in the carousel (only where there are more than 3 videos in the carousel).
  • When the page loads, the carousel should always default to the first video in the carousel
  • The carousel will allow users to click arrows to navigate between the videos (when there are more than 3 videos)
  • The carousel rotates on a loop:
    • If the user is on the first video, and clicks left, the user will be able to go to the last video in the carousel
    • If the user is on the last video, and clicks right, the user will be able to go to the first video in the carousel
⚠️ **GitHub.com Fallback** ⚠️