@smui/paper

Svelte Material UI - Paper

An elevated and/or colored surface.

Installation

npm install --save-dev @smui/paper

Whoa There, These Docs are Outdated

The latest SMUI v3 beta 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

<Paper>
  <Title>Paper</Title>
  <Subtitle>This is a sheet of paper.</Subtitle>
  <Content>Paper is used to build an elevated surface.</Content>
</Paper>

<script>
  import Paper, { Title, Subtitle, Content } from '@smui/paper';
</script>

Demo

in action: https://sveltematerialui.com/demo/paper

demo code: https://github.com/hperrin/svelte-material-ui/blob/master/site/src/routes/demo/paper/

Exports

(default)

A paper surface.

Props / Defaults

• use: [] - An array of Svelte actions and/or arrays of an action and its options.
• class: '' - A CSS class string.
• square: false - Whether the component has square or rounded corners.
• color: 'default' - The component's color. ('primary', 'secondary' or 'default')
• elevation: 1 - The component's elevation. (integer between 0 and 24, inclusive)
• transition: false - Trigger a transition animation when elevation is changed.

Events

All standard UI events are forwarded.

Title

A fragment used as a title on the Paper.

Equivalent to the ClassAdder with H5 common component.

Subtitle

A fragment used as a subtitle on the Paper.

Equivalent to the ClassAdder with H6 common component.

Content

A fragment used as a body of the Paper.

Equivalent to the ClassAdder with Div common component.

More Information

See Elevation in the Material design spec.

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

Changelog

3.0.0-beta.4 (2021-04-12)

Bug Fixes

• outlined select menu labels (020cb0c)

Features

• new Banner component (566fa13)