**[ This description is mirrored from README.md at [github.com/arsnebula/nebula-routing](https://github.com//arsnebula/nebula-routing/blob/v2.1.2/README.md) on 2019-05-22 ]**
[](https://www.webcomponents.org/element/arsnebula/nebula-validate)
[](https://www.polymer-project.org)
[](https://saucelabs.com/beta/builds/47bb62d1bb4145709386901add0100b2)
[](https://gitter.im/arsnebula/webcomponents)
[](https://www.patreon.com/arsnebula)
# \
Web components for declarative client-side routing.
- Parses the browser **window.location** for pathname and search query parameters
- Pattern matching supports named parameters, optional sections and wildcards
- Updates the browser URL on the client using the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History)
- Supports using parameters to interpolate URL changes
- Can intercept anchor links and resolve on the client
## Installation
```sh
$ bower install -S arsnebula/nebula-routing
```
## Getting Started
Import the package.
```html
```
Add the routing elements. The `` element can intercept clicks on anchor elements that have an `href` that targets the local origin. Typically, you will add a single instance to your top-level application element, or the HTML body element.
```html
```
The `` element parses the window location and provides route information including pathnanme, query parameters, and the current hash. The `` element is used to match a route path to a specified pattern.
```html
```
Use something like `iron-pages` to perform conditional rendering of page elements:
```html
Test 1
Test 2
```
Use the `redirect` method to change the route based on a new path, or parameter:
```js
this.$.route.redirect('/test2'})
this.$.route.redirect({page: 'test2'})
```
To perform a `replaceState` rather than `pushState`, set the optional `replace` parameter to `true`.
```js
this.$.route.redirect('/test2'}, true)
this.$.route.redirect({page: 'test2'}, true)
```
*For more information, see the API documentation.*
## Contributing
We welcome and appreciate feedback from the community. Here are a few ways that you can show your appreciation for this package:
* Give us a **Star on GitHub** from either [webcomponents.org](https://www.webcomponents.org/element/arsnebula/nebula-element-mixin) or directly on [GitHub](https://github.com/arsnebula/nebula-element-mixin).
* Submit a feature request, or a defect report on the [Issues List](https://www.webcomponents.org/element/arsnebula/nebula-element-mixin/issues).
* Become a [Patreon](https://www.patreon.com/arsnebula). It takes a lot of time and effort to develop, document, test and support the elements in our [Nebula Essentials](https://www.webcomponents.org/collection/arsnebula/nebula-essentials) collection. Your financial contribution will help ensure that our entire collection continues to grow and improve.
If you are a developer, and are interested in making a code contribution, consider opening an issue first to describe the change, and discuss with the core repository maintainers. Once you are ready, prepare a pull request:
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Change Log
See [CHANGELOG](/CHANGELOG.md)
## License
See [LICENSE](/LICENSE.md)
