mdb-ui-kit/docs/getting-started/customization.md

1.8 KiB

layout title group
docs Customization options getting-started

Material Design for Bootstrap 4 is designed to be customized via Sass variables. You may customize any Bootstrap or BMD variable.

{% callout info %} The following assumes you have setup your build tools and are building successfully. {% endcallout %}

{% callout warning %} If overriding a variable via Sass, ensure that your are @importing the underscored file _core.scss not the main file used for distributions. For more information see this StackOverflow post. {% endcallout %}

Here are some ways to customize:

Installing via npm (recommended) or bower, customizing BMD is a breeze.

  1. Add bootstrap-material-design as a dependency to your package.json or your bower.json
  2. npm install OR bower install depending on your tool of choice
  3. Add either node_modules or bower_components in the includePaths for your grunt-sass, gulp-sass, or equivalent configurations so you are able to import without specifying the full path of the resource.
  4. In your application's SCSS, redefine any customized variable before @importing bootstrap material design. For example:
$brand-primary: #3f51b5;         // bootstrap variable
$mdb-label-color-focus: #303f9f; // mdb variable

@import "bootstrap-material-design/scss/core"; // make sure to use _core.scss!

3. Download the source and change/compile

{% callout warning %} This method is not recommended because it may be difficult to use source control and keep up to date with new releases. Please consider the recommended method above. {% endcallout %}

  1. Download the source via npm, bower or otherwise
  2. Change any of the variables
  3. Run gulp