2.0.0 • Published 5 years ago

primer-alerts v2.0.0

Weekly downloads
3,988
License
MIT
Repository
github
Last release
5 years ago

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

2.0.0

5 years ago

1.5.13

5 years ago

1.5.12

5 years ago

1.5.12-rc.1

5 years ago

1.5.12-rc.0

5 years ago

1.5.11-rc.6

5 years ago

1.5.11-rc.5

5 years ago

1.5.11

5 years ago

1.5.11-rc.4

5 years ago

1.5.11-rc.3

5 years ago

1.5.11-rc.2

5 years ago

1.5.11-rc.1

5 years ago

1.5.11-rc.0

5 years ago

1.5.10-rc.6

5 years ago

1.5.10-rc.5

5 years ago

1.5.10-rc.4

5 years ago

1.5.10-rc.3

5 years ago

1.5.10-rc.2

5 years ago

1.5.10

6 years ago

1.5.10-rc.1

6 years ago

1.5.10-rc.0

6 years ago

1.5.9-rc.12

6 years ago

1.5.9-rc.11

6 years ago

1.5.9-rc.10

6 years ago

1.5.9-rc.9

6 years ago

1.5.9-rc.8

6 years ago

1.5.9-rc.7

6 years ago

1.5.9-rc.6

6 years ago

1.5.9-rc.5

6 years ago

1.5.9-rc.4

6 years ago

1.5.9

6 years ago

1.5.9-rc.3

6 years ago

1.5.9-rc.2

6 years ago

1.5.9-rc.1

6 years ago

1.5.9-rc.0

6 years ago

1.5.8-rc.2

6 years ago

1.5.8-rc.1

6 years ago

1.5.8

6 years ago

1.5.8-rc.0

6 years ago

1.5.7-rc.10

6 years ago

1.5.7-rc.9

6 years ago

1.5.7-rc.8

6 years ago

1.5.7-rc.7

6 years ago

1.5.7-rc.6

6 years ago

1.5.7-rc.5

6 years ago

1.5.7-rc.4

6 years ago

1.5.7-rc.3

6 years ago

1.5.7-rc.2

6 years ago

1.5.7

6 years ago

1.5.7-rc.1

6 years ago

1.5.7-rc.0

6 years ago

1.5.6-rc.2

6 years ago

1.5.6-rc.1

6 years ago

1.5.6

6 years ago

1.5.6-rc.0

6 years ago

1.5.5-rc.7

6 years ago

1.5.5-rc.6

6 years ago

1.5.5-rc.5

6 years ago

1.5.5-rc.4

6 years ago

1.5.5-rc.3

6 years ago

1.5.5-rc.2

6 years ago

1.5.5-rc.1

6 years ago

1.5.5

6 years ago

1.5.5-rc.0

6 years ago

1.5.4-rc.14

6 years ago

1.5.4-rc.13

6 years ago

1.5.4-rc.12

6 years ago

1.5.4-rc.11

6 years ago

1.5.4-rc.10

6 years ago

1.5.4-rc.9

6 years ago

1.5.4-rc.8

6 years ago

1.5.4-rc.7

6 years ago

1.5.4-rc.6

6 years ago

1.5.4-rc.5

6 years ago

1.5.4-rc.4

6 years ago

1.5.4-rc.3

6 years ago

1.5.4

6 years ago

1.5.4-rc.2

6 years ago

1.5.4-rc.1

6 years ago

1.5.4-rc.0

6 years ago

1.5.3-rc.7

6 years ago

1.5.3-rc.6

6 years ago

1.5.3-rc.5

6 years ago

1.5.3-rc.4

6 years ago

1.5.3-rc.3

6 years ago

1.5.3-rc.2

6 years ago

1.5.3

6 years ago

1.5.3-rc.1

6 years ago

1.5.3-rc.0

6 years ago

1.5.2-rc.6

6 years ago

1.5.2-rc.5

6 years ago

1.5.2-rc.4

6 years ago

1.5.2-rc.3

6 years ago

1.5.2-rc.2

6 years ago

1.5.2-rc.1

6 years ago

1.5.2

6 years ago

1.5.2-rc.0

6 years ago

1.5.1-rc.10

6 years ago

1.5.1-rc.9

6 years ago

1.5.1-rc.8

6 years ago

1.5.1-rc.7

6 years ago

1.5.1-rc.6

6 years ago

1.5.1-rc.5

6 years ago

1.5.1-rc.4

6 years ago

1.5.1-rc.3

6 years ago

1.5.1-rc.2

6 years ago

1.5.1-rc.1

6 years ago

1.5.1-rc.0

6 years ago

1.5.1

7 years ago

1.5.0-rc.18

7 years ago

1.5.0-rc.17

7 years ago

1.5.0-rc.16

7 years ago

1.5.0-rc.15

7 years ago

1.5.0-rc.14

7 years ago

1.5.0-rc.13

7 years ago

1.5.0-rc.12

7 years ago

1.5.0-rc.11

7 years ago

1.5.0-rc.10

7 years ago

1.5.0-rc.9

7 years ago

1.5.0-rc.8

7 years ago

1.5.0-rc.7

7 years ago

1.5.0-rc.6

7 years ago

1.5.0

7 years ago

1.5.0-rc.5

7 years ago

1.4.0-rc.11

7 years ago

1.5.0-rc.4

7 years ago

1.4.0-rc.10

7 years ago

1.5.0-rc.3

7 years ago

1.5.0-rc.2

7 years ago

1.4.0-rc.9

7 years ago

1.4.0-rc.8

7 years ago

1.5.0-rc.1

7 years ago

1.5.0-rc.0

7 years ago

1.4.0-rc.7

7 years ago

1.4.0-rc.6

7 years ago

1.4.0-rc.5

7 years ago

1.4.0-rc.4

7 years ago

1.4.0-rc.3

7 years ago

1.4.0

7 years ago

1.4.0-rc.2

7 years ago

1.4.0-rc.1

7 years ago

1.4.0-rc.0

7 years ago

1.3.0

7 years ago

1.3.0-rc.1

7 years ago

1.3.0-rc.0

7 years ago

1.2.1-rc.15

7 years ago

1.2.1-rc.14

7 years ago

1.2.1

7 years ago

1.2.1-rc.13

7 years ago

1.2.1-rc.12

7 years ago

1.2.1-rc.11

7 years ago

1.2.1-rc.10

7 years ago

1.2.1-rc.9

7 years ago

1.2.1-rc.8

7 years ago

1.2.0

7 years ago

1.2.0-rc.7

7 years ago

1.2.0-rc.6

7 years ago

1.2.0-rc.5

7 years ago

1.2.0-rc.4

7 years ago

1.1.8-4

7 years ago

1.1.8-3

7 years ago

1.1.8-2

7 years ago

1.1.8-1

7 years ago

1.1.8

7 years ago

1.1.8-0

7 years ago

1.1.7

7 years ago

1.1.6

7 years ago

1.1.5

7 years ago

1.1.4

7 years ago

1.1.3

7 years ago

1.1.3-alpha.1

7 years ago

1.1.3-alpha.0

7 years ago

1.1.3-monobeta.0

7 years ago

1.1.3-monotest.0

7 years ago

1.1.3-mono.0

7 years ago

1.1.2

7 years ago

1.1.1

7 years ago

1.1.0

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago

0.4.0

7 years ago

0.3.1

8 years ago

0.3.0

8 years ago

0.2.6

8 years ago

0.2.5

8 years ago

0.2.4

8 years ago

0.2.3

8 years ago

0.2.2

8 years ago

0.2.1

8 years ago

0.2.0

8 years ago