@smui/floating-label

Svelte Material UI - Floating Label

A floating label in an input field. This is usually provided by the input component, but you can set it up manually.

Installation

You won't generally need to install this package, unless you're manually creating text fields.

npm install --save-dev @smui/floating-label

Examples and Usage Information

https://sveltematerialui.com/demo/textfield

Exports

(default)

A Floating Label component.

Props / Defaults

• use: [] - An array of Svelte actions and/or arrays of an action and its options.
• class: '' - A CSS class string.
• for: '' - The ID of the input the label is to be associated with.
• floatAbove: false - Float the label above.
• required: false - Add required styling (an asterisk).
• wrapped: false - If the label is wrapped, a span element is used with no for attribute, otherwise, a label element is used with a for attribute.

Functions

• shake(boolean) - Shakes the label element.
• float(boolean) - Floats the label element.
• getWidth() - Get the width of the label element.
• setRequired(boolean) - Set the required property.

More Information

See Text fields in the Material design spec.

See Floating Label in MDC-Web for information about the upstream library's architecture.

Changelog

7.0.0-beta.10 (2023-06-28)

Bug Fixes

• import ambient types from index files for ts event support (d62e12c)
• import specifically the module version of segmented button (0a26e4a)
• move from prop_def to ComponentProps (191126e)
• reference ambient types instead of importing them (2d1193c)
• remove reliance on svelte internals from forward events builder (dea2cc9)
• remove svg types from list (bbcd9e9)
• suppress typescript issues with importing svelte internals (985183c)

Features

• migration to Svelte 4 in components (51d2411)
• use new generics definitions for better typing of components with tag prop (4476f3a)