Skip to content
This repository has been archived by the owner on Jan 6, 2020. It is now read-only.

Home

Jump to bottom
Jon Roobottom edited this page Jan 4, 2016 · 10 revisions

Welcome to the Firefly pattern library documentation.

What is the pattern library?

The pattern library is a self-contained project written in node js. It allows us to break front end code into small reusable chunks. We call these chunks patterns or blocks. These two terms are interchangeable; they both mean the same thing.

Blocks can be written in either as .xsl (XSLT) or .rt (Angular) templates.

A Gulp process is then used to build the blocks. The pattern library comes complete with its own web interface to view and test the blocks. It will also package blocks and assets for use in Firefly.

Essentially, the pattern library is an attempt to introduce one source of truth for all front-end code within Firefly. This isn't quite the case, as we'll see later on, but a noble cause I'm sure you'll agree!

Table of Contents

  1. Types of pattern (aka Blocks)
  2. Folder Setup
  3. Gulp commands
  4. Writing a pattern (aka Block)
  5. Wiring a pattern into Firefly
  6. Styling
  7. Branches
Clone this wiki locally