@react-md/button
v5.1.6
Published
This package is used to create buttons with the material design spec. There is built-in support to be able to render accessible clickable divs that look like buttons, or even apply button styles to any element.
Downloads
5,848
Maintainers
Readme
@react-md/button
Create native buttons with multiple themes based on the material design specifications including:
- clear, primary, secondary, warning, error, and default theme states
- text, icon, or text + icon with spacing
- flat, outlined, or contained
Also includes a buttonThemeClassNames
function that can be used to apply a
button theme to any component by generating the required className
prop.
Installation
npm install --save @react-md/button
If you would also like dynamic themes and icon support, it is recommended to also install:
npm install --save @react-md/theme \
@react-md/typography \
@react-md/icon
Documentation
You should check out the full documentation for live examples and more customization information, but an example usage is shown below.
Usage
Buttons with Text
import { render } from "react-dom";
import { Button } from "@react-md/button";
const App = () => (
<>
<Button>Text Button</Button>
<Button theme="primary" themeType="flat">
Text Button
</Button>
<Button theme="secondary" themeType="raised">
Text Button
</Button>
<Button theme="warning" themeType="contained">
Text Button
</Button>
<Button theme="error">Text Button</Button>
<Button theme="clear">Text Button</Button>
<Button disabled>Text Button</Button>
</>
);
render(<App />, document.getElementById("root"));
Buttons with Text and Icons
Buttons can be rendered specifically as icon only buttons or as additional
support to the provided text. When rendering icons, you must also install
and use the @react-md/icon
package to get icon support. You can also install
the @react-md/material-icons
package if you'd like pre-built components for
every material icon that exists.
import { render } from "react-dom";
import { Button } from "@react-md/button";
import { TextIconSpacing, FontIcon } from "@react-md/icon";
import { DeleteSVGIcon } from "@react-md/material-icons";
const App = () => (
<>
<Button>
<TextIconSpacing icon={<FontIcon>info_outline</FontIcon>}>
About
</TextIconSpacing>
</Button>
<Button theme="primary" themeType="raised">
<TextIconSpacing icon={<FontIcon>info_outline</FontIcon>} iconAfter>
About
</TextIconSpacing>
</Button>
<Button theme="error" themeType="contained">
<TextIconSpacing icon={<DeleteSVGIcon />}>
Permanently Delete
</TextIconSpacing>
</Button>
</>
);
render(<App />, document.getElementById("root"));
If you have used react-md
in the past, notice that there are no longer any
icon
related props to handle this for you. It became difficult and confusing
to use when there were a lot of different icon positioning props, so the props
were removed and it is now expected to use the helper components in the
@react-md/icon
package instead. If you find a reusable pattern within your
app, it is recommended to make your own Button
wrapper component to implement
this for you.
Buttons with Icons Only
It is also possible to create buttons that only contain icons as children. For
general accessibility, you should provide either an aria-label
to provide a
label for the action of the button or use aria-labelledby
to point to an id
of an element that provides a label for the button. This is really to help
screen readers and generally recommended, but there are no restrictions in place
at this time to enforce this behavior.
import { render } from "react-dom";
import { Button } from "@react-md/button";
import { TextIconSpacing, FontIcon } from "@react-md/icon";
import { DeleteSVGIcon } from "@react-md/material-icons";
const App = () => (
<>
<Button aria-label="More Info" buttonType="icon">
<FontIcon>info_outline</FontIcon>
</Button>
<Button
theme="primary"
themeType="raised"
buttonType="icon"
aria-label="More Info"
>
<FontIcon>info_outline</FontIcon>
</Button>
<Button
theme="error"
themeType="contained"
buttonType="icon"
aria-label="Permanently Delete"
>
<DeleteSVGIcon />
</Button>
</>
);