diff --git a/terminus-ui/scss/docs/cursors.md b/terminus-ui/scss/docs/cursors.md index 6359f49de..753929514 100644 --- a/terminus-ui/scss/docs/cursors.md +++ b/terminus-ui/scss/docs/cursors.md @@ -2,12 +2,12 @@ **Table of Contents** -- [Cursors](#cursors) +- [Cursor](#cursor) - [Available cursor values](#available-cursor-values) -## Cursors +## Cursor The `cursor()` function returns the correct cursor value based on the desired type. @@ -36,15 +36,18 @@ This is also available as a mixin: > These values are currently basically 1-to-1 with the actual CSS values. We expect this to change > over time as we create usage-driven names. -| Value | Meaning | -|---------------|-----------------------------------------| -| `alias` | Indicates an alias or copy will be made | -| `auto` | Let the browser decide | -| `col-resize` | Indicates the ability to resize | -| `copy` | Indicates ability to copy | -| `help` | Indicates help is available | -| `not-allowed` | Indicates no available interaction | -| `pointer` | Indicates interaction | -| `text` | Indicates text controls | +| Value | Meaning | +|---------------|------------------------------------------| +| `alias` | Indicates an alias or copy will be made | +| `auto` | Let the browser decide | +| `col-resize` | Indicates the ability to resize | +| `copy` | Indicates ability to copy | +| `default` | The default browser cursor | +| `help` | Indicates help is available | +| `move` | Indicates the ability to move an item | +| `not-allowed` | Indicates no available interaction | +| `ns-resized` | Indicates the ability to move vertically | +| `pointer` | Indicates interaction | +| `text` | Indicates text controls | Passing an invalid cursor `$type` will throw a Sass compilation error. diff --git a/terminus-ui/scss/helpers/_cursors.scss b/terminus-ui/scss/helpers/_cursors.scss index dc6d19d7d..91e3b1c5a 100644 --- a/terminus-ui/scss/helpers/_cursors.scss +++ b/terminus-ui/scss/helpers/_cursors.scss @@ -18,6 +18,8 @@ $g-cursors: ( move, /* Indicates no available interaction */ not-allowed, + /* Indicates the ability to move North and South */ + ns-resize, /* Indicates interaction */ pointer, /* Indicates text controls */ diff --git a/terminus-ui/scss/helpers/_cursors.spec.scss b/terminus-ui/scss/helpers/_cursors.spec.scss index 8e44c0e50..82195250b 100644 --- a/terminus-ui/scss/helpers/_cursors.spec.scss +++ b/terminus-ui/scss/helpers/_cursors.spec.scss @@ -1,2 +1,26 @@ @import 'true'; @import './cursors'; + + +@include describe ('cursors') { + @include test ('should output a cursor') { + @include assert { + @include output { + .foo { + cursor: cursor(col-resize); + } + .bar { + cursor: cursor(help); + } + } + @include expect { + .foo { + cursor: col-resize; + } + .bar { + cursor: help; + } + } + } + } +}