Skip to content

materialr/button

Repository files navigation

MaterialR Button

@materialr/button

Build Status Coverage Status NSP Status semantic-release

Material button implementation for React

Installation

$ npm install --save @materialr/button

Demo

A full demo is available on the MaterialR website showcasing all variants.

Components

Default export

import Button from '@materialr/button';

Props

Prop Type Required Default Description
children string / node Yes N/A The text - or elements - to render inside the button
className string No undefined Additional classNames to add to the button
dense bool No false Whether to render the dense button variant
disabled bool No false Whether the button is disabled
onClick func No undefined The button's click handler
outlined bool No false Whether to render the outlined button variant
raised bool No false Whether to render the raised button variant
ripple bool No false Whether to add a ripple effect to the button
type enum (button/submit/clear) No button The button's type attribute
unelevated bool No false Whether to render the unelevated button variant