Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use callout without custom jekyll plugin #25320

Merged
merged 2 commits into from
Mar 12, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions _includes/callout-danger-async-methods.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{% callout danger %}
{% capture callout %}
#### Asynchronous methods and transitions

All API methods are **asynchronous** and start a **transition**. They return to the caller as soon as the transition is started but **before it ends**. In addition, a method call on a **transitioning component will be ignored**.

[See our JavaScript documentation for more information.]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/javascript/)
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="danger" %}
5 changes: 3 additions & 2 deletions _includes/callout-info-mediaqueries-breakpoints.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{% callout info %}
{% capture callout %}
Note that since browsers do not currently support [range context queries](https://www.w3.org/TR/mediaqueries-4/#range-context), we work around the limitations of [`min-` and `max-` prefixes](https://www.w3.org/TR/mediaqueries-4/#mq-min-max) and viewports with fractional widths (which can occur under certain conditions on high-dpi devices, for instance) by using values with higher precision for these comparisons.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="info" %}
5 changes: 3 additions & 2 deletions _includes/callout-warning-color-assistive-technologies.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{% callout warning %}
{% capture callout %}
##### 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 that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the `.sr-only` class.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="warning" %}
9 changes: 9 additions & 0 deletions _includes/callout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{%- comment -%}
Usage: {% include callout.html content=callout type="type" %},
where content is a capture with the content
and type is one of: info (default), danger, warning
{%- endcomment -%}
{%- assign css_class = include.type | default: "info" -%}
<div class="bd-callout bd-callout-{{ css_class }}">
{{- include.content | markdownify -}}
</div>
28 changes: 0 additions & 28 deletions _plugins/callout.rb

This file was deleted.

3 changes: 1 addition & 2 deletions docs/4.0/components/alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ Alerts are available for any length of text, as well as an optional dismiss butt
</div>{% endfor %}
{% endexample %}

{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %}
{{ callout-include | markdownify }}
{% include callout-warning-color-assistive-technologies.md %}

### Link color

Expand Down
3 changes: 1 addition & 2 deletions docs/4.0/components/badge.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ Add any of the below mentioned modifier classes to change the appearance of a ba
<span class="badge badge-{{ color.name }}">{{ color.name | capitalize }}</span>{% endfor %}
{% endexample %}

{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %}
{{ callout-include | markdownify }}
{% include callout-warning-color-assistive-technologies.md %}

## Pill badges

Expand Down
5 changes: 3 additions & 2 deletions docs/4.0/components/button-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,14 @@ Wrap a series of buttons with `.btn` in `.btn-group`. Add on optional JavaScript
</div>
{% endexample %}

{% callout warning %}
{% capture callout %}
##### Ensure correct `role` and provide a label

In order for assistive technologies (such as screen readers) to convey that a series of buttons is grouped, an appropriate `role` attribute needs to be provided. For button groups, this would be `role="group"`, while toolbars should have a `role="toolbar"`.

In addition, groups and toolbars should be given an explicit label, as most assistive technologies will otherwise not announce them, despite the presence of the correct role attribute. In the examples provided here, we use `aria-label`, but alternatives such as `aria-labelledby` can also be used.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="warning" %}

## Button toolbar

Expand Down
8 changes: 4 additions & 4 deletions docs/4.0/components/buttons.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ Bootstrap includes several predefined button styles, each serving its own semant
<button type="button" class="btn btn-link">Link</button>
{% endexample %}

{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %}
{{ callout-include | markdownify }}
{% include callout-warning-color-assistive-technologies.md %}

## Button tags

Expand Down Expand Up @@ -94,11 +93,12 @@ Disabled buttons using the `<a>` element behave a bit different:
<a href="#" class="btn btn-secondary btn-lg disabled" tabindex="-1" role="button" aria-disabled="true">Link</a>
{% endexample %}

{% callout warning %}
{% capture callout %}
##### Link functionality caveat

The `.disabled` class uses `pointer-events: none` to try to disable the link functionality of `<a>`s, but that CSS property is not yet standardized. In addition, even in browsers that do support `pointer-events: none`, keyboard navigation remains unaffected, meaning that sighted keyboard users and users of assistive technologies will still be able to activate these links. So to be safe, add a `tabindex="-1"` attribute on these links (to prevent them from receiving keyboard focus) and use custom JavaScript to disable their functionality.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="warning" %}

## Button plugin

Expand Down
3 changes: 1 addition & 2 deletions docs/4.0/components/card.md
Original file line number Diff line number Diff line change
Expand Up @@ -392,8 +392,7 @@ Use [text and background utilities]({{ site.baseurl }}/docs/{{ site.docs_version
</div>{% endfor %}
{% endexample %}

{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %}
{{ callout-include | markdownify }}
{% include callout-warning-color-assistive-technologies.md %}

### Border

Expand Down
3 changes: 1 addition & 2 deletions docs/4.0/components/carousel.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap

### Methods

{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %}
{{ callout-include | markdownify }}
{% include callout-danger-async-methods.md %}

#### `.carousel(options)`

Expand Down
3 changes: 1 addition & 2 deletions docs/4.0/components/collapse.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap

### Methods

{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %}
{{ callout-include | markdownify }}
{% include callout-danger-async-methods.md %}

#### `.collapse(options)`

Expand Down
15 changes: 9 additions & 6 deletions docs/4.0/components/dropdowns.md
Original file line number Diff line number Diff line change
Expand Up @@ -591,9 +591,10 @@ Add `.disabled` to items in the dropdown to **style them as disabled**.

By default, a dropdown menu is automatically positioned 100% from the top and along the left side of its parent. Add `.dropdown-menu-right` to a `.dropdown-menu` to right align the dropdown menu.

{% callout info %}
{% capture callout %}
**Heads up!** Dropdowns are positioned thanks to Popper.js (except when they are contained in a navbar).
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="info" %}

{% example html %}
<div class="btn-group">
Expand Down Expand Up @@ -736,9 +737,10 @@ Use `data-offset` or `data-reference` to change the location of the dropdown.

Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the `.show` class on the parent list item. The `data-toggle="dropdown"` attribute is relied on for closing dropdown menus at an application level, so it's a good idea to always use it.

{% callout info %}
{% capture callout %}
On touch-enabled devices, opening a dropdown adds empty (`$.noop`) `mouseover` handlers to the immediate children of the `<body>` element. This admittedly ugly hack is necessary to work around a [quirk in iOS' event delegation](https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html), which would otherwise prevent a tap anywhere outside of the dropdown from triggering the code that closes the dropdown. Once the dropdown is closed, these additional empty `mouseover` handlers are removed.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="info" %}

### Via data attributes

Expand All @@ -763,11 +765,12 @@ Call the dropdowns via JavaScript:
$('.dropdown-toggle').dropdown()
{% endhighlight %}

{% callout info %}
{% capture callout %}
##### `data-toggle="dropdown"` still required

Regardless of whether you call your dropdown via JavaScript or instead use the data-api, `data-toggle="dropdown"` is always required to be present on the dropdown's trigger element.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="info" %}

### Options

Expand Down
25 changes: 15 additions & 10 deletions docs/4.0/components/forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -610,20 +610,22 @@ Custom form controls and selects are also supported.
</form>
{% endexample %}

{% callout warning %}
{% capture callout %}
##### Alternatives to hidden labels
Assistive technologies such as screen readers will have trouble with your forms if you don't include a label for every input. For these inline forms, you can hide the labels using the `.sr-only` class. There are further alternative methods of providing a label for assistive technologies, such as the `aria-label`, `aria-labelledby` or `title` attribute. If none of these are present, assistive technologies may resort to using the `placeholder` attribute, if present, but note that use of `placeholder` as a replacement for other labelling methods is not advised.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="warning" %}

## Help text

Block-level help text in forms can be created using `.form-text` (previously known as `.help-block` in v3). Inline help text can be flexibly implemented using any inline HTML element and utility classes like `.text-muted`.

{% callout warning %}
{% capture callout %}
##### Associating help text with form controls

Help text should be explicitly associated with the form control it relates to using the `aria-describedby` attribute. This will ensure that assistive technologies—such as screen readers—will announce this help text when the user focuses or enters the control.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="warning" %}

Help text below inputs can be styled with `.form-text`. This class includes `display: block` and adds some top margin for easy spacing from the inputs above.

Expand Down Expand Up @@ -683,25 +685,28 @@ Add the `disabled` attribute to a `<fieldset>` to disable all the controls withi
</form>
{% endexample %}

{% callout warning %}
{% capture callout %}
##### Caveat with anchors

By default, browsers will treat all native form controls (`<input>`, `<select>` and `<button>` elements) inside a `<fieldset disabled>` as disabled, preventing both keyboard and mouse interactions on them. However, if your form also includes `<a ... class="btn btn-*">` elements, these will only be given a style of `pointer-events: none`. As noted in the section about [disabled state for buttons]({{ site.baseurl }}/docs/{{ site.docs_version }}/components/buttons/#disabled-state) (and specifically in the sub-section for anchor elements), this CSS property is not yet standardized and isn't fully supported in Internet Explorer 10, and won't prevent keyboard users from being able to focus or activate these links. So to be safe, use custom JavaScript to disable such links.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="warning" %}

{% callout danger %}
{% capture callout %}
#### Cross-browser compatibility

While Bootstrap will apply these styles in all browsers, Internet Explorer 11 and below don't fully support the `disabled` attribute on a `<fieldset>`. Use custom JavaScript to disable the fieldset in these browsers.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="danger" %}

## Validation

Provide valuable, actionable feedback to your users with HTML5 form validation–[available in all our supported browsers](https://caniuse.com/#feat=form-validation). Choose from the browser default validation feedback, or implement custom messages with our built-in classes and starter JavaScript.

{% callout warning %}
{% capture callout %}
We currently recommend using custom validation styles, as native browser default validation messages are not consistently exposed to assistive technologies in all browsers (most notably, Chrome on desktop and mobile).
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="warning" %}

### How it works

Expand Down
3 changes: 1 addition & 2 deletions docs/4.0/components/list-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,7 @@ Contextual classes also work with `.list-group-item-action`. Note the addition o
</div>
{% endexample %}

{% capture callout-include %}{% include callout-warning-color-assistive-technologies.md %}{% endcapture %}
{{ callout-include | markdownify }}
{% include callout-warning-color-assistive-technologies.md %}

## With badges

Expand Down
3 changes: 1 addition & 2 deletions docs/4.0/components/modal.md
Original file line number Diff line number Diff line change
Expand Up @@ -596,8 +596,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap

### Methods

{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %}
{{ callout-include | markdownify }}
{% include callout-danger-async-methods.md %}

#### `.modal(options)`

Expand Down
8 changes: 4 additions & 4 deletions docs/4.0/components/navs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ Navigation available in Bootstrap share general markup and styles, from the base

The base `.nav` component is built with flexbox and provide a strong foundation for building all types of navigation components. It includes some style overrides (for working with lists), some link padding for larger hit areas, and basic disabled styling.

{% callout info %}
{% capture callout %}
The base `.nav` component does not include any `.active` state. The following examples include the class, mainly to demonstrate that this particular class does not trigger any special styling.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="info" %}

{% example html %}
<ul class="nav">
Expand Down Expand Up @@ -542,8 +543,7 @@ To make tabs fade in, add `.fade` to each `.tab-pane`. The first tab pane must a

### Methods

{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %}
{{ callout-include | markdownify }}
{% include callout-danger-async-methods.md %}

#### $().tab

Expand Down
13 changes: 7 additions & 6 deletions docs/4.0/components/popovers.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,12 @@ sagittis lacus vel augue laoreet rutrum faucibus.">

Use the `focus` trigger to dismiss popovers on the user's next click of a different element than the toggle element.

{% callout danger %}
{% capture callout %}
#### Specific markup required for dismiss-on-next-click

For proper cross-browser and cross-platform behavior, you must use the `<a>` tag, _not_ the `<button>` tag, and you also must include a [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) attribute.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="danger" %}

{% example html %}
<a tabindex="0" class="btn btn-lg btn-danger" role="button" data-toggle="popover" data-trigger="focus" title="Dismissible popover" data-content="And here's some amazing content. It's very engaging. Right?">Dismissible popover</a>
Expand Down Expand Up @@ -246,16 +247,16 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap
</tbody>
</table>

{% callout info %}
{% capture callout %}
#### Data attributes for individual popovers

Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="info" %}

### Methods

{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %}
{{ callout-include | markdownify }}
{% include callout-danger-async-methods.md %}

#### `$().popover(options)`

Expand Down
10 changes: 6 additions & 4 deletions docs/4.0/components/scrollspy.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,17 +256,19 @@ After adding `position: relative;` in your CSS, call the scrollspy via JavaScrip
$('body').scrollspy({ target: '#navbar-example' })
{% endhighlight %}

{% callout danger %}
{% capture callout %}
#### Resolvable ID targets required

Navbar links must have resolvable id targets. For example, a `<a href="#home">home</a>` must correspond to something in the DOM like `<div id="home"></div>`.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="danger" %}

{% callout info %}
{% capture callout %}
#### Non-`:visible` target elements ignored

Target elements that are not [`:visible` according to jQuery](https://api.jquery.com/visible-selector/) will be ignored and their corresponding nav items will never be highlighted.
{% endcallout %}
{% endcapture %}
{% include callout.html content=callout type="info" %}

### Methods

Expand Down
Loading