1
1
mirror of https://github.com/primer/css.git synced 2024-12-23 06:01:54 +03:00
css/packages/primer-layout
broccolini e3ccf3b163 Publish
- primer-alerts@1.1.5
 - primer-avatars@0.4.9
 - primer-base@1.1.2
 - primer-blankslate@0.3.8
 - primer-box@2.1.5
 - primer-breadcrumb@0.1.4
 - primer-buttons@2.0.3
 - primer-cards@0.1.5
 - primer-core@4.0.2
 - primer-css@7.0.0-rc.3
 - primer-forms@1.0.10
 - primer-labels@1.1.3
 - primer-layout@1.0.2
 - primer-markdown@3.3.10
 - primer-marketing-support@0.5.3
 - primer-marketing-type@0.2.3
 - primer-marketing-utilities@0.1.7
 - primer-marketing@4.0.2
 - primer-navigation@1.0.3
 - primer-page-headers@0.1.4
 - primer-page-sections@0.1.4
 - primer-product@4.0.2
 - primer-support@4.0.4
 - primer-table-object@1.0.6
 - primer-tables@0.1.5
 - primer-tooltips@0.5.7
 - primer-truncate@0.3.5
 - primer-utilities@4.3.2
2017-06-23 19:20:50 -04:00
..
lib Updated gutter naming convention and added responsive modifiers 2017-06-19 18:52:26 -04:00
.gitignore update git ignore so npm logs don't get committed 2017-06-04 18:13:16 -04:00
.npmignore rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
.postcss.json rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
.stylelintrc.json rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
CHANGELOG.md rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
index.scss rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
LICENSE rename modules to packages for lerna setup 2017-05-11 16:12:29 -04:00
package.json Publish 2017-06-23 19:20:50 -04:00
README.md update npm to lowercase 2017-06-23 16:57:00 -04:00

Primer CSS Layout

npm version Build Status

Primers layout includes basic page containers and a single-tiered, fraction-based grid system. That sounds more complicated than it really is though—its just containers, rows, and columns.

This repository is a module of the full primer-css repository.

Install

This repository is distributed with npm. After installing npm, you can install primer-layout with this command.

$ npm install --save primer-layout

Usage

The source files included are written in Sass (scss) You can simply point your sass include-path at your node_modules directory and import it like this.

@import "primer-layout/index.scss";

You can also import specific portions of the module by importing those partials from the /lib/ folder. Make sure you import any requirements along with the modules.

Build

For a compiled css version of this module, a npm script is included that will output a css version to build/build.css The built css file is also included in the npm package.

$ npm run build

Documentation

Primer's layout includes basic page containers and a single-tiered, fraction-based grid system. That sounds more complicated than it really is though—it's just containers, rows, and columns.

You can find all the below styles in _layout.scss.

Container

Center your page's contents with a .container.

<div class="container">
  <!-- contents here -->
</div>

The container applies width: 980px; and uses horizontal margins to center it.

Grid

How it works

The grid is pretty standard—you create rows with .columns and individual columns with a column class and fraction class. Here's how it works:

  • Add a .container to encapsulate everything and provide ample horizontal gutter space.
  • Create your outer row to clear the floated columns with <div class="columns">.
  • Add your columns with individual <div class="column">s.
  • Add your fractional width classes to set the width of the columns (e.g., .one-fourth).
Demo

In practice, your columns will look like the example below.

<div class="container">
  <div class="columns mb-1">
    <div class="one-fifth column block-blue p-3 border">
      .one-fifth
    </div>
    <div class="four-fifths column block-blue p-3 border">
      .four-fifths
    </div>
  </div>

  <div class="columns mb-1">
    <div class="one-fourth column block-blue p-3 border">
      .one-fourth
    </div>
    <div class="three-fourths column block-blue p-3 border">
      .three-fourths
    </div>
  </div>

  <div class="columns mb-1">
    <div class="one-third column block-blue p-3 border">
      .one-third
    </div>
    <div class="two-thirds column block-blue p-3 border">
      .two-thirds
    </div>
  </div>

  <div class="columns">
    <div class="one-half column block-blue p-3 border">
      .one-half
    </div>
    <div class="one-half column block-blue p-3 border">
      .one-half
    </div>
  </div>
</div>
Centered

Columns can be centered by adding .centered to the .column class.

<div class="columns">
  <div class="one-half column centered block-blue p-3">
    .one-half
  </div>
</div>

License

MIT © GitHub