# @polymer/paper-dialog-scrollable

> A scrollable area used inside the material design dialog

Latest version **3.0.1** (published 2018-09-14) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @polymer/paper-dialog-scrollable
pnpm add @polymer/paper-dialog-scrollable
yarn add @polymer/paper-dialog-scrollable
bun add @polymer/paper-dialog-scrollable
```

## 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 | 3.0.1 |
| Published | 2018-09-14 |
| First published | 2016-02-02 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 36.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | The Polymer Authors |
| Maintainers | aomarks, azakus, bicknellr, emarquez, justinfagnani, keanulee, notwaldorf, polymer-devs, samli, sorvell, usergenic |
| Keywords | web-components, polymer, dialog, overlay |

## Links

- npm: https://www.npmjs.com/package/@polymer/paper-dialog-scrollable
- Repository: https://github.com/PolymerElements/paper-dialog-scrollable
- Issues: https://github.com/PolymerElements/paper-dialog-scrollable/issues
- npm.io page: https://npm.io/package/@polymer/paper-dialog-scrollable

## Dependencies (4)

- [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0
- [@polymer/paper-styles](https://npm.io/package/@polymer/paper-styles.md) ^3.0.0-pre.26
- [@polymer/iron-flex-layout](https://npm.io/package/@polymer/iron-flex-layout.md) ^3.0.0-pre.26
- [@polymer/paper-dialog-behavior](https://npm.io/package/@polymer/paper-dialog-behavior.md) ^3.0.0-pre.26

## Alternatives

- [react-native-root-siblings](https://npm.io/package/react-native-root-siblings.md) — 102.9K weekly downloads
- [@praxisui/dialog](https://npm.io/package/@praxisui/dialog.md) — 2.0K weekly downloads
- [easy-toggle-state](https://npm.io/package/easy-toggle-state.md) — 350 weekly downloads
- [ngx-lightbox-evp](https://npm.io/package/ngx-lightbox-evp.md) — 19 weekly downloads
- [react-native-modal-translucent-axton](https://npm.io/package/react-native-modal-translucent-axton.md) — 4 weekly downloads

## Recent versions

- 3.0.1 (latest) — 2018-09-14
- 3.0.0-pre.20 (next) — 2018-06-23
- 1.1.5-pre.3 (preview) — 2017-01-24
- 3.0.0 — 2018-09-13
- 3.0.0-pre.26 — 2018-09-12
- 3.0.0-pre.25 — 2018-08-29
- 3.0.0-pre.24 — 2018-08-29
- 3.0.0-pre.23 — 2018-08-25
- 3.0.0-pre.22 — 2018-08-25
- 3.0.0-pre.21 — 2018-06-23
- 3.0.0-pre.19 — 2018-05-09
- 3.0.0-pre.18 — 2018-05-09
- 3.0.0-pre.17 — 2018-05-08
- 3.0.0-pre.16 — 2018-05-04
- 3.0.0-pre.15 — 2018-05-02
- … 17 more at https://npm.io/package/@polymer/paper-dialog-scrollable/versions

## README

[![Published on NPM](https://img.shields.io/npm/v/@polymer/paper-dialog-scrollable.svg)](https://www.npmjs.com/package/@polymer/paper-dialog-scrollable)
[![Build status](https://travis-ci.org/PolymerElements/paper-dialog-scrollable.svg?branch=master)](https://travis-ci.org/PolymerElements/paper-dialog-scrollable)
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://webcomponents.org/element/@polymer/paper-dialog-scrollable)

## <paper-dialog-scrollable>
`paper-dialog-scrollable` implements a scrolling area used in a Material Design dialog. It shows
a divider at the top and/or bottom indicating more content, depending on scroll position. Use this
together with elements implementing `PaperDialogBehavior`.

```html
<paper-dialog>
  <h2>Header</h2>
  <paper-dialog-scrollable>
    Lorem ipsum...
  </paper-dialog-scrollable>
  <div class="buttons">
    <paper-button>OK</paper-button>
  </div>
</paper-dialog>
```

It shows a top divider after scrolling if it is not the first child in its parent container,
indicating there is more content above. It shows a bottom divider if it is scrollable and it is not
the last child in its parent container, indicating there is more content below. The bottom divider
is hidden if it is scrolled to the bottom.

If `paper-dialog-scrollable` is not a direct child of the element implementing `PaperDialogBehavior`,
remember to set the `dialogElement`:

```html
<paper-dialog id="myDialog">
  <h2>Header</h2>
  <div class="my-content-wrapper">
    <h4>Sub-header</h4>
    <paper-dialog-scrollable>
      Lorem ipsum...
    </paper-dialog-scrollable>
  </div>
  <div class="buttons">
    <paper-button>OK</paper-button>
  </div>
</paper-dialog>

<script>
  var scrollable = myDialog.querySelector('paper-dialog-scrollable');
  scrollable.dialogElement = myDialog;
</script>
```

### Styling

The following custom properties and mixins are available for styling:

| Custom property | Description | Default |
| --- | --- | --- |
| `--paper-dialog-scrollable` | Mixin for the scrollable content | {} |

See: [Documentation](https://www.webcomponents.org/element/@polymer/paper-dialog-scrollable),
  [Demo](https://www.webcomponents.org/element/@polymer/paper-dialog-scrollable/demo/demo/index.html).

## Usage

### Installation
```
npm install --save @polymer/paper-dialog-scrollable
```

### In an html file
```html
<html>
  <head>
    <script type="module">
      import '@polymer/paper-dialog/paper-dialog.js';
      import '@polymer/paper-dialog-scrollable/paper-dialog-scrollable.js';
    </script>
  </head>
  <body>
    <button onclick="dialog.open()">Open</button>
    <paper-dialog id="dialog">
      <h2>Heading</h2>
      <paper-dialog-scrollable>
        <p>Scrolalble content...</p>
      </paper-dialog-scrollable>
    </paper-dialog>
  </body>
</html>
```
### In a Polymer 3 element
```js
import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/paper-dialog/paper-dialog.js';
import '@polymer/paper-dialog-scrollable/paper-dialog-scrollable.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
      <button on-click="_openDialog">Open</button>
      <paper-dialog id="dialog">
        <h2>Heading</h2>
        <paper-dialog-scrollable>
          <p>Scrolalble content...</p>
        </paper-dialog-scrollable>
      </paper-dialog>
    `;
  }

  _openDialog() {
    this.$.dialog.open();
  }
}
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
```sh
git clone https://github.com/PolymerElements/paper-dialog-scrollable
cd paper-dialog-scrollable
npm install
npm install -g polymer-cli
```

### Running the demo locally
```sh
polymer serve --npm
open http://127.0.0.1:<port>/demo/
```

### Running the tests
```sh
polymer test --npm
```

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