# preact-material-design

> A set of material components for Preact.

Latest version **0.4.1** (published 2017-02-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install preact-material-design
pnpm add preact-material-design
yarn add preact-material-design
bun add preact-material-design
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2017-02-19 |
| First published | 2017-02-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | James Birtles |
| Maintainers | vuex |

## Links

- npm: https://www.npmjs.com/package/preact-material-design
- Repository: https://github.com/VuexLtd/preact-material-design
- Homepage: https://github.com/VuexLtd/preact-material-design#readme
- Issues: https://github.com/VuexLtd/preact-material-design/issues
- npm.io page: https://npm.io/package/preact-material-design

## Dependencies (1)

- [preact-portal](https://npm.io/package/preact-portal.md) ^1.1.1

## Recent versions

- 0.4.1 (latest) — 2017-02-19
- 0.4.0 — 2017-02-19
- 0.3.0 — 2017-02-19
- 0.2.0 — 2017-02-18
- 0.1.0 — 2017-02-16

## README

# Preact Material Design
A set of UI components that follow the [Material Design Guidelines](https://material.io/guidelines/)

## Install
```sh
yarn add preact-material-design
```
_or_
```sh
npm i -S preact-material-design
```

## Usage

(More details coming soon)

### Code
To use any given component, simply import it,
and then use it like any other preact component/
```jsx
import { Button } from 'preact-material-design';

() => <Button>Primary Button</Button>
```

### Styles
You must also include the css for the component which you can do per component,
or simply include the full stylesheet.
```html
<link rel="stylesheet" href="node_modules/preact-material-design/dist/styles.css">
```

If using sass, you can import the sass directly from the src folder.
```scss
@import '~preact-material-design/src/styles';
```

Note: These paths and method are likely to change in the future.

## Theming
There is very limited theming support right now,
and the situation will improve as this module develops.

For now, you should be able to override the sass variables before importing the
preact-material-design styles.

E.g.
```scss
$pmd-color-primary: #FF5722;

@import '~preact-material-design/src/styles';
```

---
_Source: https://npm.io/package/preact-material-design · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._