Skip to content

The offical repository of the webcomponent client-route

License

Notifications You must be signed in to change notification settings

TimUntersberger/client-route

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 

Repository files navigation

client-route

Published on webcomponents.org

Client-route is a simple webcomponent for client side routing.

The component supports lazyloading by using the javascript eval function.

My custom import function will be replaced by the offical import as soon as the import propsal is supported in all browsers.

The component listens for pathchanged events to know when to check whether it should render the children.

Installation

npm install client-route or yarn add client-route

Usage

Note: the recommended way of using client-route is together with client-link.

<script src="node_modules/client-router/index.js"></script>
<client-route path="/"> Home </client-route>
<client-route path="/about"> About </client-route>

Props

path

The children get rendered when the path matches the window location.

<client-route path="/"></client-route>

from

The location of the custom element. Activates lazy loading. If from is specified then the tag attribute has to be set too. Warning: the custom element can't be specified in a module file due to the limitations of eval.

<client-route path="/" from="/home.js" tag="home-page"></client-route>

tag

The element that gets rendered after the element has been fetched. Activates lazy loading. If tag is specified then the from attribute has to be set too.

<client-route path="/" from="/home.js" tag="home-page"></client-route>

Contributing

  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

License

LICENSE

About

The offical repository of the webcomponent client-route

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published