https://github.com/polymerelements/paper-material
A Material Design container that looks like a lifted piece of paper
https://github.com/polymerelements/paper-material
Last synced: about 1 year ago
JSON representation
A Material Design container that looks like a lifted piece of paper
- Host: GitHub
- URL: https://github.com/polymerelements/paper-material
- Owner: PolymerElements
- Created: 2015-04-17T02:44:16.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T23:46:13.000Z (over 1 year ago)
- Last Synced: 2025-04-04T11:15:24.417Z (about 1 year ago)
- Language: HTML
- Homepage:
- Size: 295 KB
- Stars: 19
- Watchers: 15
- Forks: 16
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@polymer/paper-material)
[](https://travis-ci.org/PolymerElements/paper-material)
[](https://webcomponents.org/element/@polymer/paper-material)
## <paper-material>
`paper-material` is a container that renders two shadows on top of each other to
create the effect of a lifted piece of paper.
⚠️ As of the 2.0 release, this element is **deprecated** in favour of the shared styles in [`PolymerElements/paper-styles`](https://github.com/PolymerElements/paper-styles/blob/master/element-styles/paper-material-styles.html). Please see the implementation of [`PolymerElements/paper-button`](https://github.com/PolymerElements/paper-button/blob/master/paper-button.html#L114) for an example.
See: [Documentation](https://www.webcomponents.org/element/@polymer/paper-material),
[Demo](https://www.webcomponents.org/element/@polymer/paper-material/demo/demo/index.html).
## Usage
### Installation
```
npm install --save @polymer/paper-material
```
### In an html file
```html
import '@polymer/paper-material/paper-material.js';
Some content
```
### In a Polymer 3 element
```js
import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/paper-material/paper-material.js';
class SampleElement extends PolymerElement {
static get template() {
return html`
Some content
`;
}
}
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-material
cd paper-material
npm install
npm install -g polymer-cli
```
### Running the demo locally
```sh
polymer serve --npm
open http://127.0.0.1:/demo/
```
### Running the tests
```sh
polymer test --npm
```