Permalink
Browse files

feat(badge): Support actionable (link) badges (#1226)

* feat(badge): Support actionable (link) badges

Import b-link and associated props to allow support for actionable  badges.

Bootstrap V4.beta.2 provides proper styling for badge classes applied to `<a>` tags.

* Update badge.js

* Update README.md

* Update badge.js
  • Loading branch information...
tmorehouse committed Oct 23, 2017
1 parent 0b8bc67 commit ba2b5b4dc52fa8fd8ccfce63c0b7626e9fd6977f
Showing with 123 additions and 16 deletions.
  1. +98 −2 docs/components/badge/README.md
  2. +25 −14 lib/components/badge.js
@@ -2,21 +2,78 @@

> Small and adaptive tag for adding context to just about any content.
Badges scale to match the size of the immediate parent element by using
relative font sizing and `em` units.

```html
<div>
<h2>Example heading <b-badge>New</b-badge></h2>
<h3>Example heading <b-badge>New</b-badge></h3>
<h4>Example heading <b-badge variant="primary">New</b-badge></h4>
<h5>Example heading <b-badge pill variant="success">New</b-badge></h5>
<h4>Example heading <b-badge>New</b-badge></h4>
<h5>Example heading <b-badge>New</b-badge></h5>
<h6>Example heading <b-badge>New</b-badge></h6>
</div>

<!-- badges.vue -->
```

Badges can be used as part of links or buttons to provide a counter (or similar flag).

```html
<div class="text-center">
<b-button variant="primary">
Notifications <b-badge variant="light">4</b-badge>
</b-button>
</div>

<!-- badge-button-1.vue -->
```

Note that depending on how they are used, badges may be confusing for users
of screen readers and similar assistive technologies. While the styling of badges
provides a visual cue as to their purpose, these users will simply be presented with
the content of the badge. Depending on the specific situation, these badges may seem
like random additional words or numbers at the end of a sentence, link, or button.

Unless the context is clear (as with the “Notifications” example, where it is
understood that the “4” is the number of notifications), consider including additional
context with a visually hidden piece of additional text.

```html
<div class="text-center">
<b-button variant="primary">
Profile
<b-badge variant="light">
9 <span class="sr-only">unread messages</span>
</b-badge>
</b-button>
</div>

<!-- badge-button-aria.vue -->
```


## Contextual variations
Add any of the following variants via the `variant` prop to change the
appearance of a `<b-badge>`: `default`, `primary`, `success`, `warning`, `info`,
and `danger`. If no variant is specified `default` will be used.

```html
<div>
<b-badge variant="primary">Primary</b-badge>
<b-badge variant="secondary">Secondary</b-badge>
<b-badge variant="success">Success</b-badge>
<b-badge variant="danger">Danger</b-badge>
<b-badge variant="warning">Warning</b-badge>
<b-badge variant="info">Info</b-badge>
<b-badge variant="light">Light</b-badge>
<b-badge variant="dark">Dark</b-badge>
</div>

<!-- badge-variants.vue -->
```


### Conveying meaning to assistive technologies:
Using color to add meaning only provides a visual indication, which will not
be conveyed to users of assistive technologies – such as screen readers. Ensure
@@ -28,4 +85,43 @@ additional text hidden with the `.sr-only` class.
Use the `pill` prop to make badges more rounded (with a larger border-radius
and additional horizontal padding). Useful if you miss the badges from Bootstrap v3.

```html
<div>
<b-badge pill variant="primary">Primary</b-badge>
<b-badge pill variant="secondary">Secondary</b-badge>
<b-badge pill variant="success">Success</b-badge>
<b-badge pill variant="danger">Danger</b-badge>
<b-badge pill variant="warning">Warning</b-badge>
<b-badge pill variant="info">Info</b-badge>
<b-badge pill variant="light">Light</b-badge>
<b-badge pill variant="dark">Dark</b-badge>
</div>

<!-- badge-pill.vue -->
```


## Actionable badges
Quickly provide actionable badges with hover and focus states by specifying either the
`href` prop (links) or `to` prop (router-links):

```html
<div>
<b-badge href="#" variant="primary">Primary</b-badge>
<b-badge href="#" variant="secondary">Secondary</b-badge>
<b-badge href="#" variant="success">Success</b-badge>
<b-badge href="#" variant="danger">Danger</b-badge>
<b-badge href="#" variant="warning">Warning</b-badge>
<b-badge href="#" variant="info">Info</b-badge>
<b-badge href="#" variant="light">Light</b-badge>
<b-badge href="#" variant="dark">Dark</b-badge>
</div>

<!-- badge-action.vue -->
```

Refer to the [Router support](/docs/reference/router-links) reference page for
router-link specific props.


## Component Reference
@@ -1,6 +1,12 @@
import { mergeData } from "../utils";
import { mergeData, pluckProps } from "../utils";
import { assign } from "../utils/object";
import Link, { propsFactory as linkPropsFactory } from "./link";

export const props = {
let linkProps = linkPropsFactory();
delete linkProps.href.default;
delete linkProps.to.default;

export const props = assign(linkProps, {
tag: {
type: String,
default: "span"
@@ -13,22 +19,27 @@ export const props = {
type: Boolean,
default: false
}
};
});

export default {
functional: true,
props,
render(h, { props, data, children }) {
return h(
props.tag,
mergeData(data, {
staticClass: "badge",
class: [
!props.variant ? "badge-secondary" : `badge-${props.variant}`,
{ "badge-pill": Boolean(props.pill) }
]
}),
children
);
const tag = !props.href && !props.to ? props.tag : Link;

const componentData = {
staticClass: "badge",
class: [
!props.variant ? "badge-secondary" : `badge-${props.variant}`,
{
"badge-pill": Boolean(props.pill),
active: props.active,
disabled: props.disabled
}
],
props: pluckProps(linkProps, props)
};

return h(tag, mergeData(data, componentData), children);
}
};

0 comments on commit ba2b5b4

Please sign in to comment.