Socket
Socket
Sign inDemoInstall

@polymer/paper-menu-button

Package Overview
Dependencies
13
Maintainers
10
Versions
33
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @polymer/paper-menu-button

A material design element that composes a trigger and a dropdown menu


Version published
Weekly downloads
11K
decreased by-40.96%
Maintainers
10
Install size
2.35 MB
Created
Weekly downloads
 

Readme

Source

Published on NPM Build status Published on webcomponents.org

<paper-menu-button>

paper-menu-button allows one to compose a designated "trigger" element with another element that represents "content", to create a dropdown menu that displays the "content" when the "trigger" is clicked.

The child element assigned to the dropdown-trigger slot will be used as the "trigger" element. The child element assigned to the dropdown-content slot will be used as the "content" element.

The paper-menu-button is sensitive to its content's iron-select events. If the "content" element triggers an iron-select event, the paper-menu-button will close automatically.

Styling

The following custom properties and mixins are also available for styling:

Custom propertyDescriptionDefault
--paper-menu-button-dropdown-backgroundBackground color of the paper-menu-button dropdown--primary-background-color
--paper-menu-buttonMixin applied to the paper-menu-button{}
--paper-menu-button-disabledMixin applied to the paper-menu-button when disabled{}
--paper-menu-button-dropdownMixin applied to the paper-menu-button dropdown{}
--paper-menu-button-contentMixin applied to the paper-menu-button content{}

paper-menu-button-animations.js

Defines these animations:

  • <paper-menu-grow-height-animation>
  • <paper-menu-grow-width-animation>
  • <paper-menu-shrink-height-animation>
  • <paper-menu-shrink-width-animation>

See: Documentation, Demo.

Usage

Installation

npm install --save @polymer/paper-menu-button

In an html file

<html>
  <head>
    <script type="module">
      import '@polymer/paper-icon-button/paper-icon-button.js';
      import '@polymer/paper-item/paper-item.js';
      import '@polymer/paper-listbox/paper-listbox.js';
      import '@polymer/paper-menu-button/paper-menu-button.js';
    </script>
  </head>
  <body>
    <paper-menu-button>
      <paper-icon-button icon="menu" slot="dropdown-trigger"></paper-icon-button>
      <paper-listbox slot="dropdown-content">
        <paper-item>Share</paper-item>
        <paper-item>Settings</paper-item>
        <paper-item>Help</paper-item>
      </paper-listbox>
    </paper-menu-button>
  </body>
</html>

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/paper-icon-button/paper-icon-button.js';
import '@polymer/paper-item/paper-item.js';
import '@polymer/paper-listbox/paper-listbox.js';
import '@polymer/paper-menu-button/paper-menu-button.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
      <paper-menu-button>
        <paper-icon-button icon="menu" slot="dropdown-trigger"></paper-icon-button>
        <paper-listbox slot="dropdown-content">
          <paper-item>Share</paper-item>
          <paper-item>Settings</paper-item>
          <paper-item>Help</paper-item>
        </paper-listbox>
      </paper-menu-button>
    `;
  }
}
customElements.define('sample-element', SampleElement);

Contributing

If you want to send a PR to this element, here are the instructions for running the tests and demo locally:

Installation

git clone https://github.com/PolymerElements/paper-menu-button
cd paper-menu-button
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm
open http://127.0.0.1:<port>/demo/

Running the tests

polymer test --npm

Keywords

FAQs

Last updated on 05 Mar 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc