Adaptable

Adaptable is a Sass (SCSS) mixins library for building flexbox based grids.

Installation

With yarn:

yarn add adaptable

With npm:

npm install adaptable

Then just import @import "adaptable/core/adaptable"; at the top of your main sass file.

Note: your Sass configuration must be set to access certain dependencies or installation will fail. Either:

• include Eyeglass in your build tools, or;
• set node_modules in your includePaths.

Usage

Settings

Adaptable is build around two configuration units in the form of sass maps, that can be overwritten depending on each project needs or grid requirements.

$adaptable-grid

This variable is a sass map that overrides Adaptable's default grid settings. Use this to define your project's grid properties including column-gaps, total column count or grid debugging color.

Default settings:

$adaptable-grid: (
  columns: 12,
  column-gap: 1.5rem,
  row-gap: 1.5rem,
  color: rgba(#00d4ff, 0.25),
);

Properties

| Name | Type | Default | Description | | ---------- | ------------------ | ------------------- | ---------------------------------------------- | | columns | number (unitless) | 12 | Default number of the total grid columns. | | column-gap | number (with unit) | 1.5rem | Default grid column-gap width between columns. | | row-gap | number (with unit) | 1.5rem | Default grid row-gap width between grid cells. | | color | HEX, RGBA | rgba(#00d4ff, 0.25) | Default grid debug color. |

Mixins

Grid container

Creates a grid container with flexbox properties.

Example

SCSS

.element {
  @include grid-container;
}

CSS Output

.element {
  display: flex;
  flex: 1 0 calc(100% + 1.5rem);
  flex-wrap: wrap;
  margin-left: -1.5rem;
  margin-right: -1.5rem;
}

Grid column

Creates a grid column of requested size.

Example

SCSS

.element {
  @include grid-column(3);
}

CSS Output

.element {
  flex-shrink: 0;
  width: calc(25% - 30px);
  max-width: calc(100% - 1.5rem);
  margin-left: 1.5rem;
}

Grid span

Spans an element across the width of specified columns. Similar to grid-column but without setting a margin-left. Useful for nested grids or when only the width of the element is desired for the output.

Example

SCSS

.element {
  @include grid-span(3);
}

CSS Output

.element {
  flex: 0 0 auto;
  width: calc(25% - 30px);
}

Grid breakout

Creates negative left and right margins dictated by the specified number of columns. Useful to break out of a smaller parent grid.

Example

SCSS

.element {
  @include grid-breakout(1 of 8);
}

CSS Output

.element {
  min-width: 100%;
  margin-right: calc(-12.5% - 1.6875rem + 1.5rem);
  margin-left: calc(-12.5% - 1.6875rem + 1.5rem);
}

Grid push

Push or pull a grid column by manipulating its left margin.

Example

SCSS

.element {
  @include grid-push(3);
}

CSS Output

.element {
  margin-left: calc(25% - 30px + 1.5rem);
}

Grid shift

Shift columns and reorder them within their container using relative positioning.

Example

SCSS

.element {
  @include grid-shift(3);
}

CSS Output

.element {
  position: relative;
  left: calc(25% - 30px + 1.5rem);
}

Grid debug

Creates a series of guide lines using the background-image property on a grid container to visualise the columns and column-gaps of the grid.

Example

SCSS

.element {
  @include grid-debug;
}

CSS Output

.element {
  background-image: repeating-linear-gradient(...);
}

Media queries

Adaptable comes with sass-mq under the hood to allow you for easier media query manipulation.

Example

SCSS

// sass-mq configuration
$mq-breakpoints: (
  md: 640px,
  lg: 960px,
);

// Usage
.element {
  @include grid-column(6);

  @include mq($from: md) {
    @include grid-span(4);
  }
}

CSS Output

.element {
  flex-shrink: 0;
  width: calc(50% - 36px);
  max-width: calc(100% - 1.5rem);
  margin-left: 1.5rem;
}

@media (min-width: 40em) {
  .element {
    flex: 0 0 auto;
    width: calc(33.333333% - 32px);
  }
}

Contributing

See the contributing documentation.