Papillon-blankslate NPM

Papillon 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 papillon repository.

Install

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

$ npm install --save papillon-blankslate

Explorer

Check out how to use Papillon Blankslate with React 16, Webpack 4 and Babel 7 here

NPM

Get the latest papillon-blankslate here

Usage

You can import it like this.

import Blankslate from 'papillon-blankslate'

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

Wrap some content in the outer .blankslate wrapper to give it the blankslate appearance.

<Blankslate>
  <h3>This is a blank slate</h3>
  <p>Use it to provide information when no dynamic content exists.</p>
</Blankslate>

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.

  <Blankslate icons={['git-commit', 'tag', 'git-branch']}>
    <h3>This is a blank slate</h3>
    <p>Use it to provide information when no dynamic content exists.</p>
  </Blankslate>

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.

<Blankslate className="blankslate-narrow">
  <h3>This is a blank slate</h3>
  <p>Use it to provide information when no dynamic content exists.</p>
</Blankslate>

Capped

Removes the border-radius on the top corners.

<Blankslate className="blankslate-capped">
  <h3>This is a blank slate</h3>
  <p>Use it to provide information when no dynamic content exists.</p>
</Blankslate>

Spacious

Significantly increases the vertical padding.

<Blankslate className="blankslate-spacious">
  <h3>This is a blank slate</h3>
  <p>Use it to provide information when no dynamic content exists.</p>
</Blankslate>

Large

Increases the size of the text in the blankslate

<Blankslate className="blankslate-large">
  <h3>This is a blank slate</h3>
  <p>Use it to provide information when no dynamic content exists.</p>
</Blankslate>

No background

Removes the background-color and border.

<Blankslate className="blankslate-clean-background">
  <h3>This is a blank slate</h3>
  <p>Use it to provide information when no dynamic content exists.</p>
</Blankslate>