Skip to content

Commit

Permalink
refactor(namespace): change to aurodesignsystem namespace
Browse files Browse the repository at this point in the history
BREAKING CHANGE: This commit updates the npm namespace.
  • Loading branch information
jason-capsule42 committed Jun 8, 2022
1 parent db8abb3 commit 9a2d7a4
Show file tree
Hide file tree
Showing 38 changed files with 2,111 additions and 2,087 deletions.
2 changes: 1 addition & 1 deletion FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you have been using selectors from the now deprecated `_layoutProperties.scss
The easy fix is to import the new layout properties generator file that will fill this gap.

```scss
@import "./node_modules/@alaskaairux/webcorestylesheets/dist/utilityMixins/layoutPropertiesGenerator";
@import "./node_modules/@aurodesignsystem/webcorestylesheets/dist/utilityMixins/layoutPropertiesGenerator";
```

For full details on this generator, please see the [generator documentation](https://alaskaairlines.github.io/OrionWebCoreStyleSheets/#utility-layout-mixin-auro_layoutPropertiesGenerator).
6 changes: 3 additions & 3 deletions FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ When supporting legacy UIs there may be issues with importing a Sass file and it

```scss
$scope: true;
@import "~@alaskaairux/webcorestylesheets/dist/ ... "
@import "~@aurodesignsystem/webcorestylesheets/dist/ ... "
```

This setting will result in the following CSS selectors
Expand All @@ -28,7 +28,7 @@ To enable prefixing simply set the `$prefix` variable to be `true` before import

```scss
$prefix: true;
@import "~@alaskaairux/webcorestylesheets/dist/ ... "
@import "~@aurodesignsystem/webcorestylesheets/dist/ ... "
```

This setting will result in the following CSS selectors
Expand All @@ -47,7 +47,7 @@ If needed, both `$scope` and `prefix` can work in tandem. To enable, simply set
```scss
$scope: true;
$prefix: true;
@import "~@alaskaairux/webcorestylesheets/dist/ ... "
@import "~@aurodesignsystem/webcorestylesheets/dist/ ... "
```

This setting will result in the following CSS selectors
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,29 @@ Please see the [documentation site](https://alaskaairlines.github.io/WebCoreStyl
## Install

[![Build Status](https://img.shields.io/github/workflow/status/AlaskaAirlines/webcorestylesheets/Test%20and%20publish?branch=master&style=for-the-badge)](https://github.com/AlaskaAirlines/webcorestylesheets/actions?query=workflow%3A%22test+and+publish%22)
[![See it on NPM!](https://img.shields.io/npm/v/@alaskaairux/webcorestylesheets.svg?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@alaskaairux/WebCoreStyleSheets)
[![License](https://img.shields.io/npm/l/@alaskaairux/webcorestylesheets.svg?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/webcorestylesheets.svg?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/webcorestyleSheets)
[![License](https://img.shields.io/npm/l/@aurodesignsystem/webcorestylesheets.svg?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
[![issues](https://img.shields.io/github/issues-raw/AlaskaAirlines/WebCoreStyleSheets?style=for-the-badge)](https://github.com/AlaskaAirlines/WebCoreStyleSheets/issues)

```bash
$ npm i @alaskaairux/webcorestylesheets
$ npm i @aurodesignsystem/webcorestylesheets
```

### Using the files in Sass

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:

```scss
@import "~@alaskaairux/webcorestylesheets/dist/ ... "
@import "~@aurodesignsystem/webcorestylesheets/dist/ ... "
```

### Tokens Dependency

WCSS uses Sass and has a dependency on the `SCSSVariables.scss` file from [Design Tokens](https://github.com/AlaskaAirlines/OrionDesignTokens) package. This reference needs to be imported before any reference of a WCSS partial.

```scss
@import "~@alaskaairux/design-tokens/dist/tokens/SCSSVariables";
@import "~@alaskaairux/webcorestylesheets/dist/ ... ";
@import "~@aurodesignsystem/design-tokens/dist/tokens/SCSSVariables";
@import "~@aurodesignsystem/webcorestylesheets/dist/ ... ";
```

### Install the essentials
Expand Down Expand Up @@ -82,8 +82,8 @@ unpkg.com/:package@:version/:file

| resource | supports | CDN URL |
|---|---|---|
| essentials.scss<br>fonts.scss|Auro WCs|https://unpkg.com/@alaskaairux/webcorestylesheets@:version/dist/bundled/essentials.css|
| baseline.scss<br>fonts.scss|ODS WCs|https://unpkg.com/@alaskaairux/webcorestylesheets@:version/dist/bundled/baseline.css|
| essentials.scss<br>fonts.scss|Auro WCs|https://unpkg.com/@aurodesignsystem/webcorestylesheets@:version/dist/bundled/essentials.css|
| baseline.scss<br>fonts.scss|ODS WCs|https://unpkg.com/@aurodesignsystem/webcorestylesheets@:version/dist/bundled/baseline.css|

## Development

Expand Down
222 changes: 111 additions & 111 deletions docs/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit 9a2d7a4

Please sign in to comment.