@aurodesignsystem/webcorestylesheets v8.1.1

WC Style Sheets

WC Style Sheets(WCSS) is a responsive, mobile-first collection of styles and tools designed to make it quick and simple for developers to create web experiences using the Auro Design Language.

What's included

This repository is a library of core level styles, functions, and mixins that can be used for consistent front-end UI development. This will include full descriptions of CSS selectors, mixins and any other supporting functions or tools.

Documentation

Please see the documentation site for all information related to WC Style Sheets.

Design tokens and legacy component support

Upgrading to WCSS v5.x requires @aurodesignsystem/design-tokens@4.x.

When upgrading your project it may be required to also retain @aurodesignsystem/design-tokens@v3.15.5 in order to support Auro custom elements have not been updated to support the new design token naming convention.

Please also see Auro design tokens migration from 3.x to 4.x for additional information.

Install

Pre-processed bundled resources

At a limited scale, some files have been pre-processed to CSS so that it can be delivered via CDN and used in environments where this rendered resource is required.

API Note: First supporting version v2.9.0

NOTICE! Use @latest at your own risk. This will not restrict updates and will allow instant access to MAJOR releases that will contain BREAKING CHANGES. You have been warned!

Using the files in Sass from npm resource

$ npm i @aurodesignsystem/webcorestylesheets

There are no core files to import, rather WCSS is an à la carte solution allowing for users to import what they want and when they want it. In most cases you can simply import the Sass file as illustrated below:

@import "./../node_modules/@aurodesignsystem/webcorestylesheets/src/ ... ";

Multi-Theme Support

WebCoreStyleSheets provides multi-theme support for various brands in the Alaska Air Group. Each theme includes its own font definitions and styling.

Available Themes

For more information on the available themes and how to use them, please see the Auro Design Tokens documentation.

Using a Theme

To use a specific theme in your project, import the corresponding theme file.

For example:

/* Alaska Airlines theme (Auro default) */
@import "./../node_modules/@aurodesignsystem/webcorestylesheets/src/essentials-as";

Additional themes are available in the src directory.

Bundled Theme Resources

Each theme also has a bundled version in the dist/bundles directory that includes essentials for quick implementation:

For example:

/* Alaska Airlines theme (Auro default) */
dist/bundles/essentials-as.css

Development

To develop against WCSS run both npm run watch and npm run serve in separate terminals.

The watch command will run a Sass linter, process a test file from Sass to CSS and run a post CSS linter. This will ensure the quality of all new Sass added to the repo.

If additional selectors or scenarios are needed, please update the ./scripts/testBuild.scss file to test your code.

Running the serve command will open the Sassdoc view. Please review all changes as Sassdoc produces all documentation.