# @pmwcs/button-group

> PMWCS button-group component

Latest version **1.1.0** (published 2021-06-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pmwcs/button-group
pnpm add @pmwcs/button-group
yarn add @pmwcs/button-group
bun add @pmwcs/button-group
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-06-20 |
| First published | 2020-08-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Maintainers | commenthol |
| Keywords | pmwcs, preact, material, web, components, button-group |

## Links

- npm: https://www.npmjs.com/package/@pmwcs/button-group
- Repository: https://github.com/pmwcs/pmwcs
- Homepage: https://github.com/pmwcs/pmwcs#readme
- Issues: https://github.com/pmwcs/pmwcs/issues
- npm.io page: https://npm.io/package/@pmwcs/button-group

## Dependencies (2)

- [@pmwcs/base](https://npm.io/package/@pmwcs/base.md) ^1.1.0
- [@pmwcs/ripple](https://npm.io/package/@pmwcs/ripple.md) ^1.1.0

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-06-20
- 1.0.0-2 (next) — 2020-09-05
- 1.0.2 — 2020-12-30
- 1.0.1 — 2020-10-11
- 1.0.0 — 2020-10-07
- 1.0.0-1 — 2020-08-30

## README

# ButtonGroup (PMWCS Addon)

The ButtonGroup component can be used to group related buttons.

- Module **@pmwcs/button-group**
- Import styles:
  - Using CSS Loader
    - import '@pmwcs/button-group/styles';
  - Or include stylesheets
    - **'@pmwcs/button-group/button-group.css'**
- MDC Docs: [https://material.io/develop/web/components/buttons/](https://material.io/develop/web/components/buttons/)

```jsx
<ButtonGroup>
  <Button>One</Button>
  <Button>Two</Button>
  <Button>Three</Button>
</ButtonGroup>
```

```jsx
<ButtonGroup raised dense>
  <Button><Icon icon='favorite' /></Button>
  <Button><Icon icon='local_pizza' /></Button>
  <Button><Icon icon='mood' /></Button>
</ButtonGroup>
```

## ButtonGroup
The Button component.

### Props

| Name | Type | Description |
|------|------|-------------|
| `children` | `AnyComponent` | Content specified as children. |
| `dense` | `undefined \| false \| true` | Make the Button dense. |
| `disabled` | `undefined \| false \| true` | Make the button disabled |
| `outlined` | `undefined \| false \| true` | Make the button outlined. |
| `raised` | `undefined \| false \| true` | Make the Button raised. |
| `ripple` | `RipplePropT` | Adds a ripple effect to the component |
| `unelevated` | `undefined \| false \| true` | Make the button unelevated. |

## References

- https://material-components.github.io/material-components-web-catalog/#/component/button

---
_Source: https://npm.io/package/@pmwcs/button-group · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._