Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 1.79 KB

README.md

File metadata and controls

43 lines (33 loc) · 1.79 KB

Vimeography Blueprint

A collection of common Vue components + modules to use within Vimeography 2 themes.

Layout Template

Vimeography uses several different conventions to keep themes consistent and easier to debug:

  • All themes use Vue single-file components for templating.
  • Any images unique to a theme should be placed inside assets/images
  • Any javascript plugins unique to a theme should be placed inside assets/scripts
  • All themes must use Vimeo's responsive parameter to provide support for responsive videos.
  • We recommend themes use Swiper 4 for any slideshow presentations.
  • We recommend themes use vue-js-modal for any galleries using a modal window.
  • Themes must be encapsulated in a class containing the theme name, which defines a unique namespace for the gallery.

Available Video Data

All of the possible values to use can be found at this playground example

These are some of the more common parameters:

Parameter Description
name Name of the video
uri Video resource
link Video link
description The description of the video
duration The duration of the video
tags The description of the video
created_time The date that the video was uploaded
stats An object containing video stats
pictures Any pictures uploaded along with the video

Example DOM Structure

  • #vimeography-gallery-{{gallery_id}}.vimeography-theme-[your-theme-name]
    • .vimeography-main

      • .vimeography-player
      • .vimeography-info
    • .vimeography-thumbnails

      • .vimeography-thumbnail-container
        • .vimeography-thumbnail