Skip to content

Latest commit

 

History

History
298 lines (185 loc) · 4.33 KB

docs.md

File metadata and controls

298 lines (185 loc) · 4.33 KB

Table of Contents

Icon

Extends MaterialComponent

An Icon in the Material Icons font. Note that you must include the font, usually by Google Fonts

Parameters

  • icon The icon to render. Can also be specified in the Icon text

Examples

<Icon icon="menu" />
<Icon>menu</Icon>

Button

Extends MaterialComponent

A material button

Parameters

  • primary = false
  • accent = false
  • colored = false
  • raised = false
  • icon = false
  • fab = false
  • mini-fab = false
  • disabled = false

Examples

<Button onClick={this.handleClick}>Hello World</Button>

Card

Extends MaterialComponent

Cards are how you represent blocks of infomation. From the Material Design Specifications: A card is a sheet of material that serves as an entry point to more detailed information. TODO: example

Dialog

Extends MaterialComponent

Dialogs

Layout

Extends MaterialComponent

Use a layout to specify how your app will use some of material's aspects. Your app should reside in this component. If you want a fixed header, drawer, or tabs, specify them here.

Parameters

  • fixed-header = false
  • fixed-drawer = false
  • overlay-drawer-button = false
  • fixed-tabs = false

Examples

<Layout fixed-header>
	<Layout.Header>
     ...
	</Layout.Header>
	...
 </Layout>

Layout

Extends MaterialComponent

Layouts

LayoutHeader

Extends MaterialComponent

Parameters

  • waterfall = false
  • scroll = false

LayoutTab

Extends MaterialComponent

Parameters

  • active

LayoutTabPanel

Extends MaterialComponent

Parameters

  • active

Navigation

Extends MaterialComponent

Parameters

  • large-screen-only = false

Grid

Extends MaterialComponent

Responsive Grid

Parameters

  • no-spacing = false

Progress

Extends MaterialComponent

Parameters

  • indeterminate = false

Spinner

Extends MaterialComponent

Parameters

  • active = false
  • single-color = false

Menu

Extends MaterialComponent

Parameters

  • bottom-left = true
  • bottom-right = false
  • top-left = false
  • top-right = false

MenuItem

Extends MaterialComponent

Parameters

  • disabled = false

Slider

Extends MaterialComponent

Parameters

  • min = 0
  • max = 100
  • value = 0
  • tabindex = 0
  • disabled = false

Snackbar

Extends MaterialComponent

Snackbar

CheckBox

Extends MaterialComponent

Parameters

  • checked = false
  • disabled = false

Radio

Extends MaterialComponent

Parameters

  • name (required)
  • value (required)
  • checked = false
  • disabled = false

IconToggle

Extends MaterialComponent

Parameters

  • checked = false
  • disabled = false

Switch

Extends MaterialComponent

Parameters

  • checked = false
  • disabled = false

Table

Extends MaterialComponent

Parameters

  • selectable = false

TableCell

Extends MaterialComponent

Parameters

  • non-numeric = false

ListItem

Extends MaterialComponent

Parameters

  • two-line = false
  • three-line = false

TextField

Extends MaterialComponent

Parameters

  • args ...any
  • floating-label = false
  • multiline = false
  • expandable = false
  • errorMessage = null
  • icon (used with expandable)

Tooltip

Extends MaterialComponent

Parameters

  • for [id]
  • large = false