Skip to content

Latest commit

 

History

History
169 lines (124 loc) · 5 KB

README.md

File metadata and controls

169 lines (124 loc) · 5 KB
Raw

Svelte Material UI - Cards

A container for media and actions.

Installation

npm install --save-dev @smui/card

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

<Card style="width: 360px;">
  <PrimaryAction on:click={() => doAction('openItemPage')}>
    <Media
      style="background-image: url(https://via.placeholder.com/320x180.png?text=16x9);"
      aspectRatio="16x9"
    >
      <MediaContent>
        <div style="color: #fff; position: absolute; bottom: 16px; left: 16px;">
          <h2 class="mdc-typography--headline6" style="margin: 0;">
            Glorious Item
          </h2>
          <h3 class="mdc-typography--subtitle2" style="margin: 0;">
            People are saying you need to buy it.
          </h3>
        </div>
      </MediaContent>
    </Media>
    <Content class="mdc-typography--body2">
      This item is so glorious that you would have to be some kind of fool to
      not immediately buy it.
    </Content>
  </PrimaryAction>
  <Actions>
    <ActionButtons>
      <Button on:click={() => doAction('addToCart')}>
        <Label>Add to Card</Label>
      </Button>
      <Button on:click={() => doAction('buyNow')}>
        <Label>Buy Now</Label>
      </Button>
    </ActionButtons>
    <ActionIcons>
      <IconButton
        on:click={() => doAction('addToFavoritesToggle')}
        toggle
        aria-label="Add to favorites"
        title="Add to favorites"
      >
        <Icon class="material-icons" on>favorite</Icon>
        <Icon class="material-icons">favorite_border</Icon>
      </IconButton>
      <IconButton
        class="material-icons"
        on:click={() => doAction('share')}
        title="Share">share</IconButton
      >
    </ActionIcons>
  </Actions>
</Card>

<script>
  import Card, {
    Content,
    PrimaryAction,
    Media,
    MediaContent,
    Actions,
    ActionButtons,
    ActionIcons,
  } from '@smui/card';
  import Button, { Label } from '@smui/button';
  import IconButton, { Icon } from '@smui/icon-button';

  function doAction(action) {
    alert('You did an action: ' + action);
  }
</script>

Exports

(default)

A card.

Options / Defaults

  • use: [] - An array of Svelte actions and/or arrays of an action and its options.
  • class: '' - A CSS class string.
  • variant: 'raised' - The card's style variant. ('raised' or 'outlined')
  • padded: false - Whether to apply padding to the card. You can also use a Content component to achieve the same effect.

Content

A fragment used as a content area within a card.

Equivalent to the ClassAdder with Div common component.

Note that you can supply your own component to a ClassAdder based component. You can use this to create things like list cards.

PrimaryAction

An interactive portion of the card. Meant to be the primary way to interact with the card.

Options / Defaults

  • use: [] - An array of Svelte actions and/or arrays of an action and its options.
  • class: '' - A CSS class string.
  • ripple: true - Whether to implement a ripple for when the component is interacted with.
  • color: null - A color, passed to the Ripple action. (null, 'primary', or 'secondary')
  • padded: false - Whether to apply padding to the area.
  • tabindex: '0' - The tabindex of the area.

Media

An area of the card meant to show media content.

Options / Defaults

  • use: [] - An array of Svelte actions and/or arrays of an action and its options.
  • class: '' - A CSS class string.
  • aspectRatio: null - Add styling to maintain a given aspect ratio. ('square' or '16x9')

MediaContent

An area of the card within the media meant to show content over top of the media.

Equivalent to the ClassAdder with Div common component.

Actions

An area of the card containing interactive actions.

Options / Defaults

  • use: [] - An array of Svelte actions and/or arrays of an action and its options.
  • class: '' - A CSS class string.
  • fullBleed: false - Whether to style the actions as full bleed, meaning they take up the whole width of the card.

ActionButtons

An area of the card, within Actions, containing buttons.

Equivalent to the ClassAdder with Div common component.

ActionIcons

An area of the card, within Actions, containing icon buttons.

Equivalent to the ClassAdder with Div common component.

More Information

See Cards in the Material design spec.

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