https://github.com/bbc/gs-sass-tools
A collection of Sass variables, functions and mixins, part of BBC Grandstand
https://github.com/bbc/gs-sass-tools
Last synced: 4 months ago
JSON representation
A collection of Sass variables, functions and mixins, part of BBC Grandstand
- Host: GitHub
- URL: https://github.com/bbc/gs-sass-tools
- Owner: bbc
- License: mit
- Created: 2015-07-13T12:39:57.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-06-04T14:47:36.000Z (over 5 years ago)
- Last Synced: 2025-06-17T03:03:14.698Z (7 months ago)
- Language: CSS
- Homepage: https://bbc.github.io/grandstand/
- Size: 67.4 KB
- Stars: 16
- Watchers: 144
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
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](http://bbc.github.io/bbc-grandstand/) and various components on BBC Sport website and within the BBC Live product.
## Install using NPM (v6 and above)
```bash
$ npm install --save gs-sass-tools
```
```sass
// your-app/main.scss
@import 'node_modules/gs-sass-tools/sass-tools';
```
## Install using Bower (v5 and below)
```bash
$ bower install --save gs-sass-tools
```
```sass
// 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](https://github.com/bbc/gel-sass-tools)
- [GEL Typography](https://github.com/bbc/gel-typography)
- [GEL Grid](https://github.com/bbc/gel-grid)
These three libraries are automatically included as part of this library and all of their 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 app's SCSS files.
### Global Variables
The global variables are primarily formed of the [GEL Sass Tools](https://github.com/bbc/gel-sass-tools).
### Colour Palettes
A number of products colour palettes are available as Sass variables:
- [Generic Colours](https://github.com/bbc/gs-sass-tools/blob/master/settings/_generic-colours.scss)
- [Sport](https://github.com/bbc/gs-sass-tools/blob/master/settings/_sport-colours.scss)
- [News](https://github.com/bbc/gs-sass-tools/blob/master/settings/_news-colours.scss)
- [MyBBC](https://github.com/bbc/gs-sass-tools/blob/master/settings/_mybbc-colours.scss)
- [Newsround](https://github.com/bbc/gs-sass-tools/blob/master/settings/_newsround-colours.scss)
## Tools
A number of Sass Mixins & Functions are available:
- [Clearfix](https://github.com/bbc/gs-sass-tools/blob/master/tools/_clearfix.scss) - A simple `clearfix` available as a mixin
- [Visibility](https://github.com/bbc/gs-sass-tools/blob/master/tools/_visability.scss) - A mixin hide content visually, but have it available for screen readers.
- [Flexbox](https://github.com/bbc/gs-sass-tools/blob/master/tools/_flexbox.scss) - A collection of `flexbox` mixins
- [Theme](https://github.com/bbc/gs-sass-tools/blob/master/tools/_theme.scss) - A mixin to output styles scoped in a theming class
## Why Grandstand?!?
This framework is named after [Grandstand](https://www.youtube.com/watch?v=HLHMxFGqhIs), 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.