Skip to content

Commit

Permalink
Merge pull request #3 from vaadin/api-docs
Browse files Browse the repository at this point in the history
Fix API doc
  • Loading branch information
Limon Monte authored Jul 4, 2017
2 parents 0303f57 + 6c64803 commit 559eaa6
Show file tree
Hide file tree
Showing 4 changed files with 374 additions and 63 deletions.
62 changes: 1 addition & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,6 @@
![Bower version](https://img.shields.io/bower/v/vaadin-overlay.svg)
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://beta.webcomponents.org/element/vaadin/vaadin-overlay)
[![Build Status](https://travis-ci.org/vaadin/vaadin-overlay.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-overlay)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/vaadin-core-elements?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

# <vaadin-overlay>

[Live Demo ↗](https://cdn.vaadin.com/vaadin-core-elements/master/vaadin-overlay/demo/)

[<vaadin-overlay>](https://vaadin.com/elements/-/element/vaadin-overlay) is a [Polymer 2](http://polymer-project.org) element providing <element-functionality>, part of the [Vaadin Core Elements](https://vaadin.com/elements).

<!--
```
<custom-element-demo>
<template>
<link rel="import" href="vaadin-overlay.html">
<next-code-block></next-code-block>
</template>
</custom-element-demo>
```
-->
```html
<vaadin-overlay>
...
</vaadin-overlay>
```

[<img src="https://raw.githubusercontent.com/vaadin/vaadin-overlay/master/screenshot.png" width="200" alt="Screenshot of vaadin-overlay">](https://vaadin.com/elements/-/element/vaadin-overlay)


## Running demos and tests in browser

1. Fork the `vaadin-overlay` repository and clone it locally.

1. Make sure you have [npm](https://www.npmjs.com/) installed.

1. When in the `vaadin-overlay` directory, run `npm install` and then `bower install` to install dependencies.

1. Run `polymer serve --open`, browser will automatically open the component API documentation.

1. You can also open demo or in-browser tests by adding **demo** or **test** to the URL, for example:

- http://127.0.0.1:8080/components/vaadin-overlay/demo
- http://127.0.0.1:8080/components/vaadin-overlay/test


## Running tests from the command line

1. When in the `vaadin-overlay` directory, run `polymer test`


## Following the coding style

We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can check if your code is following our standards by running `gulp lint`, which will automatically lint all `.js` files as well as JavaScript snippets inside `.html` files.


## Contributing

- Make sure your code is compliant with our code linters: `gulp lint`
- Check that tests are passing: `polymer test`
- [Submit a pull request](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) with detailed title and description
- Wait for response from one of Vaadin Elements team members

[&lt;vaadin-overlay&gt;](https://vaadin.com/elements/-/element/vaadin-overlay) is a [Polymer 2](http://polymer-project.org) element meant for internal use in vaadin elements. Its API might be changed without any notice.

## License

Expand Down
Loading

0 comments on commit 559eaa6

Please sign in to comment.