3.9 KiB
Primer Blankslate
Blankslates are for when there is a lack of content within a page or section. Use them as placeholders to tell users why something isn’t there. Be sure to provide an action to add content as well.
This repository is a module of the full primer repository.
Install
This repository is distributed with npm. After installing npm, you can install primer-blankslate with this command.
$ npm install --save primer-blankslate
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-blankslate/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
Blankslates are for when there is a lack of content within a page or section. Use them as placeholders to tell users why something isn't there. Be sure to provide an action to add content as well.
Basic example
Wrap some content in the outer .blankslate wrapper to give it the blankslate appearance.
<div class="blankslate">
<h3>This is a blank slate</h3>
<p>Use it to provide information when no dynamic content exists.</p>
</div>
With Octicons
When it helps the message, include (relevant) icons in your blank slate. Add .blankslate-icon to any .mega-octicons as the first elements in the blankslate, like so.
<div class="blankslate">
<%= octicon "git-commit", :height => 32, :class => "blankslate-icon" %>
<%= octicon "tag", :height => 32, :class => "blankslate-icon" %>
<%= octicon "git-branch", :height => 32, :class => "blankslate-icon" %>
<h3>This is a blank slate</h3>
<p>Use it to provide information when no dynamic content exists.</p>
</div>
Variations
Add an additional optional class to the .blankslate to change its appearance.
Narrow
Narrows the blankslate container to not occupy the entire available width.
<div class="blankslate blankslate-narrow">
<h3>This is a blank slate</h3>
<p>Use it to provide information when no dynamic content exists.</p>
</div>
Capped
Removes the border-radius on the top corners.
<div class="blankslate blankslate-capped">
<h3>This is a blank slate</h3>
<p>Use it to provide information when no dynamic content exists.</p>
</div>
Spacious
Significantly increases the vertical padding.
<div class="blankslate blankslate-spacious">
<h3>This is a blank slate</h3>
<p>Use it to provide information when no dynamic content exists.</p>
</div>
Large
Increases the size of the text in the blankslate
<div class="blankslate blankslate-large">
<h3>This is a blank slate</h3>
<p>Use it to provide information when no dynamic content exists.</p>
</div>
No background
Removes the background-color and border.
<div class="blankslate blankslate-clean-background">
<h3>This is a blank slate</h3>
<p>Use it to provide information when no dynamic content exists.</p>
</div>