@articulate/orson

React video component with some Articulate flavor

Stats

StarsIssuesVersionUpdatedCreatedSize
@articulate/orson
2102.3.12 months ago5 years agoMinified + gzip package size for @articulate/orson in KB

Readme

Orson

An Articulate flavored React component video player.

Install

npm install @articulate/orson

Usage

Import the stylesheets

<link rel="stylesheet" src="/path/to/videojs.css" />
<link rel="stylesheet" src="node_modules/@articulate/orson/dist/VideoPlayer.css" />

or, if using webpack and sass-loader on your project

@import "~@articulate/orson/lib/index.webpack";

Import VideoPlayer into your component.

import VideoPlayer from '@articulate/orson';

<VideoPlayer>
  <source src="__path_to_mp4__" type="video/mp4" />
  <source src="__path_to_format__" type="video/format" />
  <p>
    Custom Error Message
  </p>
</VideoPlayer>

API

Props

  • aspectRatio (number, default: 9/16) Desired ratio between width and height.
  • fullWidthAt (number) Specifies a screen breakpoint under which the player will try to use the entire width of the parent.
  • options (object) Options passed to video.js (see reference)

Methods

You'll need to capture a ref to the VideoPlayer instance for this.

  • .setDimensions() calculates and sets the ideal dimensions for the video player.
  • .snapshot() creates a base64 image of the video in png.

Properties

You'll need to capture a ref to the VideoPlayer instance for this.

Upgrading to 1.0.

The following steps need to be performed if using a version pre-1.0

  1. Remove webpack configuration for this plugin. This plugin used to require setting up exceptions in webpack's config loaders section, which is no longer needed.
  2. Import the CSS. Previously, stylesheets would be imported automatically with sass-loader. That's no longer the case.
  3. Change imports from import VideoPlayer from '@articulate/orson/lib/VideoPlayer' to import VideoPlayer from '@articulate/orson'

A11y Contrast Updates

A number of changes have been made to the styling of the player to clear up some reported contrast concerns. These changes resolve a number of contrast concerns by doing the following:

  • Increase the opacity of the various control container.
  • Create a distinguishable edge between interactive controls and content
  • Provide a darker background, with increasing the lightness of the icons, to match a 3:1 contrast ratio
  • Replaces the text-shadow on focus/hover with a control edge glow that defines the edge of the control.

In order to allow for continued updates to the player, these changes are opt-in by default. The player will only apply these changes when the player is contained within an element, classed with the .video-a11y class:

import VideoPlayer from '@articulate/orson';

<div className="video-a11y">
  <VideoPlayer>
    <source src="__path_to_mp4__" type="video/mp4" />
    <source src="__path_to_format__" type="video/format" />
    <p>
      Custom Error Message
    </p>
  </VideoPlayer>
<div>

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.