1
1
mirror of https://github.com/primer/css.git synced 2024-12-24 22:53:58 +03:00
css/modules/primer-table-object/README.md
2018-01-12 16:05:29 -08:00

2.4 KiB
Raw Blame History

Primer table object

npm version Build Status

Table object is a module for creating dynamically resizable elements that always sit on the same horizontal line (e.g., they never break to a new line). Using table styles in our CSS means its cross browser friendly back to at least IE9.

This repository is a module of the full primer repository.

Install

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

$ npm install --save primer-table-object

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-table-object/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

The table object is a module for creating dynamically resizable elements that always sit on the same horizontal line (e.g., they never break to a new line). Using table styles in our CSS means it's cross browser friendly back to at least IE9.

Additional margin or padding may be required to properly space content.

<div class="TableObject">
  <div class="TableObject-item TableObject-item--primary">
    <input class="input-block form-control" type="text" placeholder="Long elastic input form" aria-label="Long elastic input form">
  </div>
  <div class="TableObject-item">
    <button class="btn ml-2" type="button">Button</button>
  </div>
</div>

License

MIT © GitHub