A common Label and Icon, helper utilities, and elemental components.
npm i -D @smui/common
Common Label and Icon
The common label and icon are also exported from each package that uses them.
Many SMUI components let you customize which DOM element is used to render them. This is done with the SmuiElement component.
In the SMUI components that let you customize which DOM element is used to render them, you can also use the Svg component to render an SVG.
Common Features and Use Patterns
Because Svelte limits your CSS to only the current component, you need to use a ":global" selector to target SMUI elements.
Events and Modifiers
SMUI supports listening to all events. You can also use modifiers with the "$" syntax.
Build a class string from a map of class names to conditions. This is
useful when you need to add classes to a component, since Svelte's
"class:" directives don't work on components. (It's also useful for
actions that take
Dispatch a custom event. This differs from Svelte's component event
system, because these events require a DOM element as a target, can bubble
(and do by default), and are cancelable with
event.preventDefault(). All SMUI events are dispatched with this instead of Svelte's
Caught Event Detail: undefined
Exclude and Prefix Filter
Exclude differs from normal
omit functions by also excluding all
properties that begin with a given string if that string ends with "$". Prefix
Filter filters an object for only properties with a certain prefix. They are
usually used together to allow props to be given to multiple elements within
Forward Events Builder
Build an action to allow **all** events to be forwarded from a Svelte component, with support for event modifiers using the "$" syntax.
- This is especially useful for UI library components, as it is
generally unknown which events will be required from them for all
desired use cases. For example, if a Button component only forwards a
clickevent, then no use case that requires the
keypressevent can be used with it.
- In addition, a component that uses Svelte's built in event forwarding
system cannot allow event listeners on the "capture" phase of the
event lifecycle. It also cannot allow events to be cancelable with the
browser's built in
preventDefaultfunction. In fact, the one big advantage to Svelte's event system, the fact that you don't need an element as an event target, doesn't even apply to UI library components.
Clicked: 0, Key Pressed: None, Focused: false
An action that takes actions and runs them on the element. Used to allow actions on components, and forward actions from one component to another, until the ultimate component finally renders the DOM element.
A function that announces a string of text to users who are using a screen reader.
Class Adder Builder
Use this to build a ClassAdder component. ClassAdder components are useful for reducing the size of your bundle. If you have tons of simple components that just need to add classes/props or set a context, using ClassAdder components means there's only one actual Svelte component in your bundle for all of these many tiny components.