@carbon/layout 10.35.0 → 10.37.0-rc.0

package/docs/sass.md

@@ -0,0 +1,58 @@
+# Sass
+
+> Sass documentation for `@carbon/layout`
+
+## Usage
+
+The `@carbon/layout` package provides spacing tokens and conversion utilities
+for the Carbon Design System. You can access these tokens and helpers by writing
+the following:
+
+```scss
+@use '@carbon/layout';
+
+.selector {
+  margin-bottom: layout.$spacing-05;
+  width: layout.rem(24px);
+  height: layout.rem(24px);
+}
+```
+
+## API
+
+| Export              | Description | !default |
+| :------------------ | :---------- | :------- |
+| `$spacing-01`       |             | ✅       |
+| `$spacing-02`       |             | ✅       |
+| `$spacing-03`       |             | ✅       |
+| `$spacing-04`       |             | ✅       |
+| `$spacing-05`       |             | ✅       |
+| `$spacing-06`       |             | ✅       |
+| `$spacing-07`       |             | ✅       |
+| `$spacing-08`       |             | ✅       |
+| `$spacing-09`       |             | ✅       |
+| `$spacing-10`       |             | ✅       |
+| `$spacing-11`       |             | ✅       |
+| `$spacing-12`       |             | ✅       |
+| `$spacing-13`       |             | ✅       |
+| `$spacing `         |             |          |
+| `$fluid-spacing-01` |             | ✅       |
+| `$fluid-spacing-02` |             | ✅       |
+| `$fluid-spacing-03` |             | ✅       |
+| `$fluid-spacing-04` |             | ✅       |
+| `$fluid-spacing `   |             |          |
+| `@function em`      |             |          |
+| `@function rem`     |             |          |
+| `$base-font-size`   |             | ✅       |
+
+### Configuration
+
+You can configure parts of the `@carbon/layout` package that are `!default` with
+Sass Modules. For example, you can change the `$base-font-size` by writing the
+following:
+
+```scss
+@use '@carbon/layout' with (
+  $base-font-size: 18px
+);
+```

package/index.scss

@@ -5,8 +5,5 @@
 // LICENSE file in the root directory of this source tree.
 //
 
-@forward 'scss/modules/breakpoint';
 @forward 'scss/modules/convert';
 @forward 'scss/modules/spacing';
-// TODO: should these be public?
-@forward 'scss/modules/utilities';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/layout",
   "description": "Layout helpers for digital and software products using the Carbon Design System",
-  "version": "10.35.0",
+  "version": "10.37.0-rc.0",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -29,7 +29,7 @@
     "clean": "rimraf es lib umd scss/generated scss/modules/generated"
   },
   "devDependencies": {
-    "@carbon/cli": "^10.32.0",
+    "@carbon/cli": "^10.34.0-rc.0",
     "@carbon/cli-reporter": "^10.5.0",
     "@carbon/scss-generator": "^10.13.0",
     "@carbon/test-utils": "^10.21.0",
@@ -42,5 +42,5 @@
     "sassDir": "scss",
     "needs": "^1.3.0"
   },
-  "gitHead": "ac4b4bf03cf93cb8463916231619fbfdc72f0be5"
+  "gitHead": "e41618f5aaa9a10ce93edd844f1a280dc29eaf50"
 }

package/scss/_key-height.import.scss

@@ -21,8 +21,8 @@
 
 @use 'sass:meta';
 @use "sass:math";
-@import 'breakpoint'; /* stylelint-disable-line no-invalid-position-at-import-rule */
-@import 'utilities'; /* stylelint-disable-line no-invalid-position-at-import-rule */
+@import 'breakpoint';
+@import 'utilities';
 
 /// Get the column width for a given breakpoint
 /// @param {String} $breakpoint

package/scss/modules/_utilities.scss

@@ -14,7 +14,7 @@
 /// @group @carbon/layout
 @function map-deep-get($map, $keys...) {
   @each $key in $keys {
-    $map: map-get($map, $key);
+    $map: map.get($map, $key);
   }
   @return $map;
 }
@@ -26,7 +26,7 @@
 /// @return {String} Desired value
 /// @group @carbon/layout
 @function key-by-index($map, $index) {
-  $keys: map-keys($map);
+  $keys: map.keys($map);
   @return nth($keys, $index);
 }
 
@@ -36,6 +36,6 @@
 /// @return {*} Desired value
 /// @group @carbon/layout
 @function last-map-item($map) {
-  $total-length: length($map);
+  $total-length: list.length($map);
   @return map-get($map, carbon--key-by-index($map, $total-length));
 }

package/scss/modules/_breakpoint.scss

@@ -1,232 +0,0 @@
-//
-// Copyright IBM Corp. 2018, 2018
-//
-// This source code is licensed under the Apache-2.0 license found in the
-// LICENSE file in the root directory of this source tree.
-//
-
-// https://github.com/twbs/bootstrap/blob/v4-dev/scss/mixins/_breakpoints.scss
-@use 'sass:list';
-@use 'sass:map';
-@use 'sass:meta';
-@use 'convert';
-@use 'utilities';
-
-/// Carbon gutter size in rem
-/// @type Number
-/// @access public
-/// @group @carbon/layout
-$grid-gutter: convert.rem(32px);
-
-/// Carbon condensed gutter size in rem
-/// @type Number
-/// @access public
-/// @group @carbon/layout
-$grid-gutter--condensed: convert.rem(1px);
-
-// Initial map of our breakpoints and their values
-/// @type Map
-/// @access public
-/// @group @carbon/layout
-$grid-breakpoints: (
-  sm: (
-    columns: 4,
-    margin: 0,
-    width: convert.rem(320px),
-  ),
-  md: (
-    columns: 8,
-    margin: convert.rem(16px),
-    width: convert.rem(672px),
-  ),
-  lg: (
-    columns: 16,
-    margin: convert.rem(16px),
-    width: convert.rem(1056px),
-  ),
-  xlg: (
-    columns: 16,
-    margin: convert.rem(16px),
-    width: convert.rem(1312px),
-  ),
-  max: (
-    columns: 16,
-    margin: convert.rem(24px),
-    width: convert.rem(1584px),
-  ),
-) !default;
-
-/// Get the value of the next breakpoint, or null for the last breakpoint
-/// @param {String} $name - The name of the breakpoint
-/// @param {Map} $breakpoints [$grid-breakpoints] - A map of breakpoints where the key is the name of the breakpoint and the value is the values for the breakpoint
-/// @param {List} $breakpoint-names [map-keys($breakpoints)] - A list of names from the `$breakpoints` map
-/// @return {String}
-/// @access public
-/// @group @carbon/layout
-@function breakpoint-next(
-  $name,
-  $breakpoints: $grid-breakpoints,
-  $breakpoint-names: map.keys($breakpoints)
-) {
-  $n: list.index($breakpoint-names, $name);
-  @if $n != null and $n < list.length($breakpoint-names) {
-    @return list.nth($breakpoint-names, $n + 1);
-  }
-  @return null;
-}
-
-/// Get the value of the previous breakpoint, or null for the first breakpoint
-/// @param {String} $name - The name of the breakpoint
-/// @param {Map} $breakpoints [$grid-breakpoints] - A map of breakpoints where the key is the name of the breakpoint and the value is the values for the breakpoint
-/// @param {List} $breakpoint-names [map-keys($breakpoints)] - A list of names from the `$breakpoints` map
-/// @return {String}
-/// @access public
-/// @group @carbon/layout
-@function breakpoint-prev(
-  $name,
-  $breakpoints: $grid-breakpoints,
-  $breakpoint-names: map.keys($breakpoints)
-) {
-  $n: list.index($breakpoint-names, $name);
-  @if $n != null and $n > 1 {
-    @return list.nth($breakpoint-names, $n - 1);
-  }
-  @return null;
-}
-
-/// Check to see if the given breakpoint name
-/// @param {String} $name - The name of the breakpoint
-/// @param {Map} $breakpoints [$grid-breakpoints] - A map of breakpoints where the key is the name of the breakpoint and the value is the values for the breakpoint
-/// @return {Bool}
-/// @access public
-/// @group @carbon/layout
-@function is-smallest-breakpoint($name, $breakpoints: $grid-breakpoints) {
-  @return list.index(map.keys($breakpoints), $name) == 1;
-}
-
-/// Returns the largest breakpoint name
-/// @param {Map} $breakpoints [$grid-breakpoints] - A map of breakpoints where the key is the name
-/// @return {String}
-/// @access public
-/// @group @carbon/layout
-@function largest-breakpoint-name($breakpoints: $grid-breakpoints) {
-  $total-breakpoints: list.length($breakpoints);
-  @return key-by-index($breakpoints, $total-breakpoints);
-}
-
-/// Get the infix for a given breakpoint in a list of breakpoints. Useful for generating the size part in a selector, for example: `.prefix--col-sm-2`.
-/// @param {String} $name - The name of the breakpoint
-/// @return {String}
-/// @access public
-/// @group @carbon/layout
-@function breakpoint-infix($name) {
-  @return '-#{$name}';
-}
-
-/// Generate a media query from the width of the given breakpoint to infinity
-/// @param {String | Number} $name
-/// @param {Map} $breakpoints [$grid-breakpoints] - A map of breakpoints where the key is the name
-/// @content
-/// @access public
-/// @group @carbon/layout
-@mixin breakpoint-up($name, $breakpoints: $grid-breakpoints) {
-  @if meta.type-of($name) == 'number' {
-    @media (min-width: $name) {
-      @content;
-    }
-  } @else if map.has-key($breakpoints, $name) {
-    $breakpoint: map.get($breakpoints, $name);
-    $width: map.get($breakpoint, width);
-    @if is-smallest-breakpoint($name, $breakpoints) {
-      @content;
-    } @else {
-      @media (min-width: $width) {
-        @content;
-      }
-    }
-  } @else {
-    @error 'Unable to find a breakpoint with name `#{$name}`. Expected one of: (#{map.keys($breakpoints)})';
-  }
-}
-
-/// Generate a media query for the maximum width of the given styles
-/// @param {String | Number} $name
-/// @param {Map} $breakpoints [$grid-breakpoints] - A map of breakpoints where the key is the name
-/// @content
-/// @access public
-/// @group @carbon/layout
-@mixin breakpoint-down($name, $breakpoints: $grid-breakpoints) {
-  @if meta.type-of($name) == 'number' {
-    @media (max-width: $name) {
-      @content;
-    }
-  } @else if map.has-key($breakpoints, $name) {
-    // We borrow this logic from bootstrap for specifying the value of the
-    // max-width. The maximum width is calculated by finding the breakpoint and
-    // subtracting .02 from its value. This value is used instead of .01 to
-    // avoid rounding issues in Safari
-    // https://github.com/twbs/bootstrap/blob/c5b1919deaf5393fcca9e9b9d7ce9c338160d99d/scss/mixins/_breakpoints.scss#L34-L46
-    $breakpoint: map.get($breakpoints, $name);
-    $width: map.get($breakpoint, width) - 0.02;
-    @media (max-width: $width) {
-      @content;
-    }
-  } @else {
-    @error 'Unable to find a breakpoint with name `#{$name}`. Expected one of: (#{map.keys($breakpoints)})';
-  }
-}
-
-/// Generate a media query for the range between the lower and upper breakpoints
-/// @param {String | Number} $lower
-/// @param {String | Number} $upper
-/// @param {Map} $breakpoints [$grid-breakpoints] - A map of breakpoints where the key is the name
-/// @content
-/// @access public
-/// @group @carbon/layout
-@mixin breakpoint-between($lower, $upper, $breakpoints: $grid-breakpoints) {
-  $is-number-lower: meta.type-of($lower) == 'number';
-  $is-number-upper: meta.type-of($upper) == 'number';
-  $min: if($is-number-lower, $lower, map.get($breakpoints, $lower));
-  $max: if($is-number-upper, $upper, map.get($breakpoints, $upper));
-
-  @if $min and $max {
-    $min-width: if(not $is-number-lower and $min, map.get($min, width), $min);
-    $max-width: if(not $is-number-upper and $max, map.get($max, width), $max);
-    @media (min-width: $min-width) and (max-width: $max-width) {
-      @content;
-    }
-  } @else if $min != null and $max == null {
-    @include breakpoint-up($lower) {
-      @content;
-    }
-  } @else if $min == null and $max != null {
-    @include breakpoint-down($upper) {
-      @content;
-    }
-  } @else {
-    @error 'Unable to find a breakpoint to satisfy: (#{$lower},#{$upper}). Expected both to be one of (#{map.keys($breakpoints)}).';
-  }
-}
-
-/// Generate media query for the largest breakpoint
-/// @param {Map} $breakpoints [$grid-breakpoints] - A map of breakpoints where the key is the name
-/// @content
-/// @access public
-/// @group @carbon/layout
-@mixin largest-breakpoint($breakpoints: $grid-breakpoints) {
-  @include breakpoint(largest-breakpoint-name()) {
-    @content;
-  }
-}
-
-/// Generate a media query for a given breakpoint
-/// @param {String | Number} $name
-/// @param {Map} $breakpoints [$grid-breakpoints] - A map of breakpoints where the key is the name
-/// @content
-/// @access public
-/// @group @carbon/layout
-@mixin breakpoint($name, $breakpoints: $grid-breakpoints) {
-  @include breakpoint-up($name, $breakpoints) {
-    @content;
-  }
-}