CoreUI & Parcel

The official guide for how to include and bundle CoreUI’s CSS and JavaScript in your project using Parcel.

🤖 Looking for the LLM-optimized version? View llm.md

On this page

Setup

We’re building a Parcel project with CoreUI from scratch, so there are some prerequisites and up front steps before we can really get started. This guide requires you to have Node.js installed and some familiarity with the terminal.

Create a project folder and setup npm. We’ll create the my-project folder and initialize npm with the -y argument to avoid it asking us all the interactive questions.
```
mkdir my-project && cd my-project
npm init -y
```
Install Parcel. Unlike our Webpack guide, there’s only a single build tool dependency here. Parcel will automatically install language transformers (like Sass) as it detects them. We use --save-dev to signal that this dependency is only for development use and not for production.
```
npm i --save-dev parcel
```
Install CoreUI. Now we can install CoreUI. We’ll also install Popper since our dropdowns, popovers, and tooltips depend on it for their positioning. If you don’t plan on using those components, you can omit Popper here.
```
npm i --save @coreui/coreui @popperjs/core
```
For PRO users
```
npm i --save @coreui/coreui-pro @popperjs/core
```

Now that we have all the necessary dependencies installed, we can get to work creating the project files and importing CoreUI.

Project structure

We’ve already created the my-project folder and initialized npm. Now we’ll also create our src folder, stylesheet, and JavaScript file to round out the project structure. Run the following from my-project, or manually create the folder and file structure shown below.

mkdir {src,src/js,src/scss}
touch src/index.html src/js/main.js src/scss/styles.scss

When you’re done, your complete project should look like this:

my-project/
├── src/
│   ├── js/
│   │   └── main.js
│   ├── scss/
│   │   └── styles.scss
│   └── index.html
├── package-lock.json
└── package.json

At this point, everything is in the right place, but Parcel needs an HTML page and npm script to start our server.

Configure Parcel

With dependencies installed and our project folder ready for us to start coding, we can now configure Parcel and run our project locally. Parcel itself requires no configuration file by design, but we do need an npm script and an HTML file to start our server.

Fill in the src/index.html file. Parcel needs a page to render, so we use our index.html page to set up some basic HTML, including our CSS and JavaScript files.

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>CoreUI w/ Parcel</title>
    <link rel="stylesheet" href="scss/styles.scss">
    <script type="module" src="js/main.js"></script>
  </head>
  <body>
    <div class="container py-4 px-3 mx-auto">
      <h1>Hello, CoreUI and Parcel!</h1>
      <button class="btn btn-primary">Primary button</button>
    </div>
  </body>
</html>

We’re including a little bit of CoreUI styling here with the div class="container" and <button> so that we see when CoreUI’s CSS is loaded by Webpack.

Parcel will automatically detect we’re using Sass and install the Sass Parcel plugin to support it. However, if you wish, you can also manually run npm i --save-dev @parcel/transformer-sass.

Add the Parcel npm scripts. Open the package.json and add the following start script to the scripts object. We’ll use this script to start our Parcel development server and render the HTML file we created after it’s compiled into the dist directory.
```
{
   // ...
   "scripts": {
     "start": "parcel serve src/index.html --public-url / --dist-dir dist",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   // ...
}
```
And finally, we can start Parcel. From the my-project folder in your terminal, run that newly added npm script:
```
npm start
```

In the next and final section to this guide, we’ll import all of CoreUI’s CSS and JavaScript.

Import CoreUI

Importing CoreUI into Parcel requires two imports, one into our styles.scss and one into our main.js.

Import CoreUI’s CSS. Add the following to src/scss/styles.scss to import all of CoreUI’s source Sass.

Heads up! Since @coreui/coreui v5.3.0 and @coreui/coreui-pro v5.10.0, we support Sass modules.

You can now use the modern @use and @forward rules instead of @import, which is deprecated and will be removed in Dart Sass 3.0.0. Using @import will result in a compilation warning. You can learn more about this transition here.
```
// Use all of CoreUI's CSS
@use "~@coreui/coreui/scss/coreui";

// Or use all of CoreUI PRO's CSS
@use "~@coreui/coreui-pro/scss/coreui";
```
Sass @import are deprecated and will be removed in Dart Sass 3.0.0.!

You can also use @import rules, but please be aware that they are deprecated and will be removed in Dart Sass 3.0.0, resulting in a compilation warning. You can learn more about this deprecation here.
```
// Import all of CoreUI's CSS
@import "~@coreui/coreui/scss/coreui";

// Or import all of CoreUI PRO's CSS
@import "~@coreui/coreui-pro/scss/coreui";
```
You can also import our stylesheets individually if you want. Read our Sass import docs for details.

Import CoreUI’s JS. Add the following to src/js/main.js to import all of CoreUI’s JS. Popper will be imported automatically through CoreUI.

// Import all of CoreUI's JS
import * as coreui from '@coreui/coreui'

// Or import all of CoreUI PRO's JS
import * as coreui from '@coreui/coreui-pro'

You can also import JavaScript plugins individually as needed to keep bundle sizes down:

import Alert from '@coreui/coreui/js/dist/alert'

// or, specify which plugins you need:
import { Tooltip, Toast, Popover } from '@coreui/coreui'

Read our JavaScript docs for more information on how to use CoreUI’s plugins.

And you’re done! 🎉 With CoreUI’s source Sass and JS fully loaded, your local development server should now look like this.

Now you can start adding any CoreUI components you want to use.