# jigsass-utils-position

> A collection of dynamically generated utility classes for setting CSS position values

Latest version **1.1.0** (published 2016-12-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install jigsass-utils-position
pnpm add jigsass-utils-position
yarn add jigsass-utils-position
bun add jigsass-utils-position
```

## 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.1.0 |
| Published | 2016-12-25 |
| First published | 2016-04-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | TxHawks |
| Maintainers | txhawks |
| Keywords | jigsass, sass, scss, css, oocss, atomic css, eyeglass-module |

## Links

- npm: https://www.npmjs.com/package/jigsass-utils-position
- Repository: https://github.com/txhawks/jigsass-utils-position
- Homepage: https://txhawks.github.io/jigsass-utils-position/
- npm.io page: https://npm.io/package/jigsass-utils-position

## Dependencies (6)

- [jigsass-tools-mq](https://npm.io/package/jigsass-tools-mq.md) ^1.5.2
- [jigsass-tools-bidi](https://npm.io/package/jigsass-tools-bidi.md) ^1.1.6
- [jigsass-tools-maps](https://npm.io/package/jigsass-tools-maps.md) ^1.0.10
- [jigsass-tools-strings](https://npm.io/package/jigsass-tools-strings.md) ^1.4.0
- [jigsass-tools-selectors](https://npm.io/package/jigsass-tools-selectors.md) ^0.9.2
- [jigsass-tools-typography](https://npm.io/package/jigsass-tools-typography.md) ^1.4.0

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2016-12-25
- 1.0.1 — 2016-04-23
- 1.0.0 — 2016-04-09

## README

# JigSass Utils Position
[![NPM version][npm-image]][npm-url]  [![Dependency Status][daviddm-image]][daviddm-url]   

 > A collection of dynamically generated utility classes for setting CSS position values

Class names follow the [Emmet](http://docs.emmet.io/cheat-sheet/) abbreviation
syntax, with colons (':') replaced by two dashes (`--`) to follow BEM naming
conventions (It modifiies the user agent's default position for the element).
E.g., the `position: absolute` utility class name is `.u-pos--a`.

## Available classes
  - `.u-pos--a` (position: absolute)
  - `.u-pos--f` (position: fixed)
  - `.u-pos--r` (position: relative)
  - `.u-pos--s` (position: static)

Additionally, JigSass Position provides the following helpers:
  - `.u-pos--center` Used for vertically and horizontally centering `absolute` and `fixed`
    positioned elements inside their first non-statically positioned ancestor (or `window`).
    Will also work for `relative` positioned elements inside containers with explicit heights.
  - `.u-pos--stretch` Used for stretching `absolute` and `fixed` positioned elements to the
    dimensions of their first non-statically positioned ancestor (or `window`).


## Installation

Using npm:

```sh
npm i -S jigsass-utils-position
```


## Usage
Import JigSass Utils Position into your main scss file near its very end, together with all
other utilities (utilities should always be the last to be imported).

```scss
@import 'path/to/jigsass-utils-position/scss/index';
```

Like all other JigSass Utils, JigSass Position does not automatically generate any CSS
when imported. You would need to explicitly indicate that each individual class
should actually be generated in each component or object it is used in
(clarification: This will include style declarations inside `.foo` and .`bar`):

```scss
// _c.foo.scss
.foo {
  @include jigsass-util(u-pos, $modifier: a); // <-- position: absolute

  ...
}
```

```scss
// _c.bar.scss
.bar {
  @include jigsass-util(u-pos, $modifier: r);  // <-- position: relative
  @include jigsass-util(
    u-pos,
    $modifier: f,
    $from: large
  ); // <-- position: fixed, from large bp and on.

  ...
}
```

Doing so helps us a great deal with portability, as no matter where we import component or object
partials, the correct utility classes will be generated. Think of it as a poor man's dependency
management.

Developer communication is also assisted by including "dependencies" wherever they are required,
as anyone going through a partial, can easily understand how it should be marked up with just a
glance.

As far as bloat goes, just don't worry about it - the actual styles will only be generated once,
at the location in the cascade where the Jigsass Position partial was imported into the main file.


JigSass Position classes are responsive-enabled, using [JigSass MQ](https://txhawks.github.io/jigsass-tools-mq/)
and the breakpoints defined in the [$jigsass-breakpoints](https://txhawks.github.io/jigsass-tools-mq/#variable-jigsass-breakpoints) variable.

Based on the breakpoint arguments passed to `jigsass-util` when including a position class, responsive
modifiers are generated according to the following logic:

```scss
.u-pos--<modifier>[-[-from-<breakpoint-name>][-until-<breakpoint-name>][-misc-<breakpoint-name>]]
```

So, assuming the `medium`, `large` and `landscape` breakpoints are defined in `$jigsass-breakpoints`
as `600px`, `1024px` and `(orientation: landscape)` respectively,

```scss
@include jigsass-util(u-pos, $modifier: f);
```
will generate the `.u-pos--f` class, which is not limited to any media-query.

```scss
@include jigsass-util(u-pos, $modifier: f, $until: medium);
```

will generate the `.u-pos--f--until-medium` class, which will be in effect at
`(max-width: 37.49em)` and will override styles in the default class until that point.

```scss
@include jigsass-util(u-pos, $modifier: f, $from: large, $misc: landscape);
```

will generate the `.u-pos--f--from-large-when-landscape` class, which will go into
effect at `(min-width: 64em) and (orientation: landscape)` and will override styles in the default
class under these  conditions.


## Documentation

The full documentation was generated using mdcss, and is available at 
[https://txhawks.github.io/jigsass-utils-position/](https://txhawks.github.io/jigsass-utils-position/)

## Contributing

It is a best practice for JigSass modules to *not* automatically generate css on `@import`, but 
rather have the user explicitly enable the generation of specific styles from the module.

Contributions in the form of pull-requests, issues, bug reports, etc. are welcome.
Please feel free to fork, hack or modify JigSass Position in any way you see fit.

#### Writing documentation

Good documentation is crucial for usability, scalability and maintainability. When 
contributing, please do make sure that both its Sass functionality (functions, mixins, 
variables and placeholder selectors), as well as the CSS it generates (selectors, 
concepts, usage exmples, etc.) are well documented.

Jigsass Position uses Jonathan Neal's [mdcss](//github.com/jonathantneal/mdcss).

When styles and documentation comments are not automatically generated by your module on `@import`,
please use the `sgSrc/sg.scss` file to enable their generation.

In addition, any file in `sgSrc/assets` will be available for use in the style guide.



## File structure
```bash
┬ ./
│
├─┬ scss/ 
│ └─ index.scss # The module's importable file.
│
├─┬ sgSrc/      # Style guide sources
│ │
│ ├── sg.scc    # It is a best practice for JigSass 
│ │             # modules to not automatically generate 
│ │             # css and documentation on `@import.` 
│ │             # Please use this file to enable css
│ │             # and documentation comments) generation.
│ │
│ └── assets/   # Files in `sgSrc/assets` will be 
│               # available for use in the style guide
│
└─┬ docs/      # Documention
  │
  └── styleguide/ # Generated documentation 
                  # of the module's CSS
```


**License:** MIT



[npm-image]: https://badge.fury.io/js/jigsass-utils-position.svg
[npm-url]: https://npmjs.org/package/jigsass-utils-position

[daviddm-image]: https://david-dm.org/TxHawks/jigsass-utils-position.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/TxHawks/jigsass-utils-position

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