# @valle/valle-fab

> Awesome valle-fab element - web component using Polymer 3

Latest version **1.0.1** (published 2020-03-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @valle/valle-fab
pnpm add @valle/valle-fab
yarn add @valle/valle-fab
bun add @valle/valle-fab
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-03-19 |
| First published | 2020-02-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 25.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | afonsopacifer, vallesistemas |
| Keywords | polymer, polymer-3, web-components, valle-fab |

## Links

- npm: https://www.npmjs.com/package/@valle/valle-fab
- Repository: https://github.com/valleweb/valle-fab
- Issues: https://github.com/valleweb/valle-fab/issues
- npm.io page: https://npm.io/package/@valle/valle-fab

## Dependencies (1)

- [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0

## Recent versions

- 1.0.1 (latest) — 2020-03-19
- 1.0.0 — 2020-02-20

## README

# valle-fab

> Awesome valle-fab element - web component using Polymer 3

[![npm](https://img.shields.io/npm/v/@valle/valle-fab.svg)](https://www.npmjs.com/package/@valle/valle-fab)
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/@valle/valle-fab)

## How to install and use:

1 - Install the element using [Yarn](http://yarn.io/):

```sh
$ yarn add @valle/valle-fab
```

2 -  Import the element:

```html
<script type="module" src="node_modules/@valle/valle-fab/valle-fab.js"></script>
```

or in your javascript file

```js
import "@valle/valle-fab/valle-fab.js";
```

3 - Start using it!

<!--
```
<custom-element-demo>
  <template>
    <script type="module" src="valle-fab.js"></script>
    <next-code-block></next-code-block>
  </template>
</custom-element-demo>
```
-->

```html
<valle-fab></valle-fab>
<valle-fab disabled></valle-fab>
<valle-fab mini></valle-fab>
<valle-fab toggle></valle-fab>
<valle-fab
  icon="https://uploaddeimagens.com.br/images/001/071/867/full/iconmonstr-fast-food-3-32.png">
</valle-fab>
```

## Properties

Property    | Type      | Default | Description
:---        |:---       |:---     |:---
`icon`      | *String*  | `''`    | Icon url
`mini`      | *Boolean* | `false` | Allow mini size
`disabled`  | *Boolean* | `false` | Allow disabled state
`elevation` | *Number*  | `1`     | Add material design elevation level (1-5)
`label`     | *String*  | `''`    | Label for screen readers
`toggle`    | *Boolean* | `false` | Allow toggle mode
`pressed`   | *Boolean* | `false` | Set the pressed state (toggled)
`sloted`    | *Boolean* | `false` | Allow inline icon (slot)

## Styling

The following custom properties and mixins are available for styling:

Custom property                     | Default | Description
:---                                |:---     |:---
--valle-fab-color              | #ff6d00 | Button background color
--valle-fab-size               | 56px    | Button size (width and height)
--valle-fab-mini-size          | 40px    | Button mini size (width and height)
--valle-fab-icon-size          | 24px    | Icon size (width and height)
--valle-fab-default-icon-color | #ffffff | Default icon background color
--valle-fab-pressed-coulor     | #ff0101 | Pressed button background color (toggle)

## Browser Support

Using the [webcomponents.js](https://github.com/WebComponents/webcomponentsjs):

 ![Chrome](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/39.2.2/chrome/chrome_48x48.png) | ![Opera](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/39.2.2/opera/opera_48x48.png) | ![Firefox](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/39.2.2/firefox/firefox_48x48.png) | ![Safari](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/39.2.2/safari/safari_48x48.png) |![IE](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/39.2.2/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png) |  ![Edge](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/39.2.2/edge/edge_48x48.png) |
:---: | :---: | :---: | :---: | :---: | :---: |
Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11+ | Latest ✔

## Development

1 - Verify if you have [node](http://nodejs.org/) and [yarn](http://yarn.io/) installed.

2 - Install [Polymer-CLI](https://www.polymer-project.org/3.0/docs/tools/polymer-cli):

```sh
$ [sudo] yarn global add polymer-cli
```

3 - Install local dependencies:

```sh
$ yarn
```

4 - Start the development server:

```sh
$ yarn start
```

## Versioning

To keep better organization of releases we follow the [Semantic Versioning 2.0.0](http://semver.org/) guidelines.

## Contributing

Find on our [issues](https://github.com/valleweb/valle-fab/issues/) the next steps of the project ;)
<br>
Want to contribute? [Follow these recommendations](https://github.com/valleweb/valle-fab/blob/master/CONTRIBUTING.md).

## History

See [Releases](https://github.com/valleweb/valle-fab/releases) for detailed changelog.

## License

[MIT License](https://github.com/valleweb/valle-fab/blob/master/LICENSE.md) © [valleweb](https://github.com/orgs/valleweb/people)

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