# lintel-contrib-badges

> Badges for lintel.

Latest version **0.1.4** (published 2015-02-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install lintel-contrib-badges
pnpm add lintel-contrib-badges
yarn add lintel-contrib-badges
bun add lintel-contrib-badges
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2015-02-15 |
| First published | 2015-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Marius Craciunoiu |
| Maintainers | mariusc23 |
| Keywords | lintelmodule, lintel |

## Links

- npm: https://www.npmjs.com/package/lintel-contrib-badges
- Repository: https://github.com/lintelio/lintel-contrib-badges
- Issues: https://github.com/lintelio/lintel-contrib-badges/issues
- npm.io page: https://npm.io/package/lintel-contrib-badges

## Dependencies (1)

- [lintel](https://npm.io/package/lintel.md) ~0.1.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.1.4 (latest) — 2015-02-15
- 0.1.3 — 2015-01-09
- 0.1.2 — 2015-01-08
- 0.1.1 — 2015-01-08

## README

lintel-contrib-badges
=====================

> Badges for lintel.

[![npm](https://img.shields.io/npm/v/lintel-contrib-badges.svg)](https://www.npmjs.com/package/lintel-contrib-badges)
[![Bower](https://img.shields.io/bower/v/lintel-contrib-badges.svg)](https://github.com/lintelio/lintel-contrib-badges)


## Getting Started
This module requires Lintel.

If you haven't used [Lintel](http://lintel.io/) before, be sure to check out the [Getting Started](http://lintel.io/getting-started) guide, as it explains how to install and use this module. Once you're familiar with that process, you may install this module with this command:

```shell
bower install lintel-contrib-badges --save
```

Once the module has been installed, you will have to load it in your main SASS file:

```scss
@import "bower_components/lintel-contrib-badges/sass/badges.scss"
```

You can use [wiredep](https://github.com/taptapship/wiredep) or [grunt-wiredep](https://github.com/stephenplusplus/grunt-wiredep) to automatically inject files in your build process.


## Variables
Check the vars file in the `sass` folder to see the full list of variables you can customize.

#### $badge-padding-y
Default value: `4px`  

Badge padding-top and padding-bottom.

#### $badge-padding-y
Default value: `4px`  

Badge padding-top and padding-bottom.

#### $badge-padding-x
Default value: `8px`  

Badge padding-left and padding-right.

#### $badge-border-radius
Default value: `$border-radius-sm`  

Badge border-radius.


## Mixins
Check the mixins file in the `sass` folder to see how you can extend this module.

#### make-badge($bg, [$border, $text, $bg-inverse, $border-inverse, $text-inverse])
Sets the background, border, and text color of a badge. Only include `$*-inverse` parameters if `$badge-include-inverse` is `true`.

```scss
.badge-primary {
  @include make-badge(
    $bg: $badge-primary, 
    $bg-inverse: $badge-primary-bg,
    $border-inverse: $badge-primary-border, 
    $text-inverse: $badge-primary-text
  );
}
```


## Examples

#### Base
```html
<span class="badge">Default</span>
```

#### Primary Badge
```html
<span class="badge">Primary</span>
```

#### Round Badge
```html
<h1>CSS makes the world go <span class="badge badge-round">round</span></h1>
```

#### Inside Headings
```html
<h1>This is a big, bad <span class="badge">badge</span></h1>
```


## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).


## License
Copyright (c) 2015 Marius Craciunoiu. Licensed under the MIT license.

---
_Source: https://npm.io/package/lintel-contrib-badges · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._