# @snug/core

Latest version **1.0.0-rc.6** (published 2021-06-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @snug/core
pnpm add @snug/core
yarn add @snug/core
bun add @snug/core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-rc.6 |
| Published | 2021-06-21 |
| First published | 2021-02-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Author | Lukas Kleinschmidt <kleinschmidt@eatersvz.de> |
| Maintainers | lukaskleinschmidt |

## Links

- npm: https://www.npmjs.com/package/@snug/core
- Repository: https://github.com/lukaskleinschmidt/snug
- Homepage: https://github.com/lukaskleinschmidt/snug#readme
- Issues: https://github.com/lukaskleinschmidt/snug/issues
- npm.io page: https://npm.io/package/@snug/core

## Recent versions

- 1.0.0-rc.6 (latest) — 2021-06-21
- 1.0.0-rc.5 — 2021-06-21
- 1.0.0-rc.4 — 2021-06-16
- 1.0.0-rc.3 — 2021-03-15
- 1.0.0-rc.2 — 2021-03-15
- 1.0.0-rc.1 — 2021-02-15
- 1.0.0-rc.0 — 2021-02-15

## README

# snug – super neat utility generator
SCSS toolkit to create utility classes with ease.


> ❗ snug is still under development and functionality may change


## Requirements
For now you need to use [dart sass](https://sass-lang.com/dart-sass) to compile your styles.


## Available variants
Name                 | Type
:--                  | :--
responsive           | `@media`
dark                 | `@media`
light                | `@media`
`pseudo-class`       | [`pseudo-class`](https://developer.mozilla.org/en-US/docs/Web/CSS/Pseudo-classes#alphabetical_index)
group-`pseudo-class` | [`pseudo-class`](https://developer.mozilla.org/en-US/docs/Web/CSS/Pseudo-classes#alphabetical_index)


## Basic Usage
```scss
@use '@snug/core' as * with (
  $breakpoints: (
    's': 640px,
    'm': 768px,
    'l': 1024px,
  )
);

// Basic responsive variants
.banana {
  @include variants('responsive') {
    color: gold;
  }
}

// Adding additional variants
.banana {
  @include variants('responsive' 'hover' 'group-hover') {
    color: gold;
  }
}

```


## Responsive Variants
When using modifiers that change the same or a more specific css property these must be grouped by breakpoint.
A more specific property would be something like `padding-top` to `padding`.

```scss
// Wrap your code like this to have your modifiers grouped by breakpoint
@include variants('responsive') using ($props...) {
  .p-1 {
    @include variants($props...) {
      padding: 0.25rem;
    }
  }

  .pt-1 {
    @include variants($props...) {
      padding-top: 0.25rem;
    }
  }
}

```


## Using Options
```scss
$colors: (
  'blue': (
    100: #e5f1fd,
    200: #b0d6f9,
    300: #7bbaf6,
    400: #469ff2,
    500: #1183ee,
    600: #0d66b9,
    700: #094984,
    800: #062c4f,
    900: #020f1a,
  )
);

.text {
  @include options($colors, 'hover' 'group-hover') using ($value) {
    color: $value;
  }
}

```

---
_Source: https://npm.io/package/@snug/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._