Directory

up-mushroom - Vaadin Add-on Directory

Polymer 3 up-mushroom element up-mushroom - Vaadin Add-on Directory
# up-mushroom > Polymer 3 up-mushroom element [![npm](https://img.shields.io/npm/v/up-mushroom.svg)](https://www.npmjs.com/package/up-mushroom) [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/LarissaAbreu/up-mushroom) ## Demo ![Demonstração do componente funcionando](demo-up-mushroom.gif) ## How to install and use: 1 - Install the element using [Yarn](http://yarn.io/): ```sh $ yarn add up-mushroom ``` 2 - Import the element: ```html ``` or in your javascript file ```js import "up-mushroom/up-mushroom.js"; ``` 3 - Start using it! ```html ``` ## Styling The following custom properties and mixins are available for styling: Custom property | Default | Description :--- |:--- |:--- --up-mushroom-stroke | `#000` | Stroke color --up-mushroom-shadow | `#008B00` | Shadow color --up-mushroom-light | `#00FF00` | Light color --up-mushroom-color | `#00CD00` | Mushroom color ## 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/1.0/docs/tools/polymer-cli): ```sh $ [sudo] yarn global add polymer-cli ``` 3 - Install local dependencies: ```sh $ yarn install ``` 4 - Start the development server: ```sh $ polymer serve ``` Go to [localhost:8080/components/up-mushroom/](http://localhost:8080/components/up-mushroom/) ## 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/LarissaAbreu/up-mushroom/issues/) the next steps of the project ;)
Want to contribute? [Follow these recommendations](https://github.com/LarissaAbreu/up-mushroom/blob/master/CONTRIBUTING.md). ## History See [Releases](https://github.com/LarissaAbreu/up-mushroom/releases) for detailed changelog. ## License [MIT License](https://github.com/LarissaAbreu/up-mushroom/blob/master/LICENSE.md) © [Larissa Abreu](https://github.com/orgs/LarissaAbreu/people)