Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

primer-subhead

Package Overview
Dependencies
Maintainers
14
Versions
554
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

primer-subhead

The Subhead is a simple header with a bottom border. It's designed to be used on settings and configuration pages.

  • 2.1.0-alpha.df004242
  • pr
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.1K
decreased by-0.18%
Maintainers
14
Weekly downloads
 
Created
Source

Primer / Subhead

npm version Build Status

The Subhead is a simple header with a bottom border. It's designed to be used on settings and configuration pages.

This repository is a module of the full primer repository.

Install

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

$ npm install --save primer-subhead

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-subhead/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, an 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

The basic Subhead consists of a .Subhead container, which has a light gray bottom border. Use .Subhead-heading for the heading itself. It's an <h2> sized heading with normal font-weight.

Use a heading element whenever possible as they can be used as navigation for assistive technologies, and avoid skipping levels.

<div class="Subhead">
  <div class="Subhead-heading">Plain subhead</div>
</div>

To add a top margin to the Subhead, use .Subhead--spacious. This is useful for separating sections on a settings page.

<div class="Subhead Subhead--spacious">
  <div class="Subhead-heading">Spacious subhead</div>
</div>

You can add a one line description to the subhead with .Subhead-description.

<div class="Subhead">
  <div class="Subhead-heading">Subhead with description</div>
  <div class="Subhead-description">The subhead is a subdued header style with a light bottom border.</div>
</div>

For longer descriptions, it is recommended that you use a paragraph below the Subhead.

<div class="Subhead">
  <div class="Subhead-heading">Plain subhead</div>
</div>
<p>
  This is a longer description that is sitting below the Subheader. It's much longer than a description that could sit comfortably in the Subhead. It might even have <strong>bold</strong> text. <a href="#">Click to learn more.</a>
</p>

You can add a button or something to the right of .Subhead-heading with the .Subhead-actions element.

<div class="Subhead">
  <div class="Subhead-heading">Subhead with button</div>
  <div class="Subhead-actions"><a href="#url" class="btn btn-sm btn-primary" role="button">Action</a></div>
</div>

<div class="Subhead Subhead--spacious">
  <div class="Subhead-heading">Subhead with link</div>
  <div class="Subhead-actions"><a href="#url">Learn more</a></div>
</div>

Use all the elements together to create a Subhead with actions and a description.

<div class="Subhead">
  <div class="Subhead-heading">Subhead with actions and description</div>
  <div class="Subhead-actions"><a href="#url" class="btn btn-sm btn-primary" role="button">Action</a></div>
  <div class="Subhead-description">The subhead is a subdued header style with a light bottom border.</div>
</div>

Use the .Subhead-heading--danger modifier to make the text bold and red. This is useful for warning users.

<div class="Subhead">
  <div class="Subhead-heading Subhead-heading--danger">Danger zone</div>
</div>

License

MIT © GitHub

Keywords

FAQs

Package last updated on 14 Feb 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc