INSTALL.md

Installation

To get started, install the SMUI packages you need.

npm install --save-dev @smui/button
npm install --save-dev @smui/card
# etc...

You can also use SMUI in the Svelte REPL.

SvelteKit

For SvelteKit, check out the SvelteKit instructions. Otherwise, read on.

Importing Components

Please note that these imports require a theme. See the default or custom theme below.

You will always import Svelte components from the individual packages.

<script>
  import Button from '@smui/button';
</script>

Material Fonts

If you want the Material Icon, Roboto, and Roboto Mono fonts, be sure to include these stylesheets (or include them from a package).

<!-- Material Icons -->
<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/icon?family=Material+Icons"
/>
<!-- Roboto -->
<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,600,700"
/>
<!-- Roboto Mono -->
<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/css?family=Roboto+Mono"
/>

Installing a Theme

The Default Theme

You can use the prebuilt "bare.css" file from the "svelte-material-ui" package. If you use this option you can mostly customize your theme, but your theming options are more limited.

npm install --save svelte-material-ui

<link rel="stylesheet" href="node_modules/svelte-material-ui/bare.css" />

If that's not working (probably because your dependencies aren't copied to your build folder), you can also use a CDN. Just be sure you update the version here when you update to a new version of SMUI. (This may already be an outdated version, so update it now too.)

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/[email protected]/bare.min.css"
/>

You can also use the "bare.css" files from the individual packages if you don't use many components and want smaller file sizes.

A Custom Theme

Check out the theming instructions for setting up a custom theme.