# zc-button

> A simple reusable button component

Latest version **1.0.7** (published 2020-01-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install zc-button
pnpm add zc-button
yarn add zc-button
bun add zc-button
```

## 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.0.7 |
| Published | 2020-01-23 |
| First published | 2020-01-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 722 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | _zaphod |
| Keywords | web component, button, stencil |

## Links

- npm: https://www.npmjs.com/package/zc-button
- Repository: https://github.com/ZaphodAndo/zaphods-components
- Homepage: https://github.com/ZaphodAndo/zaphods-components#readme
- Issues: https://github.com/ZaphodAndo/zaphods-components/issues
- npm.io page: https://npm.io/package/zc-button

## Recent versions

- 1.0.7 (latest) — 2020-01-23
- 1.0.6 — 2020-01-23
- 1.0.5 — 2020-01-23
- 1.0.4 — 2020-01-23
- 1.0.3 — 2020-01-23
- 1.0.2 — 2020-01-23
- 1.0.1 — 2020-01-23
- 1.0.0 — 2020-01-23

## README

# zc-button
This is a customisable button with a hover animation built with [StencilJS](https://stenciljs.com/), that allows for the user to define their own text, background colour and text colour.

## Example Usage

### With Node
```html
<head>
    <script src='node_modules/zc-button/dist/zc-button.js'></script>
</head>
<body>
    <zc-button button-text="Click Me" button-background="red" button-text-style="white"></zc-button>
</body>
</html>
```

### With Script Tag
```html
<head>
    <script src='https://unpkg.com/zc-button@1.0.0/dist/zc-button.js'></script>
</head>
<body>
    <zc-button button-text="Click Me" button-background="red" button-text-style="white"></zc-button>
</body>
</html>
```

By leaving either the `button-background` or `button-text-style` empty it will default to `white` for the background and `#5851ff` for the text!

## Properties

| Property           | Attribute           | Description               | Type     |
| ------------------ | ------------------- | ------------------------- | -------- |
| `buttonBackground` | `button-background` | Button background colour  | `string` |
| `buttonText`       | `button-text`       | The text for the button   | `string` |
| `buttonTextStyle`  | `button-text-style` | The button text colour    | `string` |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*

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