@bbc/gs-sass-tools-webpack

Grandstand Sass Tools

A collection of common Sass variables, functions and mixins.
Forms part of BBC Grandstand

What is this?

Grandstand Sass Tools is a collection of common Sass variables, functions and mixins.

This library is built and maintained by the BBC Sport team and used by the Grandstand Framework and various components on BBC Sport website and within the BBC Live product.

Installation

Grandstand Sass Tools can be installed using Bower:

$ bower install --save gs-sass-tools

// your-app/main.scss
@import 'bower_components/gs-sass-tools/sass-tools';

GEL Foundations

Grandstand Sass Tools is built on top of the GEL Foundations of:

• GEL Sass Tools
• GEL Typography
• GEL Grid

These three libraries are automatically included as part of this library and all of there functionality is available.

For specific details on any of these libraries please refer to their individual README files.

Settings

Settings are collections of globally available variables which can be used in your apps Sass.

Global Variables

The global variables are primarily formed of the GEL Sass Tools.

Colour Palettes

A number of products colour palettes are available as Sass variables:

• Generic Colours
• Sport
• News
• MyBBC

Tools

A number of Sass Mixins & Functions are available:

• Clearfix - A simple clearfix available as a mixin
• Visibility - A mixin hide content visually, but have it available for screen readers.
• Flexbox - A collection of flexbox mixins
• Theme - A mixin to output styles scoped in a theming class

Why Grandstand?!?

This framework is named after Grandstand, a British television sport programme. Broadcast between 1958 and 2007, it was one of the BBC's longest running sports shows, alongside BBC Sports Personality of the Year.

License

The MIT License (MIT)

Copyright 2016 British Broadcasting Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.