Find file History
emplums Publish
 - primer-alerts@1.5.9
 - primer-avatars@1.5.6
 - primer-base@1.7.4
 - primer-blankslate@1.4.9
 - primer-box@2.5.9
 - primer-branch-name@1.0.7
 - primer-breadcrumb@1.5.5
 - primer-buttons@2.6.0
 - primer-core@6.10.3
 - primer-forms@2.1.4
 - primer-labels@1.5.9
 - primer-layout@1.4.9
 - primer-markdown@3.7.9
 - primer-marketing-buttons@1.0.8
 - primer-marketing-type@1.4.9
 - primer-marketing-utilities@1.6.5
 - primer-marketing@6.2.4
 - primer-navigation@1.5.7
 - primer-page-headers@1.4.9
 - primer-page-sections@1.4.9
 - primer-pagination@1.0.3
 - primer-popover@0.1.3
 - primer-product@5.6.6
 - primer-subhead@1.0.7
 - primer-support@4.6.0
 - primer-table-object@1.4.9
 - primer-tables@1.4.9
 - primer-tooltips@1.5.7
 - primer-truncate@1.4.9
 - primer-utilities@4.12.0
 - primer@10.8.0
 - generator-primer-module@1.0.8
 - primer-module-build@1.0.5
 - stylelint-config-primer@2.2.10
 - stylelint-selector-no-utility@1.8.10
Latest commit 1b5ff95 Jul 27, 2018

README.md

Primer Alerts

npm version Build Status

Flash messages, or alerts, inform users of successful or pending actions. Use them sparingly. Don’t show more than one at a time.

This repository is a module of the full primer repository.

Install

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

$ npm install --save primer-alerts

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-alerts/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

Flash messages, or alerts, inform users of successful or pending actions. Use them sparingly. Don't show more than one at a time.

Default

Flash messages start off looking decently neutral—they're just light blue rounded rectangles.

<div class="flash">
  Flash message goes here.
</div>

You can put multiple paragraphs of text in a flash message—the last paragraph's bottom margin will be automatically override.

<div class="flash">
  <p>This is a longer flash message in it's own paragraph. It ends up looking something like this. If we keep adding more text, it'll eventually wrap to a new line.</p>
  <p>And this is another paragraph.</p>
</div>

Should the need arise, you can quickly space out your flash message from surrounding content with a .flash-messages wrapper. Note the extra top and bottom margin in the example below.

<div class="flash-messages">
  <div class="flash">
    Flash message goes here.
  </div>
</div>

Variations

Add .flash-warn, .flash-error, or .flash-success to the flash message to make it yellow, red, or green, respectively.

<div class="flash flash-warn">
  Flash message goes here.
</div>
<div class="flash flash-error">
  Flash message goes here.
</div>
<div class="flash flash-success">
  Flash message goes here.
</div>

With icon

Add an icon to the left of the flash message to give it some funky fresh attention.

<div class="flash">
  <%= octicon "alert" %>
  Flash message with an icon goes here.
</div>

With dismiss

Add a JavaScript enabled (via Crema) dismiss (close) icon on the right of any flash message.

<div class="flash">
  <button class="flash-close js-flash-close" type="button"><%= octicon "x", :"aria-label" => "Close" %></button>
  Dismissable flash message goes here.
</div>

With action button

A flash message with an action button.

<div class="flash">
  <button type="submit" class="btn btn-sm primary flash-action">Complete action</button>
  Flash message with action here.
</div>

Full width flash

A flash message that is full width and removes border and border radius.

<div class="flash flash-full">
  <div class="container">
    Full width flash message.
  </div>
</div>

License

MIT © GitHub