A library of Svelte Material UI components, based on Material Design Components - Web.
Demos, Code Samples, and Guides
Features
Here are some unique features that help SMUI stand out:
- Full TypeScript support, including HTML attributes.
- You can add arbitrary attributes to all of the components and many of the elements within them.
- You can add actions to the components with
use={[Action1, [Action2, action2Props], Action3]}. - You can add props to lower components and elements with "$" props, like
input$maxlength="15". - All events are forwarded. This includes DOM events, SMUI events, and custom events.
- You can add event modifiers with the
on:click$preventDefault$capture={handler}syntax.- You have to use "$" instead of "|" like in native Svelte. (The extra S inside the | stands for SMUI.)
- Supported modifiers are:
- passive
- nonpassive
- capture
- once
- preventDefault
- stopPropagation
- stopImmediatePropagation
- self
- trusted
- You can add event modifiers with the
- SMUI supports RTL languages.
Installation
To get started, check out the installation docs or the SvelteKit docs.
Need Help?
If you need help installing or using SMUI, join the Discord server.
Svelte 5
SMUI v7 works with Svelte 4 only, due to the way it handles events.
SMUI v8 is in development, and works with Svelte 5 (and not Svelte 4). You can view the readme on the v8 branch.
You can install SMUI v8 by specifying the alpha tag when you install, like npm i -D @smui/button@alpha.
Migration
Upgrading from an old version? Be sure to read the migration doc.
Upgrading from v6? You need Svelte 4. No more elemental components; you can now use the "tag" prop to change the element. No more "ComponentDev" types; components can now be used as their type. Check out the upgrade instructions.
Upgrading from v5? If you're still using the advanced styling method, it's really time to switch to the easy styling method. '/styled' endpoints are no longer provided. Check out the upgrade instructions.
Upgrading from v4? SMUI v5 requires the TypeScript preprocessor. SMUI v6 does not though, so if you upgrade straight to v6, don't worry. Check out the upgrade instructions.
Upgrading from v3? SMUI's styling method has been simplified. Check out the upgrade instructions.
Upgrading from v2? There are lots of changes listed in the upgrade instructions.
Old Docs
You can find older versions of the docs on their respective branch:
Icons
You can include icons in a number of ways, but the easiest is the Material Icon Font. This will give you the standard set of Material Icons, available with the CSS class "material-icons".
<link
href="https://fonts.googleapis.com/icon?family=Material+Icons"
rel="stylesheet"
/>However, there are two downsides. First is that all icons are downloaded, no matter which ones you use, so the size over the wire will almost certainly be more than necessary. Second is that it only includes the Material Icons from Google.
Another option is the Material Design Icons library. See the "Using SVGs" demo on the Icon Button demo page for instructions to use icons from the @mdi/js package (or any other SVG icons).
You can even use them in data URLs:
To get a data URL for the icon:
- Find your icon and click "View SVG" under the code menu.
- Click the "SVG File" tab and copy the full SVG document.
- Base64 encode the document.
- Format the URL like this
data:image/svg+xml;base64,encodedcontent, replacing "encodedcontent" with the Base64 results. - Now you have an image URL you can use in an "img" tag src attribute or anywhere else you put an image URL (like
background-image: url();).
Components
Click a component/package below to go to the documentation. (Note that this documentation is a work in progress. The demo code should be your main source of truth for how something works.)
- Accordion‡
- Action Buttons
- App Bars
- Badge‡
- Banner
- Card
- Common
- Data Table
- Dialog
- Drawer
- Elevation†
- Image List
- Inputs and Controls
- Layout Grid
- List
- Menu Surface
- Menu
- Paper‡
- Progress Indicators
- Ripple
- Snackbar
- Tabs
- Tooltip
- Touch Target
- Typography†
† This is Sass based, and therefore doesn't require Svelte components. I've included a demo showing how you can use it.
‡ This is not an MDC-Web component (upstream library). It is an addition that SMUI provides.
- Labels and icons are named exports in the components that use them, or you can use the 'Label' and 'Icon' exports from '@smui/common'. (Except for chips labels and icons, textfield icons, and select icons, because they are special snowflakes.)
License
Copyright 2019-2024 Hunter Perrin
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.