Installation guide

5 min Quick Start

Prerequisites

Before you use MDB Vue make sure to install Vue CLI package (4.0.0 or higher recommended). This package contains environment that will speed up the development process. Node LTS 8.9 or higher is required.

To install Vue CLI, in Your command line type:

npm install -g @vue/clioryarn global add @vue/cli

Prerequisites

Step 1: Create Vue App

vue create my-app

Step 2: Navigate to App's directory

cd my-app

MDB installation

Step 1: Setup MDB

vue add mdb

choose New app or Existing app template from the list
select Free version
choose one of the styling options New
- compiled in the mdbvue package (CSS)
- editable in your project (SCSS)
decide whether to install Roboto font New
decide whether to install Font Awesome 5 New

Step 2: Launch Your App

npm start or yarn start

Prerequisites

Step 1: Create Vue App

vue create my-app

Step 2: Navigate to App's directory

cd my-app

MDB installation

Step 1: Setup MDB

vue add mdb

choose New app or Existing app template from the list
select Pro version
enter your gitlab access token - see token generation
choose one of the styling options New
- compiled in the mdbvue package (CSS)
- editable in your project (SCSS)
decide whether to install Roboto font New
decide whether to install Font Awesome 5 New

Step 2: Launch Your App

npm start or yarn start

Tree shaking New

Consider tree shaking if you plan to import only a few of our components. Using this mode will significantly reduce the size of js output files.

To use this mode you just need to import each component separately from the mdbvue/lib/components directory.

Basic example:

import { mdbContainer, mdbRow, mdbBtn } from 'mdbvue'

Tree shaking example:

import mdbContainer from 'mdbvue/lib/components/mdbContainer'
import mdbRow from 'mdbvue/lib/components/mdbRow'
import mdbBtn from 'mdbvue/lib/components/mdbBtn'

Registering all components New

To register all components globally in your app add the following code to main.js file. Keep in mind that this type of import will significantly increase the size of js output files.

main.js


        import * as mdbvue from 'mdbvue'
        for (const component in mdbvue) {
          Vue.component(component, mdbvue[component])
        }

SCSS editable mode New

This mode let you write custom scss code, as well as update our scss core files or variables.

Keep in mind that editable styling mode will only work after installing node-sass and sass-loader dependencies. This will be done automatically in basic installation mode. Our CLI plugin will copy all necessary files to the mdb directory and will import them in App.vue file between <style lang="scss"></style> tags, just like in the example:

Free
Pro

App.vue


            $image-path: '~@/../mdb/mdbvue/img';  // image path variable update
            @import '~@/../mdb/mdbvue/scss/mdb-free.scss'; // main mdb scss free file
            @import url('https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap'); // font import

App.vue


            $image-path: '~@/../mdb/mdbvue/img';  // image path variable update
            @import '~@/../mdb/mdbvue/scss/mdb-pro.scss'; // main mdb scss pro file
            @import url('https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap'); // font import

New project (zipped package)

Step 1: If you haven't downloaded MDB Vue package yet, go to Getting Started page and download it now.

Step 2: Unzip downloaded package and open Your unpacked directory.

Step 3: Install the dependencies. Depending on Your node module manager, run:*

npm installoryarn

*if You want to install dependency from our GitLab repository, please open package.json file and copy the link to our repo from the commented line ("//": "git+https://oauth2:..."). Then replace the direct path to mdbvue.tgz in dependencies by the copied link. Finally paste Your GitLab Access Token instead REPLACE_WITH_YOUR_TOKEN and run installation as exlained above.

Step 4: Now it's time to write the second command which let us serve our app on localhost using:

npm startoryarn start

Step 5: When you check what is served at Your port 8080 you should see app default screen.

Step 6: Explore our documentation. Choose components you like, copy it to your project and compose your website. And yes, it's that simple!

Step 7 (optional): You can also launch our Demonstration Page. The files with the code are placed in the demo directory.

npm run demooryarn demo

Step 8 (optional): If You want to remove our demo from Your App, easily type:

npm run remove-demooryarn remove-demo

Existing project (manual installation)

Free
Pro

Prerequisites

Step 1: Create a new Vue project using the official CLI:

vue create my-project

Step 2: Access project's directory

cd my-project

MDB installation

Step 1: Install MDB Vue

npm install --save mdbvueoryarn add mdbvue

Step 2: Import style files in Your src/main.js by adding tje following lines at the beginning:

import 'bootstrap-css-only/css/bootstrap.min.css'

          import 'mdbvue/lib/css/mdb.min.css'

          import '@fortawesome/fontawesome-free/css/all.min.css

Step 3: Install Roboto font (optional)

In your App.vue file between <style></style> tags add the following line:
@import url('https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap');

Step 4: Run your app

npm run serveoryarn serve

Prerequisites

Step 1: Create a new Vue project using the official CLI:

vue create my-project

Step 2: Access project's directory

cd my-project

MDB installation

Step 1: GitLab installation

Generate token - see Token generation
Navigate to given repository, switch GIT to HTTP and copy it's URL i.e.: https://git.mdbootstrap.com/mdb/vue/vu-pro.git

Adjust the following link as per below
"git+https://oauth2: + access_token + @ + repo address"
i.e.
git+https://oauth2:jFzMYzqSBUmGm3Z1ZA9s@git.mdbootstrap.com/mdb/vue/vu-pro.git

Within existing vue project run:
npm install git+https://oauth2:jFzMYzqSBUmGm3Z1ZA9s@git.mdbootstrap.com/mdb/vue/vu-pro.git --save // OR
yarn add git+https://oauth2:jFzMYzqSBUmGm3Z1ZA9s@git.mdbootstrap.com/mdb/vue/vu-pro.git

alternatively, you can update your dependencies in package.json like below:
"dependencies": { "mdbvue": "git+https://oauth2:jFzMYzqSBUmGm3Z1ZA9s@git.mdbootstrap.com/mdb/vue/vu-pro.git" }

Then run npm install or yarn to install the dependencies

Step 2: Import style files in Your src/main.js by adding tje following lines at the beginning:

import 'bootstrap-css-only/css/bootstrap.min.css'

          import 'mdbvue/lib/css/mdb.min.css'

          import '@fortawesome/fontawesome-free/css/all.min.css

Step 3: Install Roboto font (optional)

In your App.vue file between <style></style> tags add the following line:
@import url('https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap');

Step 4: Run your app

npm run serveoryarn serve

CDN installation

You can easily test MDB Vue components by adding CDN scripts to your classic HTML template without the need for installing any packages.

There is also an option to add MDB Vue Pro to your classic HTML template using static files, which were delivered via ZIP package. All necessary files are placed inside the lib directory.

Free
Pro

HTML


            <!DOCTYPE html>
            <html>
              <head>
                <title>MDB Vue Test App</title>
                <meta charset="utf-8">
                <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no, minimal-ui">
                <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
                <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/mdbvue/lib/css/mdb.min.css">
              </head>
              <body>
    
                <div id="app">
                  <mdb-btn color="primary">Button</mdb-btn>
                </div>
    
                <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
                <script src="https://cdn.jsdelivr.net/npm/mdbvue/lib/index.js"></script>
                <script>
                  new Vue({
                    el: '#app',
                    components: {
                      mdbBtn: mdbvue.mdbBtn
                    }
                  })
                </script>
              </body>
            </html>

HTML


            <!DOCTYPE html>
            <html>
              <head>
                <title>MDB Vue Test App</title>
                <meta charset="utf-8">
                <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no, minimal-ui">
                <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
                <link rel="stylesheet" href="mdbvue/lib/css/mdb.min.css">
              </head>
              <body>
    
                <div id="app">
                  <mdb-btn color="primary">Button</mdb-btn>
                </div>
    
                <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
                <script src="mdbvue/lib/index.js"></script>
                <script>
                  new Vue({
                    el: '#app',
                    components: {
                      mdbBtn: mdbvue.mdbBtn
                    }
                  })
                </script>
              </body>
            </html>

Plugins installation

Demo application:

MDB plugins are ready to use just after download is completed. To start the demo application, please follow these steps:

Step 1: Unzip archive.

Step 2: Start terminal inside the plugin directory.

Step 3: Run npm install command to add dependencies.

Step 4: Run npm run serve command to start the demo application.

Existing project:

If you need to use the plugin in a custom project, follow the instructions below:

Step 1: Unzip archive.

Step 2: Copy plugin file (the one with tgz extension) from unpacked dir to an existing project.

Step 3: Add plugin to dependencies in package.json, i.e. "mdb-sortable": "./mdb-sortable-5.0.0.tgz".

Step 4: Run npm install command to add dependencies and plugin.

Step 5: Import plugin inside your project by using the following code: import mdbSortable from 'mdb-sortable'

Step 6: Run npm run serve command to start the application.

Token generation

Step 1: Visit https://git.mdbootstrap.com and log in. If you are PRO user and do not have an account yet, please request one contacting us: contact@mdbootstrap.com

Step 2: From top right corner click at your avatar and choose "Setting → Access Tokens"

Step 3: Provide a Name for your token and choose "api" from scopes. Then click "Create personal access token"
add token

Step 4: Once your token will be generated make sure to copy it and store in safe place. You won't be able to access it again. In case of lose, you will have to generate new token again.
token