Bootstrap 5 & Material Design UI KIT
Go to file
2015-11-20 08:26:54 -06:00
demo/imgs reorganized structure 2014-10-31 09:27:35 +01:00
dist Solves #559 - https://github.com/FezVrasta/bootstrap-material-design/issues/559#issuecomment-158114338 2015-11-19 11:07:47 -06:00
docs changing includes 2015-11-20 08:26:54 -06:00
fonts Merge pull request #452 from jmillspaysbills/master 2015-03-17 17:07:48 +01:00
grunt initial import of bs3 docs 2015-11-19 15:58:21 -06:00
less Solves #559 - https://github.com/FezVrasta/bootstrap-material-design/issues/559#issuecomment-158114338 2015-11-19 11:07:47 -06:00
meteor Wait for page load during test 2015-10-30 12:58:31 +00:00
sass Solves #559 - https://github.com/FezVrasta/bootstrap-material-design/issues/559#issuecomment-158114338 2015-11-19 11:07:47 -06:00
scripts remove old commented code. 2015-11-18 20:52:23 -06:00
test removed tests from build task 2015-03-16 15:45:18 +01:00
_config.yml initial import of bs3 docs 2015-11-19 15:58:21 -06:00
.editorconfig fixed #253 2014-12-02 09:05:46 +01:00
.gitignore stubbed in index and about information 2015-11-19 17:18:15 -06:00
.jshintrc Initial upload. 2014-08-18 16:25:33 +02:00
.npmignore Add .npmignore 2015-11-19 19:48:34 +01:00
.ruby-gemset prepare grunt-less-to-sass 2015-11-02 13:42:29 -06:00
.ruby-version prepare grunt-less-to-sass 2015-11-02 13:42:29 -06:00
.travis.yml fixing travis configuration for new container infrastructure and add the sass gem 2015-11-19 09:03:53 -06:00
.versions fixed meteor and probably travis 2015-03-17 16:36:14 +01:00
bootstrap-elements.html Allow floating labels to be used with input groups that have a left input. Update readme. 2015-11-18 16:43:19 -06:00
bower.json - remove deprecated version from bower.json https://github.com/bower/spec/blob/master/json.md 2015-11-19 08:54:33 -06:00
CHANGELOG.md updated changelog and moved to new dev version (0.3.1-dev) 2015-03-18 15:44:56 +01:00
CONTRIBUTING.md update contrib guidelines 2015-11-19 12:12:24 -06:00
custom-color-palette.sh Create custom-color-palette.sh 2015-05-10 19:42:16 +02:00
Gemfile stubbed in index and about information 2015-11-19 17:18:15 -06:00
Gruntfile.js Merge branch 'rosskevin-master' into documentation-prototype 2015-11-19 16:03:28 -06:00
index.css checkpoint before transitioning label styles to form-group 2015-11-17 12:02:44 -06:00
index.html Allow floating labels to be used with input groups that have a left input. Update readme. 2015-11-18 16:43:19 -06:00
LICENSE.md MIT 2015-07-07 15:02:26 +02:00
package.js Update Meteor version requirement 2015-10-30 12:17:55 +00:00
package.json Merge branch 'rosskevin-master' into documentation-prototype 2015-11-19 16:03:28 -06:00
README.md Updated contribution guidelines and codepen dependencies to bootstrap 3.3.5 2015-11-19 10:57:00 -06:00

bootstrap-material-design

build status gratipay Bower version

banner

This Bootstrap theme is an easy way to use the new Material Design guidelines by Google in your Bootstrap 3 based application. Just include the theme, after the Bootstrap CSS and include the JavaScript at the end of your document (just before the </body> tag), and everything will be converted to Material Design (Paper) style.

NOTE: This theme is still in development, it could be used on production websites but I can't guarantee compatibility with previous versions.

Check out the demo at this link.

How to install

You may install this theme using Bower or Meteor:

  • Bower : bower install bootstrap-material-design
  • Meteor: meteor add fezvrasta:bootstrap-material-design

If you prefer, you can include this framework in your project using our official CDN:

Getting started

Navigate to the dist/ folder in this repository, and you will see the test.html file, which has the CSS include statements, in the head section and the JS includes just before body section closes. You need to copy the dist/ folder to the root of your project, ensuring that all the files in your project can access the files through the relative URL, supplied in the CSS and the JS includes.

material-fullpalette.css or material.css?

The only difference is that material-fullpalette.css has the full colors palette available (large file), the other one has just the primary colors (small file).

Use custom color as primary

Is often asked how to change the primary color of this theme without edit the bower package directly.

You can do it by creating a less file in your project:

@import "../bower_components/bootstrap-material-design/less/material.less";

// Override @primary color with one took from _colors.less
@primary: @deep-purple;

Then, compiling this file, the entire theme will be compiled using the color chosen by you.

Support

If you like this project you may support it by donating via Gittip, starring this repository or reporting issues. All issues filed should be reduced to a CodePen test case where possible.

gittip issues

Contribute

Please see the CONTRIBUTING.md file.

Development

We are using Grunt to automate the workflow and build process. Ensure you have nodejs installed and grunt-cli installed globally. After cloning the repo, run npm install to ensure you have all dev dependencies.

Grunt

  • grunt build - run the tests and compile the less/sass. See Gruntfile.js for details on targets.
  • grunt test - browser-based Jasmine unit tests.
  • grunt serve - build and fire up an http server with live-reload and a watch for development purposes.

LESS & SASS

The bootstrap 3.x compatible version (master) is developed using LESS, with an automated conversion to SASS.

The upcoming 4.x version (no branch yet) will be developed using SASS.

Documentation

Material Design (spec) for Bootstrap provides styles for bootstrap based markup to comply with Material Design concepts.

Color Variations

There are 17 additional color variations (in addition to the classic 4 variations) for buttons, inputs, checkboxes, radios, alerts, navbars, tabs, labels, paginations, progress bars and more. They can be used by adding the class suffix -material-color to the desired element and replacing color with the desired one.

Example:

<button class="btn btn-material-deep-purple">Deep purple button</button>

These colors are taken from the Material Design color palette and are reported below:

palette

To take advantage of all the shades please use material-fullpalette.css, but please be aware of its huge size.

Forms

All inputs should be surrounded by a standard .form-group, and as such material.js will enforce this. The .form-group is used to signal different input styles and variations. See the examples for variations.

Sizing

In general, it is preferred that sizing be altered with either .form-group-sm or .form-group-lg. Due to the interconnected nature of inputs, labels, margins and padding, material.js will convert any use of .input-sm or .input-lg to .form-group-sm or .form-group-lg in order to reduce the necessary markup/variations and get a standard sizing with fewer side effects.

Buttons

Add .btn-flat to a button to make it flat, without shadows. Add .btn-raised to a button to add a permanent shadow to it.

Inputs

Labels

The following classes should be placed on the .form-group to indicate the label style:

  • .label-floating - renders label as a placeholder, that animates above the field upon focus
  • .label-static - renders label above the field. input placeholder attribute can also be used in conjunction
  • .label-placeholder - renders a label as a placeholder only
  • no label, but use of input placeholder attribute - same rendering as .label-placeholder
Hints

Upon focus, a hint can be displayed. Use any p | span with .help-block.

Examples
  <div class="form-group label-static">
    <label for="i2" class="control-label">label-static</label>
    <input type="email" class="form-control" id="i2" placeholder="placeholder attribute">
    <p class="help-block">This is a hint as a <code>p.help-block.hint</code></p>
  </div>

  <div class="form-group label-floating">
    <label for="i5" class="control-label">label-floating</label>
    <input type="email" class="form-control" id="i5">
    <span class="help-block">This is a hint as a <code>span.help-block.hint</code></span>
  </div>

  <div class="form-group label-placeholder">
    <label for="i5p" class="control-label">label-placeholder</label>
    <input type="email" class="form-control" id="i5p">
    <span class="help-block">This is a hint as a <code>span.help-block.hint</code></span>
  </div>

Radio, Checkbox, Toggle

Be sure to inspect the source of the demos to find proper markup examples. Remember to use the proper HTML markup.

Radio example:

<div class="form-group">
  <label class="col-lg-2 control-label">Radios</label>

  <div class="col-lg-10">
    <div class="radio radio-primary">
      <label>
        <input type="radio" name="optionsRadios" checked="">
        Option one
      </label>
    </div>
    <div class="radio radio-primary">
      <label>
        <input type="radio" name="optionsRadios">
        Option two
      </label>
    </div>
  </div>
</div>

Icons

Material Design for Bootstrap includes 490 original Material Design icons! These icons are extracted from the original Google sources and are licensed under the BSD license. They are provided as an iconic and easy to use font.

Variations are available for every icon, including the original Bootstrap icons.

The syntax to add a Material icon is:

<i class="icon icon-material-favorite"></i>

Cards

A card will expand to fill all of the available width (e.g. column's width). Card's height will be automatically resized to match width.

Here is an example on how to use it:

<div class="card">

    <div class="card-height-indicator"></div>

    <div class="card-content">

        <div class="card-image">
            <img src="./image.jpg" alt="Loading image...">
            <h3 class="card-image-headline">Lorem Ipsum Dolor</h3>
        </div>

        <div class="card-body">
            <p>Lorem Ipsum is simply dummy text of the printing and typesetting industry.</p>
        </div>

        <footer class="card-footer">
            <button class="btn btn-flat">Share</button>
            <button class="btn btn-flat btn-warning">Learn More</button>
        </footer>

    </div>

</div>

Cards will adapt to column's width. The card below will have width equal to col-lg-6:

<div class="row">
    <div class="col-lg-3"></div>

    <div class="col-lg-6">
        <div class="card">
            ...
        </div>
    </div>

    <div class="col-lg-3"></div>
</div>

material.js

material.js is a jQuery plugin that adds some magic to your markup and allows Material Design for Bootstrap to style some elements like inputs, checkboxes, radios etc.

Functions

  • $.material.init() - shortcut to run all the following commands:
  • $.material.ripples() will apply ripples.js to the default elements.
  • $.material.input() will enable the MD style to the text inputs, and other kind of inputs (number, email, file etc).
  • $.material.checkbox(): will enable the MD style to the checkboxes (remember to follow the markup guidelines explained in the Inputs section.
  • $.material.radio(): will enable the MD style to the checkboxes (remember to follow the markup guidelines explained in the Inputs section.

Apply only to specific elements

Every function expects an optional value that will be used as a selector for the function; for example, $.material.ripples("#selector, #foobar") will apply Ripples.js only to #selector and #foobar. The functions that allows an optional selector are $.material.ripples, $.material.input, $.material.checkbox and $.material.radio.

You can even override the default values using the $.material.options function. The default values are:

$.material.options = {
    "withRipples": ".btn:not(.btn-link), .card-image, .navbar a:not(.withoutripple), .nav-tabs a:not(.withoutripple), .withripple",
    "inputElements": "input.form-control, textarea.form-control, select.form-control",
    "checkboxElements": ".checkbox > label > input[type=checkbox]",
    "radioElements": ".radio > label > input[type=radio]"
}

Arrive.js support

If you need to dynamically add elements to your DOM then you may need to include Arrive.js before Material.js. This will automatically apply material.js to every new element added via JavaScript.

Plugins

Material Design for Bootstrap comes with styling support for various external scripts:

SnackbarJS

Create snackbars and toasts with the SnackbarJS plugin. The default toast style is the squared one (snackbar style). If you like to use the rounded style (toast style), please add the toast class to the style option of SnackbarJS.

RipplesJS

This is part of the Material Design for Bootstrap project and is a plain JavaScript script which creates the ripple effect when clicking on the specified elements. At the moment RipplesJS does not have its own repository but it will probably have one in the future.

You may want to set a custom color to the ripples of a specific element, to do so write:

<button class="btn btn-default" data-ripple-color="#F0F0F0">Custom ripple</button>

noUiSlider

Make cross-browser sliders and get them styled with Material Design thanks to the support provided by this theme. Read more about noUiSlider here.

Dropdown.js

Finally a dropdown plugin that transforms select inputs in nice dropdowns and does not drive you crazy. Read more about Dropdown.js here.

Selectize.js

Transform select and multi-select inputs into advanced text inputs. Material Design for BS provides a full replacement of the plugin's CSS, so don't include it. Read more about selectize.js.

Bootstrap Material Datepicker

A Material Design datepicker created to be used with Material Design for Bootstrap.
Read more about Bootstrap Material Datepicker

Compatibility

Currently, Material Design for Bootstrap supports Google Chrome (tested v37+), Mozilla Firefox (tested 30+), and Internet Explorer (tested 11+). Mobile browsers are not currently tested but they may work.

License

MIT License