core-logo

Introduction

CoreUI is the fastest way to build a modern dashboard for any platforms, browser or device. A complete Dashboard UI Kit that allows you to quickly build eye-catching, high-quality, high-performance responsive applications.

On this page:



Quick start

Looking to quickly add CoreUI to your project? Use our CDN. Using a package manager or need to download the source files? Head to the downloads page.

CSS

Copy-paste the stylesheet <link> into your <head> before all other stylesheets to load our CSS.

<link rel="stylesheet" href="https://unpkg.com/@coreui/[email protected]/dist/css/coreui.min.css" integrity="sha384-p/WdGX2kFAEOObtADdDqY5bloEKthu6Qhym/UZh4EyLpHs8QpMdC31BkxxSxLXqo" crossorigin="anonymous">

JS

Many of our components require the use of JavaScript to function. Specifically, they require our own JavaScript plugins and Popper.js. Place the following <script>s near the end of your pages, right before the closing </body> tag, to enable them. Popper.js must come first, and then our JavaScript plugins.

Multiple of our components need the use of JavaScript to function. Especially, they need Popper.js, and our own JavaScript plugins. Put the following <script>s near the end of your pages, right before the closing </body> tag, to enable them. jQuery must come first, then Popper.js, then CoreUI and then our JavaScript plugins.

<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.15.0/umd/popper.min.js" integrity="sha384-L2pyEeut/H3mtgCBaUNw7KWzp5n9&#43;4pDQiExs933/5QfaTh8YStYFFkOzSoXjlTb" crossorigin="anonymous"></script>
<script src="https://unpkg.com/@coreui/[email protected]/dist/js/coreui.min.js" integrity="sha384-xzq5MjfYLblBm0qE9aJufGXDvVFxWcCH4BHpIl0a9DY02TG8AaQ8Jz6jccyZwSt1" crossorigin="anonymous"></script>

If you use <script type="module">, please refer to our using CoreUI as a module section.

Curious which components explicitly require our JavaScript and Popper.js? Click the show components link below. If you’re at all unsure about the general page structure, keep reading for an example page template.

Our coreui.bundle.js and coreui.bundle.min.js include Popper. For more information about what’s included in CoreUI, please see our contents section.

Show components requiring JavaScript
  • Alerts for dismissing
  • Buttons for toggling states and checkbox/radio functionality
  • Carousel for all slide behaviors, controls, and indicators
  • Collapse for toggling visibility of content
  • Dropdowns for displaying and positioning (also requires Popper.js)
  • Modals for displaying, positioning, and scroll behavior
  • Navbar for extending our Collapse plugin to implement responsive behavior
  • Tooltips and popovers for displaying and positioning (also requires Popper.js)
  • Scrollspy for scroll behavior and navigation updates

Starter template

Be sure to have your pages set up with the latest design and development standards. That means using an HTML5 doctype and including a viewport meta tag for proper responsive behaviors. Put it all together and your pages should look like this:

<!doctype html>
<html lang="en">
  <head>
    <!-- Required meta tags -->
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <!-- CoreUI CSS -->
    <link rel="stylesheet" href="https://unpkg.com/@coreui/[email protected]/dist/css/coreui.min.css" integrity="sha384-p/WdGX2kFAEOObtADdDqY5bloEKthu6Qhym/UZh4EyLpHs8QpMdC31BkxxSxLXqo" crossorigin="anonymous">

    <title>CoreUI</title>
  </head>
  <body class="c-app">
    <h1>Hello, world!</h1>

    <!-- Optional JavaScript -->
    <!-- Popper.js first, then CoreUI JS -->
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.15.0/umd/popper.min.js" integrity="sha384-L2pyEeut/H3mtgCBaUNw7KWzp5n9&#43;4pDQiExs933/5QfaTh8YStYFFkOzSoXjlTb" crossorigin="anonymous"></script>
    <script src="https://unpkg.com/@coreui/[email protected]/dist/js/coreui.min.js" integrity="sha384-xzq5MjfYLblBm0qE9aJufGXDvVFxWcCH4BHpIl0a9DY02TG8AaQ8Jz6jccyZwSt1" crossorigin="anonymous"></script>
  </body>
</html>

That’s all you need for overall page requirements. Visit the Layout docs to start laying out your site’s content and components.

Important globals

CoreUI 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

CoreUI 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

CoreUI 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">

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

Box-sizing

For more straightforward sizing in CSS, we switch the global box-sizing value from content-box to border-box. This ensures padding does not affect the final computed width of an element, but it can cause problems with some third party software like Google Maps and Google Custom Search Engine.

On the rare occasion you need to override it, use something like the following:

.selector-for-some-widget {
  box-sizing: content-box;
}

With the above snippet, nested elements—including generated content via ::before and ::after—will all inherit the specified box-sizing for that .selector-for-some-widget.

Learn more about box model and sizing at CSS Tricks.

Reboot

For improved cross-browser rendering, we use Reboot to correct inconsistencies across browsers and devices while providing slightly more opinionated resets to common HTML elements.

Community

Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.