mirror of
https://github.com/primer/css.git
synced 2024-12-21 05:01:45 +03:00
70 lines
2.4 KiB
Markdown
70 lines
2.4 KiB
Markdown
# Primer CSS table object
|
||
|
||
[](https://www.npmjs.org/package/primer-table-object)
|
||
[](https://travis-ci.org/primer/primer-css)
|
||
|
||
> 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.
|
||
|
||
This repository is a module of the full [primer-css][primer-css] repository.
|
||
|
||
## Install
|
||
|
||
This repository is distributed with [npm][npm]. After [installing npm][install-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][sass] (`scss`) You can simply point your sass `include-path` at your `node_modules` directory and import it like this.
|
||
|
||
```scss
|
||
@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
|
||
|
||
<!-- %docs
|
||
title: Table object
|
||
status: Stable
|
||
key: /css/styles/core/objects/table-object
|
||
-->
|
||
|
||
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.
|
||
|
||
```html
|
||
<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>
|
||
```
|
||
|
||
<!-- %enddocs -->
|
||
|
||
## License
|
||
|
||
[MIT](./LICENSE) © [GitHub](https://github.com/)
|
||
|
||
[primer-css]: https://github.com/primer/primer
|
||
[docs]: http://primercss.io/
|
||
[npm]: https://www.npmjs.com/
|
||
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
|
||
[sass]: http://sass-lang.com/
|