Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 4.26 KB

README.md

File metadata and controls

60 lines (40 loc) · 4.26 KB
Raw

Colours Build Status

This is an Origami module that provides variables to define the FT digital colour palette.

Usage

Install the module or use the build service to load it into your page. If you install the module, you should use it via the oColorsGetColorFor function:

.mything {
	color: oColorsGetColorFor(article-life-arts-body article-body body, text);
}

The oColorsGetColorFor function takes two arguments:

  • Use case list: a list of colour use cases in order of preference. The first one that is defined will be returned (similar behaivour to the CSS font-family property)
  • Property: The property that you want to use the colour for (background, border, or text)

Alternatively, you may extend placeholder classes:

.mything {
	@extend %o-colors-article-body-text;
}

Finally, if the module is configured to be noisy, you may use concrete classes directly in your HTML (not recommended, except for prototypes and demos):

<p class='o-colors-article-body-text'>Article text</p>

If you load the module via the build service, it will be configured to be noisy automatically.

Silent configuration

This module support silent use, in which it will output no concrete selectors, only mixins, functions and placeholders. You can then use these in your own CSS to import only the elements of the module that you need. This is recommended, and can be configured by setting the following variable before the import in your SASS:

$o-colors-is-silent: true;

Development

Instructions for maintaining the color palette for non-developers:

Getting started

  1. If you don't already have an account on GitHub, get one by filling in the big registration form on the homepage of GitHub.com.
  2. If you do not already have commit rights on this module, ask one of the FT's GitHub administrators to give you access.
  3. If you haven't already got the GitHub app installed on your computer, download it for Windows or for mac.
  4. Run the Github app on your computer and sign in using your GitHub account
  5. Clone the o-colors project to your computer (GitHub will ask you where you want to put it on your system; it's a good idea to have a folder in which you keep all your repos, so if in doubt, create a folder called sandboxes in your home directory and clone the module there)

Making a change

  1. Open the GitHub app, go into the o-colors module and click the 'Branches' tab.
  2. Create a new branch by clicking the + icon at the right end of the master branch, and name it after your proposed change (using just letters, numbers and underscores) eg forms_use_cases.
  3. Make sure your new branch is ticked, if not, double click it.
  4. Open the file you want to edit (created by Github on your computer) in a text editor such as Sublime Text or Brackets (don't just double click the file unless you've set up one of these editors to open .scss files by default)
    • If you want to add or remove palette colours, the file you want is src/scss/palette.scss
    • If you want to add or remove use cases for colours, the file you want is src/scss/use-cases.scss
  5. Edit the file, following the instructions in the comments at the top of the file
  6. Switch back to the Github app and click the 'Changes' tab. Verify that it says 'committing to ' and that the list shows the files with the changes you made.
  7. Type a description of your change, and press 'Commit & Sync'
  8. Load the GitHub website page for this module. If you're logged in, there should be a 'You recently pushed branches' label, and a button to 'Compare and pull request'. Click that button.
  9. Modify your description, if you wish, and click 'Send pull request'. GitHub will now run automated tests on your commit to ensure that the module still works correctly. The pull request should not be merged until it shows "All is well — The Travis CI build passed".