Library for quickly applying rich interaction patterns without the need to write any JavaScript.
JavaScript HTML CSS Other
Latest commit 56ae2a1 Aug 14, 2018
Permalink
Failed to load latest commit information.
_sass pat-datetime-picker: Add new pattern for setting the date and time. May 23, 2018
docs Fix some typos Nov 10, 2015
push a bit nicer Jul 20, 2018
src Merge pull request #615 from Patternslib/really-abort-push Aug 8, 2018
style Improve pat-autosuggest so that inputs with a max selection size show… Jul 6, 2018
tests Add a parseTime util function Jan 3, 2018
webpack Fix babel transpiler Aug 14, 2018
.DS_Store Basic test case Oct 20, 2016
.editorconfig More editorconfig rules Aug 31, 2017
.gitattributes vip renames: rename upgrade guide and changes to meet conventions. Sep 14, 2017
.gitignore rebase afterwork May 23, 2018
.travis.yml try same travis as I have locally Dec 1, 2017
CHANGES.md logmessage Aug 14, 2018
CONTRIBUTING.md Tweak contrib doc Apr 24, 2014
Gemfile Add Sass files and a Makefile step. Apr 22, 2015
LICENSE.txt Add package metadata. Jan 19, 2012
Makefile add a push example Jul 18, 2018
README.md Makefile: with the ``clean`` target, also remove the ``stamp-bundler`… May 23, 2018
RELEASE.md vip renames: rename upgrade guide and changes to meet conventions. Sep 14, 2017
ROADMAP.md update docs Nov 23, 2017
UPGRADE-2-TO-3.md vip renames: rename upgrade guide and changes to meet conventions. Sep 14, 2017
VERSION.txt bump Jul 13, 2018
index.html adding support to send desktop notifications Jul 19, 2018
jshintrc Stop enforcing the double quotes rule. Apr 15, 2015
jshintrc-tests pat-inject: next-href wasn't working as advertised. Apr 21, 2016
package-lock.json Extended preferences pane Jul 18, 2018
package.json unfortunately I committed to master, fixing Aug 14, 2018
test_requires.js WIP Aug 30, 2017

README.md

Patterns

Build Status

Patterns is a toolkit that enables designers to build rich interactive prototypes without the need for writing any JavaScript. All events are triggered by classes and other attributes in the HTML, without abusing the HTML as a programming language. Accessibility, SEO and well structured HTML are core values of Patterns.

Browser support

Patterns aims to support at least the two latest major versions of all popular browsers.

Currently that means:

  • Apple Safari 5+
  • Google Chrome 30+
  • Microsoft Internet Explorer 9+

Other browser version may work too, but are not actively tested against.

Installation

git clone git://github.com/Patternslib/Patterns.git
cd Patterns
make

This will generate a bundle.js file which contains Patterns and all its dependencies.

Alternatively, you can download a bundle at patternslib.com.

Layout

The individual patterns are located in their own folders in ./src/pat/.

Each pattern folder contains some or all of the following files:

  • index.html which contains HTML markup that shows a demonstration of the pattern.
  • documentation.md which is a Markdown file that documents the pattern's purpose, how to use it and how to configure it.
  • A javascript file which implements the pattern's functionality.
  • A Sass (.scss) file which provides the CSS associated with the pattern.

To generate CSS files from the pattern's included Sass files, type make all_css and the css files will be generated in the same location as the Sass files.

You'll need to have a Sass compiler installed.

How to demo patterns

To demo the patterns, simply type make serve to install the necessary dependencies and to start a simple Node.js HTTP server.

You can then visit http://localhost:4001 to see a site with demos.

Alternatively, patterns can also be demoed through the Patternslib.com website, which is open-source. The code and setup instructions are here.

Contributing fixes

To develop on Patterns, clone the repository and set it's push-url to your fork:

git remote set-url --push origin <url_to_your_fork>

Create a branch for the feature/bug you are working on:

git checkout -b <feature>

For inclusion use either a GitHub pull request or create a ticket with a url to your external repository.

Running tests

The simplest way to run the tests are to use make:

make check

This will install all required npm and bower packages and run the tests.

To run the tests in a browser, open the tests.html file in the browser of your choice.

Organisations and projects which use Patternslib

  • Overstroom ik?, a website which informs Dutch citizens of their risk of flooding. It was introduced and highly praised by the Dutch minister of infrastructure and environment, Melanie Schultz.
  • OiRA, an online risk assessment tool, created for the Occupational Health and Safety Agency (OSHA) of the European Union.
  • Staralliance uses Patternslib in their intranet.
  • Plone CMS and Plone Intranet project both use Patternslib.

Interactive HTML/CSS prototypes made with Patternslib