From cfc16c94b5de26ef44a35f7fcff12fc62c1fe0ff Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Wed, 9 Jul 2014 21:15:57 -0700 Subject: move buttons, helpers, images to markdown --- docs/_includes/css/buttons.html | 174 ------------------------------------- docs/_includes/css/buttons.md | 174 +++++++++++++++++++++++++++++++++++++ docs/_includes/css/helpers.html | 188 ---------------------------------------- docs/_includes/css/helpers.md | 188 ++++++++++++++++++++++++++++++++++++++++ docs/_includes/css/images.html | 30 ------- docs/_includes/css/images.md | 30 +++++++ 6 files changed, 392 insertions(+), 392 deletions(-) delete mode 100644 docs/_includes/css/buttons.html create mode 100644 docs/_includes/css/buttons.md delete mode 100644 docs/_includes/css/helpers.html create mode 100644 docs/_includes/css/helpers.md delete mode 100644 docs/_includes/css/images.html create mode 100644 docs/_includes/css/images.md (limited to 'docs') diff --git a/docs/_includes/css/buttons.html b/docs/_includes/css/buttons.html deleted file mode 100644 index dbfc35610..000000000 --- a/docs/_includes/css/buttons.html +++ /dev/null @@ -1,174 +0,0 @@ -
-

Buttons

-

Use any of the available button classes to quickly create a styled button.

-
-

- - - - - - -

-
-{% highlight html %} - - - - - - - - - - - - - - - - - -{% endhighlight %} - -

Sizes

-

Fancy larger or smaller buttons? Add .btn-lg, .btn-sm, or .btn-xs for additional sizes.

-
-

- - -

-

- - -

-

- - -

-

- - -

-
-{% highlight html %} -

- - -

-

- - -

-

- - -

-

- - -

-{% endhighlight %} - -

Create block level buttons—those that span the full width of a parent— by adding .btn-block.

-
-
- - -
-
-{% highlight html %} - - -{% endhighlight %} - - -

Active state

-

Buttons will appear pressed (with a darker background, darker border, and inset shadow) when active. For <button> elements, this is done via :active. For <a> elements, it's done with .active. However, you may use .active on <button>s should you need to replicate the active state programmatically.

- -

Button element

-

No need to add :active as it's a pseudo-class, but if you need to force the same appearance, go ahead and add .active.

-

- - -

-{% highlight html %} - - -{% endhighlight %} - -

Anchor element

-

Add the .active class to <a> buttons.

-

- Primary link - Link -

-{% highlight html %} -Primary link -Link -{% endhighlight %} - - -

Disabled state

-

Make buttons look unclickable by fading them back 50%.

- -

Button element

-

Add the disabled attribute to <button> buttons.

-

- - -

-{% highlight html %} - - -{% endhighlight %} - -
-

Cross-browser compatibility

-

If you add the disabled attribute to a <button>, Internet Explorer 9 and below will render text gray with a nasty text-shadow that we cannot fix.

-
- -

Anchor element

-

Add the .disabled class to <a> buttons.

-

- Primary link - Link -

-{% highlight html %} -Primary link -Link -{% endhighlight %} -

- We use .disabled as a utility class here, similar to the common .active class, so no prefix is required. -

-
-

Link functionality caveat

-

This class uses pointer-events: none to try to disable the link functionality of <a>s, but that CSS property is not yet standardized and isn't fully supported in Opera 18 and below, or in Internet Explorer 11. So to be safe, use custom JavaScript to disable such links.

-
-
-

Context-specific usage

-

While button classes can be used on <a> and <button> elements, only <button> elements are supported within our nav and navbar components.

-
- - -

Button tags

-

Use the button classes on an <a>, <button>, or <input> element.

-
- Link - - - -
-{% highlight html %} -Link - - - -{% endhighlight %} - -
-

Cross-browser rendering

-

As a best practice, we highly recommend using the <button> element whenever possible to ensure matching cross-browser rendering.

-

Among other things, there's a bug in Firefox <30 that prevents us from setting the line-height of <input>-based buttons, causing them to not exactly match the height of other buttons on Firefox.

-
-
diff --git a/docs/_includes/css/buttons.md b/docs/_includes/css/buttons.md new file mode 100644 index 000000000..dbfc35610 --- /dev/null +++ b/docs/_includes/css/buttons.md @@ -0,0 +1,174 @@ +
+

Buttons

+

Use any of the available button classes to quickly create a styled button.

+
+

+ + + + + + +

+
+{% highlight html %} + + + + + + + + + + + + + + + + + +{% endhighlight %} + +

Sizes

+

Fancy larger or smaller buttons? Add .btn-lg, .btn-sm, or .btn-xs for additional sizes.

+
+

+ + +

+

+ + +

+

+ + +

+

+ + +

+
+{% highlight html %} +

+ + +

+

+ + +

+

+ + +

+

+ + +

+{% endhighlight %} + +

Create block level buttons—those that span the full width of a parent— by adding .btn-block.

+
+
+ + +
+
+{% highlight html %} + + +{% endhighlight %} + + +

Active state

+

Buttons will appear pressed (with a darker background, darker border, and inset shadow) when active. For <button> elements, this is done via :active. For <a> elements, it's done with .active. However, you may use .active on <button>s should you need to replicate the active state programmatically.

+ +

Button element

+

No need to add :active as it's a pseudo-class, but if you need to force the same appearance, go ahead and add .active.

+

+ + +

+{% highlight html %} + + +{% endhighlight %} + +

Anchor element

+

Add the .active class to <a> buttons.

+

+ Primary link + Link +

+{% highlight html %} +Primary link +Link +{% endhighlight %} + + +

Disabled state

+

Make buttons look unclickable by fading them back 50%.

+ +

Button element

+

Add the disabled attribute to <button> buttons.

+

+ + +

+{% highlight html %} + + +{% endhighlight %} + +
+

Cross-browser compatibility

+

If you add the disabled attribute to a <button>, Internet Explorer 9 and below will render text gray with a nasty text-shadow that we cannot fix.

+
+ +

Anchor element

+

Add the .disabled class to <a> buttons.

+

+ Primary link + Link +

+{% highlight html %} +Primary link +Link +{% endhighlight %} +

+ We use .disabled as a utility class here, similar to the common .active class, so no prefix is required. +

+
+

Link functionality caveat

+

This class uses pointer-events: none to try to disable the link functionality of <a>s, but that CSS property is not yet standardized and isn't fully supported in Opera 18 and below, or in Internet Explorer 11. So to be safe, use custom JavaScript to disable such links.

+
+
+

Context-specific usage

+

While button classes can be used on <a> and <button> elements, only <button> elements are supported within our nav and navbar components.

+
+ + +

Button tags

+

Use the button classes on an <a>, <button>, or <input> element.

+
+ Link + + + +
+{% highlight html %} +Link + + + +{% endhighlight %} + +
+

Cross-browser rendering

+

As a best practice, we highly recommend using the <button> element whenever possible to ensure matching cross-browser rendering.

+

Among other things, there's a bug in Firefox <30 that prevents us from setting the line-height of <input>-based buttons, causing them to not exactly match the height of other buttons on Firefox.

+
+
diff --git a/docs/_includes/css/helpers.html b/docs/_includes/css/helpers.html deleted file mode 100644 index dc992ee23..000000000 --- a/docs/_includes/css/helpers.html +++ /dev/null @@ -1,188 +0,0 @@ -
-

Helper classes

- -

Contextual colors

-

Convey meaning through color with a handful of emphasis utility classes. These may also be applied to links and will darken on hover just like our default link styles.

-
-

Fusce dapibus, tellus ac cursus commodo, tortor mauris nibh.

-

Nullam id dolor id nibh ultricies vehicula ut id elit.

-

Duis mollis, est non commodo luctus, nisi erat porttitor ligula.

-

Maecenas sed diam eget risus varius blandit sit amet non magna.

-

Etiam porta sem malesuada magna mollis euismod.

-

Donec ullamcorper nulla non metus auctor fringilla.

-
-{% highlight html %} -

...

-

...

-

...

-

...

-

...

-

...

-{% endhighlight %} -
-

Dealing with specificity

-

Sometimes emphasis classes cannot be applied due to the specificity of another selector. In most cases, a sufficient workaround is to wrap your text in a <span> with the class.

-
- -

Contextual backgrounds

-

Similar to the contextual text color classes, easily set the background of an element to any contextual class. Anchor components will darken on hover, just like the text classes.

-
-

Nullam id dolor id nibh ultricies vehicula ut id elit.

-

Duis mollis, est non commodo luctus, nisi erat porttitor ligula.

-

Maecenas sed diam eget risus varius blandit sit amet non magna.

-

Etiam porta sem malesuada magna mollis euismod.

-

Donec ullamcorper nulla non metus auctor fringilla.

-
-{% highlight html %} -

...

-

...

-

...

-

...

-

...

-{% endhighlight %} -
-

Dealing with specificity

-

Sometimes contextual background classes cannot be applied due to the specificity of another selector. In some cases, a sufficient workaround is to wrap your element's content in a <div> with the class.

-
- -

Close icon

-

Use the generic close icon for dismissing content like modals and alerts.

-
-

-
-{% highlight html %} - -{% endhighlight %} - -

Quick floats

-

Float an element to the left or right with a class. !important is included to avoid specificity issues. Classes can also be used as mixins.

-{% highlight html %} -
...
-
...
-{% endhighlight %} -{% highlight scss %} -// Classes -.pull-left { - float: left !important; -} -.pull-right { - float: right !important; -} - -// Usage as mixins -.element { - .pull-left(); -} -.another-element { - .pull-right(); -} -{% endhighlight %} - -
-

Not for use in navbars

-

To align components in navbars with utility classes, use .navbar-left or .navbar-right instead. See the navbar docs for details.

-
- - -

Center content blocks

-

Set an element to display: block and center via margin. Available as a mixin and class.

-{% highlight html %} -
...
-{% endhighlight %} -{% highlight scss %} -// Classes -.center-block { - display: block; - margin-left: auto; - margin-right: auto; -} - -// Usage as mixins -.element { - .center-block(); -} -{% endhighlight %} - - -

Clearfix

-

Easily clear floats by adding .clearfix to the parent element. Utilizes the micro clearfix as popularized by Nicolas Gallagher. Can also be used as a mixin.

-{% highlight html %} - -
...
-{% endhighlight %} -{% highlight scss %} -// Mixin itself -.clearfix() { - &:before, - &:after { - content: " "; - display: table; - } - &:after { - clear: both; - } -} - -// Usage as a Mixin -.element { - .clearfix(); -} -{% endhighlight %} - - -

Showing and hiding content

-

Force an element to be shown or hidden (including for screen readers) with the use of .show and .hidden classes. These classes use !important to avoid specificity conflicts, just like the quick floats. They are only available for block level toggling. They can also be used as mixins.

-

Furthermore, .invisible can be used to toggle only the visibility of an element, meaning its display is not modified and the element can still affect the flow of the document.

-{% highlight html %} -
...
- -{% endhighlight %} -{% highlight scss %} -// Classes -.show { - display: block !important; -} -.hidden { - display: none !important; - visibility: hidden !important; -} -.invisible { - visibility: hidden; -} - -// Usage as mixins -.element { - .show(); -} -.another-element { - .hidden(); -} -{% endhighlight %} - - -

Screen reader and keyboard navigation content

-

Hide an element to all devices except screen readers with .sr-only. Combine .sr-only with .sr-only-focusable to show the element again when it's focused (e.g. by a keyboard-only user). Necessary for following accessibility best practices. Can also be used as mixins.

-{% highlight html %} -Skip to main content -{% endhighlight %} -{% highlight scss %} -// Usage as a Mixin -.skip-navigation { - .sr-only(); - .sr-only-focusable(); -} -{% endhighlight %} - - -

Image replacement

-

Utilize the .text-hide class or mixin to help replace an element's text content with a background image.

-{% highlight html %} -

Custom heading

-{% endhighlight %} - {% highlight scss %} -// Usage as a Mixin -.heading { - .text-hide(); -} -{% endhighlight %} -
diff --git a/docs/_includes/css/helpers.md b/docs/_includes/css/helpers.md new file mode 100644 index 000000000..dc992ee23 --- /dev/null +++ b/docs/_includes/css/helpers.md @@ -0,0 +1,188 @@ +
+

Helper classes

+ +

Contextual colors

+

Convey meaning through color with a handful of emphasis utility classes. These may also be applied to links and will darken on hover just like our default link styles.

+
+

Fusce dapibus, tellus ac cursus commodo, tortor mauris nibh.

+

Nullam id dolor id nibh ultricies vehicula ut id elit.

+

Duis mollis, est non commodo luctus, nisi erat porttitor ligula.

+

Maecenas sed diam eget risus varius blandit sit amet non magna.

+

Etiam porta sem malesuada magna mollis euismod.

+

Donec ullamcorper nulla non metus auctor fringilla.

+
+{% highlight html %} +

...

+

...

+

...

+

...

+

...

+

...

+{% endhighlight %} +
+

Dealing with specificity

+

Sometimes emphasis classes cannot be applied due to the specificity of another selector. In most cases, a sufficient workaround is to wrap your text in a <span> with the class.

+
+ +

Contextual backgrounds

+

Similar to the contextual text color classes, easily set the background of an element to any contextual class. Anchor components will darken on hover, just like the text classes.

+
+

Nullam id dolor id nibh ultricies vehicula ut id elit.

+

Duis mollis, est non commodo luctus, nisi erat porttitor ligula.

+

Maecenas sed diam eget risus varius blandit sit amet non magna.

+

Etiam porta sem malesuada magna mollis euismod.

+

Donec ullamcorper nulla non metus auctor fringilla.

+
+{% highlight html %} +

...

+

...

+

...

+

...

+

...

+{% endhighlight %} +
+

Dealing with specificity

+

Sometimes contextual background classes cannot be applied due to the specificity of another selector. In some cases, a sufficient workaround is to wrap your element's content in a <div> with the class.

+
+ +

Close icon

+

Use the generic close icon for dismissing content like modals and alerts.

+
+

+
+{% highlight html %} + +{% endhighlight %} + +

Quick floats

+

Float an element to the left or right with a class. !important is included to avoid specificity issues. Classes can also be used as mixins.

+{% highlight html %} +
...
+
...
+{% endhighlight %} +{% highlight scss %} +// Classes +.pull-left { + float: left !important; +} +.pull-right { + float: right !important; +} + +// Usage as mixins +.element { + .pull-left(); +} +.another-element { + .pull-right(); +} +{% endhighlight %} + +
+

Not for use in navbars

+

To align components in navbars with utility classes, use .navbar-left or .navbar-right instead. See the navbar docs for details.

+
+ + +

Center content blocks

+

Set an element to display: block and center via margin. Available as a mixin and class.

+{% highlight html %} +
...
+{% endhighlight %} +{% highlight scss %} +// Classes +.center-block { + display: block; + margin-left: auto; + margin-right: auto; +} + +// Usage as mixins +.element { + .center-block(); +} +{% endhighlight %} + + +

Clearfix

+

Easily clear floats by adding .clearfix to the parent element. Utilizes the micro clearfix as popularized by Nicolas Gallagher. Can also be used as a mixin.

+{% highlight html %} + +
...
+{% endhighlight %} +{% highlight scss %} +// Mixin itself +.clearfix() { + &:before, + &:after { + content: " "; + display: table; + } + &:after { + clear: both; + } +} + +// Usage as a Mixin +.element { + .clearfix(); +} +{% endhighlight %} + + +

Showing and hiding content

+

Force an element to be shown or hidden (including for screen readers) with the use of .show and .hidden classes. These classes use !important to avoid specificity conflicts, just like the quick floats. They are only available for block level toggling. They can also be used as mixins.

+

Furthermore, .invisible can be used to toggle only the visibility of an element, meaning its display is not modified and the element can still affect the flow of the document.

+{% highlight html %} +
...
+ +{% endhighlight %} +{% highlight scss %} +// Classes +.show { + display: block !important; +} +.hidden { + display: none !important; + visibility: hidden !important; +} +.invisible { + visibility: hidden; +} + +// Usage as mixins +.element { + .show(); +} +.another-element { + .hidden(); +} +{% endhighlight %} + + +

Screen reader and keyboard navigation content

+

Hide an element to all devices except screen readers with .sr-only. Combine .sr-only with .sr-only-focusable to show the element again when it's focused (e.g. by a keyboard-only user). Necessary for following accessibility best practices. Can also be used as mixins.

+{% highlight html %} +Skip to main content +{% endhighlight %} +{% highlight scss %} +// Usage as a Mixin +.skip-navigation { + .sr-only(); + .sr-only-focusable(); +} +{% endhighlight %} + + +

Image replacement

+

Utilize the .text-hide class or mixin to help replace an element's text content with a background image.

+{% highlight html %} +

Custom heading

+{% endhighlight %} + {% highlight scss %} +// Usage as a Mixin +.heading { + .text-hide(); +} +{% endhighlight %} +
diff --git a/docs/_includes/css/images.html b/docs/_includes/css/images.html deleted file mode 100644 index 78f4c65b8..000000000 --- a/docs/_includes/css/images.html +++ /dev/null @@ -1,30 +0,0 @@ -
-

Images

- -

Responsive images

-

Images in Bootstrap 3 can be made responsive-friendly via the addition of the .img-responsive class. This applies max-width: 100%; and height: auto; to the image so that it scales nicely to the parent element.

-
-

SVG images and IE 8-10

-

In Internet Explorer IE 8-10, SVG images with .img-responsive are disproportionately sized. To fix this, add width: 100% \9; where necessary. Bootstrap doesn't apply this automatically as it causes complications to other image formats.

-
-{% highlight html %} -Responsive image -{% endhighlight %} - -

Image shapes

-

Add classes to an <img> element to easily style images in any project.

-
-

Cross-browser compatibility

-

Keep in mind that Internet Explorer 8 lacks support for rounded corners.

-
-
- A generic square placeholder image with rounded corners - A generic square placeholder image where only the portion within the circle circumscribed about said square is visible - A generic square placeholder image with a white border around it, making it resemble a photograph taken with an old instant camera -
-{% highlight html %} -... -... -... -{% endhighlight %} -
diff --git a/docs/_includes/css/images.md b/docs/_includes/css/images.md new file mode 100644 index 000000000..78f4c65b8 --- /dev/null +++ b/docs/_includes/css/images.md @@ -0,0 +1,30 @@ +
+

Images

+ +

Responsive images

+

Images in Bootstrap 3 can be made responsive-friendly via the addition of the .img-responsive class. This applies max-width: 100%; and height: auto; to the image so that it scales nicely to the parent element.

+
+

SVG images and IE 8-10

+

In Internet Explorer IE 8-10, SVG images with .img-responsive are disproportionately sized. To fix this, add width: 100% \9; where necessary. Bootstrap doesn't apply this automatically as it causes complications to other image formats.

+
+{% highlight html %} +Responsive image +{% endhighlight %} + +

Image shapes

+

Add classes to an <img> element to easily style images in any project.

+
+

Cross-browser compatibility

+

Keep in mind that Internet Explorer 8 lacks support for rounded corners.

+
+
+ A generic square placeholder image with rounded corners + A generic square placeholder image where only the portion within the circle circumscribed about said square is visible + A generic square placeholder image with a white border around it, making it resemble a photograph taken with an old instant camera +
+{% highlight html %} +... +... +... +{% endhighlight %} +
-- cgit v1.2.3