An open API service indexing awesome lists of open source software.

https://github.com/polymerelements/iron-location

A Polymer element that manages binding to the page's URL.
https://github.com/polymerelements/iron-location

Last synced: about 1 year ago
JSON representation

A Polymer element that manages binding to the page's URL.

Awesome Lists containing this project

README

          

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

## iron-location
The iron-location elements manage bindings to and from the current URL and query
parameters.
See: [Documentation](https://www.webcomponents.org/element/@polymer/iron-location),
[iron-location demo](https://www.webcomponents.org/element/@polymer/iron-location/demo/demo/index.html),
[iron-query-params demo](https://www.webcomponents.org/element/@polymer/iron-location/demo/demo/iron-query-params.html).

### <iron-location>

The `iron-location` element manages binding to and from the current URL.

### <iron-query-params>

The `iron-query-params` element manages serialization and parsing of query
parameter strings.

## Usage

### Installation
```
npm install --save @polymer/iron-location
```

### In an html file

##### <iron-location>
```html



import '@polymer/iron-location/iron-location.js';





```

#### <iron-query-params>
```html



import '@polymer/polymer/lib/elements/dom-bind.js';
import '@polymer/iron-location/iron-location.js';
import '@polymer/iron-location/iron-query-params.js';











```

### In a Polymer 3 element

##### <iron-location>
```js
import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/iron-location/iron-location.js';

class SampleElement extends PolymerElement {
static get template() {
return html`


`;
}
}
customElements.define('sample-element', SampleElement);
```

#### <iron-query-params>
```js
import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/iron-location/iron-location.js';
import '@polymer/iron-location/iron-query-params.js';

class SampleElement extends PolymerElement {
static get template() {
return html`




`;
}
}
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/iron-location
cd iron-location
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
```