storytime.js

A Javscript library that helps you create a story

Storytime.js in its present state uses the lodash library as a dependency and is included as part of the library.

Install via bower

  bower install storytime

Here is an example of the library

Option Properties

startBtn:

Specify your start button for storytime. This is primarily for mobile support.

parentBtn:

This adds the custom built start button for mobile support to a parent.

parent:

This is adds the storytime html properties to the parent element of your choice

uniqClass:

This adds a class of your choice to each html element that is created with the story elements

styling:

This adds styling of your choice to each html element that is created with the story elements

skrollr:

This is a boolean. Set to true if you are inheriting skrollr; Skrollr support has not been added yet.

skrollrConf:

Pass skroll options as an object through this property; Skrollr support has not been added yet.

theaterJS:

This is a boolean. Set to true if you are inheriting theaterJS.

How to use: Place this at the bottom of your body tag.

<script src="src/storytime.js"></script>
<script>
  var options = {
    theaterJS: true
  };
  var storyboard = {
    0: {
      media: 'This is a story. A story about storytimeJS',
      audio: 'examples/music/storytime.mp3'
    }, 
    1: {
      media: 'examples/images/03.jpg',
      audio: 'examples/music/next.mp3'
    },
    2: {
      media: 'examples/images/02.jpg',
      audio: 'examples/music/saymyname.mp3'
    }
  };
  var storyTime = storytime.init(options, storyboard);
</script>

Todo:

• package.json
• Support Browser Checklist
• Mocha Test
• Implement support for clappr & mp4's
• More option properties
• Make a Pull Request!