inuit-pack

A simple layout tool in the inuitcss framework

Usage no npm install needed!

<script type="module">
  import inuitPack from 'https://cdn.skypack.dev/inuit-pack';
</script>

README

Pack

inuitcss’ Pack object simply causes any number of elements pack up horizontally to automatically fill an equal, fluid width of their parent.

Dependencies

inuitcss’ Pack object depends on two other inuitcss modules:

If you install the Pack object using Bower, you will get these dependencies at the same time. If not using Bower, please be sure to install and @import these dependencies in the relevant way.

Installation

The recommended installation method is Bower, but you can install the Pack module via a Git Submodule, or copy and paste.

Install using Bower:

$ bower install --save inuit-pack

Install using npm:

$ npm install --save inuit-pack

Once installed, @import into your project in its Objects layer:

@import "bower_components/inuit-pack/objects.pack";

Install as a Git Submodule

$ git submodule add git@github.com:inuitcss/objects.pack.git

Once installed, @import into your project in its Objects layer:

@import "objects.pack/objects.pack";

Install via file download

The least recommended option for installation is to simply download _objects.pack.scss into your project and @import it into your project in its Objects layer.

Usage

Basic usage of the Pack object uses the required classes:

<div class="pack">
    <div class="pack__item">
        Foo
    </div>
    <div class="pack__item">
        Bar
    </div>
    <div class="pack__item">
        Baz
    </div>
</div>

The only valid children of the .pack node are .pack__items.

Options

Other, optional classes can supplement the required base classes:

  • .pack--auto: cause packed items to have an automatically determined, non-equal width.
  • .pack--[tiny|small|large|huge]: alter the gutter between pack items.
  • .pack--rev: reverse the rendered horizontal order of packed items.
  • .pack--[middle|bottom]: align packed items to the middles or bottoms of each other.

For example:

<div class="pack  pack--small  pack--rev">
    <div class="pack__item">
        Foo
    </div>
    <div class="pack__item">
        Bar
    </div>
    <div class="pack__item">
        Baz
    </div>
</div>