Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 1.59 KB

README.md

File metadata and controls

60 lines (37 loc) · 1.59 KB
Raw

Svelte Material UI - Form Field

A wrapper to align an input and its label.

MDC Form Fields make the Input/Label RTL-aware and also activates a ripple effect.

Installation

npm install --save-dev @smui/form-field

Demo

See it in action.

See the demo code.

Whoa There, These Docs are Outdated

The latest SMUI v3 had a lot of changes, and these docs haven't been caught up yet. You should check out the demo page's code to see the latest usage.

Basic Usage

<FormField>
  <Checkbox bind:checked={amIChecked} />
  <span slot="label">Am I Checked</span>
</FormField>

<script>
  import FormField from '@smui/form-field';
  import Checkbox from '@smui/checkbox';

  let amIChecked = false;
</script>

Exports

(default)

A Form Field component.

Props / Defaults

  • use: [] - An array of Svelte actions and/or arrays of an action and its options.
  • class: '' - A CSS class string.
  • align: 'start' - Where to align the input. ('start' or 'end')
  • inputId: (programatically assigned) - The ID of the input the label is to be associated with.

The ID is generated using a module context counter, so you don't need to provide one yourself. The format is SMUI-form-field-{counter}, and the counter starts at 0.

Forwarded Props

  • label$ - Props forwarded to the label element.

More Information

See Form Field in MDC-Web for information about the upstream library's architecture.