--- layout: layouts/page.njk title: Installation description: How to install and use Basecoat in your app. toc: - label: Install using the CDN id: install-cdn children: - label: Install all components id: install-cdn-all - label: Install specific components id: install-cdn-specific - label: Installing using NPM id: install-npm children: - label: "Step 1: Add Tailwind CSS" id: install-npm-tailwind - label: "Step 2: Add Basecoat" id: install-npm-basecoat - label: "Step 3: Import Basecoat" id: install-npm-import - label: "Step 4: Add JavaScript files" id: install-npm-js - label: "Step 5: Use components" id: install-npm-done - label: Components with JavaScript id: install-js --- {% from "macros/code_block.njk" import code_block %} {% from "tabs.njk" import tabs %}

Install using the CDN

Install all components

Add the following to the <head> of your HTML file:

{% set code %} {% endset %} {{ code_block(code, "html") }}

The default CDN stylesheet is the Basecoat backward-compatible default. To use a specific style, load the matching standalone stylesheet instead:

{% set code %}{% endset %} {{ code_block(code, "html") }}

Install specific components

While the JavaScript file for all components is small (around 3kB gzipped), you can cherry-pick the components you need as instructed in the component's page (Dropdown Menu, Popover, Select, Sidebar, Tabs and Toast). For example, to add the Dropdown Menu component, add the following to the <head> of your HTML file:

{% set code %} {% endset %} {{ code_block(code, "html") }}

Install using NPM

Step 1: Add Tailwind CSS

Basecoat uses Tailwind CSS. You need to install it in your project.

Follow the Tailwind CSS installation instructions to get started.

Step 2: Add Basecoat

Add Basecoat to your Tailwind CSS file.

{% set code_npm %}npm install basecoat-css{% endset %} {% set code_pnpm %}pnpm add basecoat-css{% endset %} {% set code_bun %}bun add basecoat-css{% endset %} {% set code_yarn %}yarn add basecoat-css{% endset %} {% set tabsets = [ { tab: "npm", panel: code_block(code_npm, class="") }, { tab: "pnpm", panel: code_block(code_pnpm, class="") }, { tab: "bun", panel: code_block(code_bun, class="") }, { tab: "yarn", panel: code_block(code_yarn, class="") } ] %} {{ tabs(id="npm-install", tabsets=tabsets) }}

Alternatively, you can directly copy the basecoat.css file into your project.

Step 3: Import Basecoat

{% set code %}@import "tailwindcss"; @import "basecoat-css";{% endset %} {{ code_block(code, "css") }}

The default import is the Basecoat backward-compatible default. To use a specific style, import the standalone style bundle instead:

{% set code %}@import "tailwindcss"; @import "basecoat-css/sera";{% endset %} {{ code_block(code, "css") }}

Step 4: Add JavaScript files

Some components need some JavaScript (e.g. the Tabs component). There are two ways to get it into your project:

Using a build tool (Vite, Webpack…)

If your project is ESM-aware you can directly import the scripts. To include all components:

{% set code %}{% raw %}import 'basecoat-css/all';{% endraw %}{% endset %} {{ code_block(code, "js") }}

Or cherry-pick specific components, for example:

{% set code %}{% raw %}import 'basecoat-css/basecoat'; import 'basecoat-css/popover'; import 'basecoat-css/tabs';{% endraw %}{% endset %} {{ code_block(code, "js") }}

Without a build tool

Copy the pre-built files from node_modules into your public directory:

{% set code %}npx copyfiles -u 1 "node_modules/basecoat-css/dist/js/**/*" public/js/basecoat{% endset %} {{ code_block(code, "bash") }}

Then reference the script you need as well as the basecoat.min.js file (used to register and initialize components):

{% set code %} {% endset %} {{ code_block(code, "html") }}

See each component page for the minimal script required.

Step 5: Use components

You can now use any of the Basecoat classes in your project (e.g. btn, card, input, etc). Read the documentation about each component to get started (e.g. button, card, input, etc).

Some components (e.g. Select) require JavaScript code to work.

Components with JavaScript

A handful of components require JavaScript code to work, specifically Dropdown Menu, Popover, Select, Sidebar, Tabs and Toast

If a component requires JavaScript, the documentation page will provide instructions. There are 2 options to add the JavaScript code to your project: