node package manager

seq-theme-starter-basic

Starter Basic - Sequence.js Theme

Use this blank theme to start building your own themes. Steps are stacked on top of each other so only the content will animate.

This theme is powered by Sequence.js - The responsive CSS animation framework for creating unique sliders, presentations, banners, and other step-based applications.

Theme URL: http://sequencejs.com/themes/starter-basic/

Author: Ian Lunn - GitHub | Twitter | Email

Getting Started

To add a Sequence.js theme to your web page, complete the following:

  1. Download and unzip your theme
  2. Move the starter-basic folder to the same folder as the page you'd like the Sequence.js theme to appear on
  3. Add the theme's stylesheet within the <head></head> tags on your page, below existing stylesheets. For example:
<link rel="stylesheet" href="starter-basic/css/sequence-theme.starter-basic.css" />
  1. From starter-basic/index.html, copy everything inside the <body></body> tags, then paste into the page you'd like the theme to appear on.
  2. From starter-basic/index.html, copy any <script></script> elements found toward the bottom of the page and paste just before the closing </body> tag. This should include a reference to the Sequence.js library, its third-party dependencies, and the theme's options, for example:
<script src="starter-basic/scripts/imagesloaded.pkgd.min.js"></script>
<script src="starter-basic/scripts/hammer.min.js"></script>
<script src="starter-basic/scripts/sequence.min.js"></script>
<script src="starter-basic/scripts/sequence-theme.starter-basic.js"></script>
  1. Save your file and view in the browser. You're done!

Customizing a Theme

To customize how a theme behaves, its Sequence.js options can be changed in starter-basic/scripts/sequence-theme.starter-basic.js. See Options in the documentation.

To customize how a theme looks and how its step's transition, refer to the theme's stylesheet: starter-basic/css/sequence-theme.starter-basic.css.

It is recommended to read Setting Up a Theme in the documentation for an overview of how transitions are applied to Sequence.js steps.

Using Grunt.js to Develop a Theme

If you are familiar with Grunt.js, you can use it to automate common development tasks. This however is optional and isn't required for a theme to work.

Sequence.js and the themes it powers use Grunt.js to automate useful tasks. With Grunt.js installed (see Grunt.js' Getting Started), use the following command to install this theme's development dependencies:

npm install

Once development dependencies have installed you can use the commands grunt serve and grunt.

grunt serve

This command will start a development environment with the following automated tasks:

  • Starts a livereload session that will reload your browser whenever a file is changed (be sure to install livereload)
  • Opens your browser and navigates to http://localhost:8000/
  • Sets up a watch task to run the following sub-tasks:
    • Update the version number of the following files when changed in package.json:
      • scripts/sequence-theme.starter-basic.js
      • scss/sequence-theme.starter-basic.scss
      • css/sequence-theme.starter-basic.css
      • bower.json
    • Process any .scss files found in the scss directory, autoprefix them and then copy to css and minify
    • Refresh the browser when any changes are made in HTML, JS, CSS, or SCSS files

You only need to run grunt serve per each development session as the watch task will continue to operate as you modify files.

grunt

The grunt command is a manual version of the watch sub tasks listed for the grunt serve command.

Theme License

This theme is made available under a GPLv3 license.

Copyright © 2015 Ian Lunn Design Limited

Sequence.js License

This theme is powered by Sequence.js. Sequence.js is made available under the following licenses where applicable: