From ff8d28cf2501773ff6f7833865c8e2b2ebb76a3f Mon Sep 17 00:00:00 2001 From: Quy Date: Sat, 31 Dec 2016 16:12:28 -0800 Subject: Move .table-responsive from wrapper to .table --- docs/components/carousel.md | 124 ++++++++++---------- docs/components/collapse.md | 108 +++++++++--------- docs/components/modal.md | 128 ++++++++++----------- docs/components/popovers.md | 266 +++++++++++++++++++++---------------------- docs/components/scrollspy.md | 69 ++++++----- docs/components/tooltips.md | 254 ++++++++++++++++++++--------------------- 6 files changed, 463 insertions(+), 486 deletions(-) (limited to 'docs/components') diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 619ea780f..eac86ef81 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -184,50 +184,48 @@ $('.carousel').carousel() Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-interval=""`. -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
intervalnumber5000The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
keyboardbooleantrueWhether the carousel should react to keyboard events.
pausestring | null"hover"If set to "hover", pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave. If set to null, hovering over the carousel won't pause it.
ridestringfalseAutoplays the carousel after the user manually cycles the first item. If "carousel", autoplays the carousel on load.
wrapbooleantrueWhether the carousel should cycle continuously or have hard stops.
-
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
intervalnumber5000The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
keyboardbooleantrueWhether the carousel should react to keyboard events.
pausestring | null"hover"If set to "hover", pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave. If set to null, hovering over the carousel won't pause it.
ridestringfalseAutoplays the carousel after the user manually cycles the first item. If "carousel", autoplays the carousel on load.
wrapbooleantrueWhether the carousel should cycle continuously or have hard stops.
### Methods @@ -270,26 +268,24 @@ Bootstrap's carousel class exposes two events for hooking into carousel function All carousel events are fired at the carousel itself (i.e. at the `
`). -
- - - - - - - - - - - - - - - - - -
Event TypeDescription
slide.bs.carouselThis event fires immediately when the slide instance method is invoked.
slid.bs.carouselThis event is fired when the carousel has completed its slide transition.
-
+ + + + + + + + + + + + + + + + + +
Event TypeDescription
slide.bs.carouselThis event fires immediately when the slide instance method is invoked.
slid.bs.carouselThis event is fired when the carousel has completed its slide transition.
{% highlight js %} $('#myCarousel').on('slide.bs.carousel', function () { diff --git a/docs/components/collapse.md b/docs/components/collapse.md index e3172fa75..11017c234 100644 --- a/docs/components/collapse.md +++ b/docs/components/collapse.md @@ -124,32 +124,30 @@ $('.collapse').collapse() Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-parent=""`. -
- - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
parentselectorfalseIf a selector is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the panel class)
togglebooleantrueToggles the collapsible element on invocation
-
+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
parentselectorfalseIf a selector is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the panel class)
togglebooleantrueToggles the collapsible element on invocation
### Methods @@ -179,36 +177,34 @@ Hides a collapsible element. Bootstrap's collapse class exposes a few events for hooking into collapse functionality. -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.collapseThis event fires immediately when the show instance method is called.
shown.bs.collapseThis event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.collapse - This event is fired immediately when the hide method has been called. -
hidden.bs.collapseThis event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).
-
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Event TypeDescription
show.bs.collapseThis event fires immediately when the show instance method is called.
shown.bs.collapseThis event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.collapse + This event is fired immediately when the hide method has been called. +
hidden.bs.collapseThis event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).
{% highlight js %} $('#myCollapsible').on('hidden.bs.collapse', function () { diff --git a/docs/components/modal.md b/docs/components/modal.md index b311ebf35..5ace1ac58 100644 --- a/docs/components/modal.md +++ b/docs/components/modal.md @@ -508,44 +508,42 @@ Call a modal with id `myModal` with a single line of JavaScript: Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-backdrop=""`. -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
backdropboolean or the string 'static'trueIncludes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.
keyboardbooleantrueCloses the modal when escape key is pressed
focusbooleantruePuts the focus on the modal when initialized.
showbooleantrueShows the modal when initialized.
-
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
backdropboolean or the string 'static'trueIncludes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.
keyboardbooleantrueCloses the modal when escape key is pressed
focusbooleantruePuts the focus on the modal when initialized.
showbooleantrueShows the modal when initialized.
### Methods @@ -581,34 +579,32 @@ Manually hides a modal. **Returns to the caller before the modal has actually be Bootstrap's modal class exposes a few events for hooking into modal functionality. All modal events are fired at the modal itself (i.e. at the `
`). -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.modalThis event fires immediately when the show instance method is called. If caused by a click, the clicked element is available as the relatedTarget property of the event.
shown.bs.modalThis event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the relatedTarget property of the event.
hide.bs.modalThis event is fired immediately when the hide instance method has been called.
hidden.bs.modalThis event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
-
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Event TypeDescription
show.bs.modalThis event fires immediately when the show instance method is called. If caused by a click, the clicked element is available as the relatedTarget property of the event.
shown.bs.modalThis event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the relatedTarget property of the event.
hide.bs.modalThis event is fired immediately when the hide instance method has been called.
hidden.bs.modalThis event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
{% highlight js %} $('#myModal').on('hidden.bs.modal', function (e) { diff --git a/docs/components/popovers.md b/docs/components/popovers.md index 1cd96da49..e4ace2ed9 100644 --- a/docs/components/popovers.md +++ b/docs/components/popovers.md @@ -163,113 +163,111 @@ Enable popovers via JavaScript: Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-animation=""`. -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
animationbooleantrueApply a CSS fade transition to the popover
containerstring | falsefalse -

Appends the popover to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.

-
contentstring | element | function'' -

Default content value if data-content attribute isn't present.

-

If a function is given, it will be called with its this reference set to the element that the popover is attached to.

-
delaynumber | object0 -

Delay showing and hiding the popover (ms) - does not apply to manual trigger type

-

If a number is supplied, delay is applied to both hide/show

-

Object structure is: delay: { "show": 500, "hide": 100 }

-
htmlbooleanfalseInsert HTML into the popover. If false, jQuery's text method will be used to insert content into the DOM. Use text if you're worried about XSS attacks.
placementstring | function'right' -

How to position the popover - top | bottom | left | right.

-

When a function is used to determine the placement, it is called with the popover DOM node as its first argument and the triggering element DOM node as its second. The this context is set to the popover instance.

-
selectorstringfalseIf a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See this and an informative example.
templatestring'<div class="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-title"></h3><div class="popover-content"></div></div>' -

Base HTML to use when creating the popover.

-

The popover's title will be injected into the .popover-title.

-

The popover's content will be injected into the .popover-content.

-

.popover-arrow will become the popover's arrow.

-

The outermost wrapper element should have the .popover class.

-
titlestring | element | function'' -

Default title value if title attribute isn't present.

-

If a function is given, it will be called with its this reference set to the element that the popover is attached to.

-
triggerstring'click'How popover is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.
constraintsArray'hover focus'An array of constraints - passed through to Tether. For more information refer to Tether's constraint docs.
offsetstring'0 0'Offset of the popover relative to its target. For more information refer to Tether's offset docs.
-
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
animationbooleantrueApply a CSS fade transition to the popover
containerstring | falsefalse +

Appends the popover to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.

+
contentstring | element | function'' +

Default content value if data-content attribute isn't present.

+

If a function is given, it will be called with its this reference set to the element that the popover is attached to.

+
delaynumber | object0 +

Delay showing and hiding the popover (ms) - does not apply to manual trigger type

+

If a number is supplied, delay is applied to both hide/show

+

Object structure is: delay: { "show": 500, "hide": 100 }

+
htmlbooleanfalseInsert HTML into the popover. If false, jQuery's text method will be used to insert content into the DOM. Use text if you're worried about XSS attacks.
placementstring | function'right' +

How to position the popover - top | bottom | left | right.

+

When a function is used to determine the placement, it is called with the popover DOM node as its first argument and the triggering element DOM node as its second. The this context is set to the popover instance.

+
selectorstringfalseIf a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See this and an informative example.
templatestring'<div class="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-title"></h3><div class="popover-content"></div></div>' +

Base HTML to use when creating the popover.

+

The popover's title will be injected into the .popover-title.

+

The popover's content will be injected into the .popover-content.

+

.popover-arrow will become the popover's arrow.

+

The outermost wrapper element should have the .popover class.

+
titlestring | element | function'' +

Default title value if title attribute isn't present.

+

If a function is given, it will be called with its this reference set to the element that the popover is attached to.

+
triggerstring'click'How popover is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.
constraintsArray'hover focus'An array of constraints - passed through to Tether. For more information refer to Tether's constraint docs.
offsetstring'0 0'Offset of the popover relative to its target. For more information refer to Tether's offset docs.
{% callout info %} #### Data attributes for individual popovers @@ -310,34 +308,32 @@ Hides and destroys an element's popover. Popovers that use delegation (which are ### Events -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.popoverThis event fires immediately when the show instance method is called.
shown.bs.popoverThis event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.popoverThis event is fired immediately when the hide instance method has been called.
hidden.bs.popoverThis event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).
-
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Event TypeDescription
show.bs.popoverThis event fires immediately when the show instance method is called.
shown.bs.popoverThis event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.popoverThis event is fired immediately when the hide instance method has been called.
hidden.bs.popoverThis event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).
{% highlight js %} $('#myPopover').on('hidden.bs.popover', function () { diff --git a/docs/components/scrollspy.md b/docs/components/scrollspy.md index 74829267e..a1f04ad9c 100644 --- a/docs/components/scrollspy.md +++ b/docs/components/scrollspy.md @@ -117,45 +117,42 @@ $('[data-spy="scroll"]').each(function () { Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-offset=""`. -
- - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
offsetnumber10Pixels to offset from top when calculating position of scroll.
-
+ + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
offsetnumber10Pixels to offset from top when calculating position of scroll.
### Events -
- - - - - - - - - - - - - -
Event TypeDescription
activate.bs.scrollspyThis event fires whenever a new item becomes activated by the scrollspy.
-
+ + + + + + + + + + + + + +
Event TypeDescription
activate.bs.scrollspyThis event fires whenever a new item becomes activated by the scrollspy.
+ {% highlight js %} $('#myScrollspy').on('activate.bs.scrollspy', function () { // do something… diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md index 31fb2c1c7..deb84b778 100644 --- a/docs/components/tooltips.md +++ b/docs/components/tooltips.md @@ -146,107 +146,105 @@ You should only add tooltips to HTML elements that are traditionally keyboard-fo Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-animation=""`. -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
animationbooleantrueApply a CSS fade transition to the tooltip
containerstring | element | falsefalse -

Appends the tooltip to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the tooltip in the flow of the document near the triggering element - which will prevent the tooltip from floating away from the triggering element during a window resize.

-
delaynumber | object0 -

Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type

-

If a number is supplied, delay is applied to both hide/show

-

Object structure is: delay: { "show": 500, "hide": 100 }

-
htmlbooleanfalse -

Allow HTML in the tooltip.

-

If true, HTML tags in the tooltip's title will be rendered in the tooltip. If false, jQuery's text method will be used to insert content into the DOM.

-

Use text if you're worried about XSS attacks.

-
placementstring | function'top' -

How to position the tooltip - top | bottom | left | right.

-

When a function is used to determine the placement, it is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The this context is set to the tooltip instance.

-
selectorstringfalseIf a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See this and an informative example.
templatestring'<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>' -

Base HTML to use when creating the tooltip.

-

The tooltip's title will be injected into the .tooltip-inner.

-

.tooltip-arrow will become the tooltip's arrow.

-

The outermost wrapper element should have the .tooltip class.

-
titlestring | element | function'' -

Default title value if title attribute isn't present.

-

If a function is given, it will be called with its this reference set to the element that the tooltip is attached to.

-
triggerstring'hover focus'How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.
constraintsArray[]An array of constraints - passed through to Tether. For more information refer to Tether's constraint docs.
offsetstring'0 0'Offset of the popover relative to its target. For more information refer to Tether's offset docs.
-
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
animationbooleantrueApply a CSS fade transition to the tooltip
containerstring | element | falsefalse +

Appends the tooltip to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the tooltip in the flow of the document near the triggering element - which will prevent the tooltip from floating away from the triggering element during a window resize.

+
delaynumber | object0 +

Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type

+

If a number is supplied, delay is applied to both hide/show

+

Object structure is: delay: { "show": 500, "hide": 100 }

+
htmlbooleanfalse +

Allow HTML in the tooltip.

+

If true, HTML tags in the tooltip's title will be rendered in the tooltip. If false, jQuery's text method will be used to insert content into the DOM.

+

Use text if you're worried about XSS attacks.

+
placementstring | function'top' +

How to position the tooltip - top | bottom | left | right.

+

When a function is used to determine the placement, it is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The this context is set to the tooltip instance.

+
selectorstringfalseIf a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See this and an informative example.
templatestring'<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>' +

Base HTML to use when creating the tooltip.

+

The tooltip's title will be injected into the .tooltip-inner.

+

.tooltip-arrow will become the tooltip's arrow.

+

The outermost wrapper element should have the .tooltip class.

+
titlestring | element | function'' +

Default title value if title attribute isn't present.

+

If a function is given, it will be called with its this reference set to the element that the tooltip is attached to.

+
triggerstring'hover focus'How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.
constraintsArray[]An array of constraints - passed through to Tether. For more information refer to Tether's constraint docs.
offsetstring'0 0'Offset of the popover relative to its target. For more information refer to Tether's offset docs.
{% callout info %} #### Data attributes for individual tooltips @@ -286,34 +284,32 @@ Hides and destroys an element's tooltip. Tooltips that use delegation (which are ### Events -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.tooltipThis event fires immediately when the show instance method is called.
shown.bs.tooltipThis event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.tooltipThis event is fired immediately when the hide instance method has been called.
hidden.bs.tooltipThis event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).
-
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Event TypeDescription
show.bs.tooltipThis event fires immediately when the show instance method is called.
shown.bs.tooltipThis event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.tooltipThis event is fired immediately when the hide instance method has been called.
hidden.bs.tooltipThis event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).
{% highlight js %} $('#myTooltip').on('hidden.bs.tooltip', function () { -- cgit v1.2.3