Ninja Programmers Mindmeld

    primer-alerts

    2.0.0 • Public • Published

    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

    Install

    npm i primer-alerts

    DownloadsWeekly Downloads

    1,921

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    12.2 kB

    Total Files

    8

    Last publish

    Collaborators

    • jfuchs
    • githubbot
    • manuelpuyol
    • jonrohan
    • broccolini
    • mislav
    • mdo
    • primer-css
    • keithamus
    • mschoening
    • koddsson
    • emilybrick
    • lgarron
    • colebemis
    • smockle
    • simurai
    • khiga8
    • dustin.greif
    • srt32