Quick start

To start using this design system you will need to import some files in your current project or start from scratch using our template (scroll down in this page to view it).

Steps to install

  1. Make sure you have Node.js installed.

  2. Navigate to the main directory (from terminal) where package.json is located.

  3. Run npm install or yarn install.

  4. Run npm run serve or yarn serve to start the local development server and start prototyping.

Argon Design System

Argon Design System is built as Vue plugin so you can simply import it and use it. 

import Vue from 'vue';
import Argon from "./plugins/argon-kit";
Vue.use(Argon);

Global Components

Argon Design System comes with an extensive set of custom Vue components. Some of them are globally instantiated so it’s easier to use them across the app without importing them each time.

Here’s the list of global components:

  • Badge
  • BaseAlert
  • BaseButton
  • BaseCheckbox
  • BaseInput
  • BasePagination
  • BaseProgress
  • BaseRadio
  • BaseSlider
  • BaseSwitch
  • Card
  • Icon

Local Components

Besides the components mentioned above, we have some extra components/plugins that are usually less used and bigger. In order to not affect the overall bundle size of the Argon Dashboard, they should be imported locally.

You can find the components inside src/components/.

Starter Template

To get started faster, we provide a starter template inside the project. It’s a bare bones layout with nav, footer and a hello world. To enable it go to main.js and change line 3 

import Vue from "vue";
import App from "./App.vue";
import router from "./starterRouter";

CSS

First of all, you will need to add to your own public/index.html file (you mounting .html file, in our case it is public/index.html) the following: 

<!-- Fonts -->
<link
href="https://fonts.googleapis.com/css?family=Open+Sans:300,400,600,700"
rel="stylesheet"
/>

After that, you will need to import our styles into your own mounting js file, in our case, we’ve imported them inside src/plugins/argon-kit.js like so: 

import "@/assets/scss/argon-design-system.scss";
import "@/assets/vendor/nucleo/css/nucleo-icons.css";
import "@/assets/vendor/font-awesome/css/font-awesome.css";

Important globals

Argon Design System PRO employs a handful of important global styles and settings that you’ll need to be aware of when using it, all of which are almost exclusively geared towards the normalization of cross browser styles. Let’s dive in.

HTML5 doctype

Bootstrap requires the use of the HTML5 doctype. Without it, you’ll see some funky incomplete styling, but including it shouldn’t cause any considerable hiccups. 

<!doctype html>
<html lang="en">
  ...
</html>

Responsive meta tag

Bootstrap is developed mobile first, a strategy in which we optimize code for mobile devices first and then scale up components as necessary using CSS media queries. To ensure proper rendering and touch zooming for all devices, add the responsive viewport meta tag to your <head>. 

<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

You can see an example of this in action in the starter template.

Bootstrap components

Many of Bootstrap’s components and utilities are built with @each loops that iterate over a Sass map. This is especially helpful for generating variants of a component by our $theme-colors and creating responsive variants for each breakpoint. As you customize these Sass maps and recompile, you’ll automatically see your changes reflected in these loops.

Bootstrap tutorial

Please check our official Youtube channel for more tutorials.