Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

126 documentation updates #128

Closed
wants to merge 13 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 0 additions & 45 deletions can-route-pushstate.js
Original file line number Diff line number Diff line change
Expand Up @@ -78,51 +78,6 @@ function PushstateObservable() {
PushstateObservable.prototype = Object.create(SimpleObservable.prototype);
PushstateObservable.constructor = PushstateObservable;
canReflect.assign(PushstateObservable.prototype, {
/**
* @property {String} can-route-pushstate.prototype.root root
* @parent can-route-pushstate.prototype
*
* @description Configure the base url that will not be modified.
*
* @option {String} Represents the base url that pushstate will prepend to all
* routes. `root` defaults to: `"/"`.
*
* @body
*
* ## Use
*
* By default, a route like:
*
* ```js
* route.urlData = new RoutePushstate();
* route.register( "{type}/{id}" );
* ```
*
* Matches URLs like:
*
* ```
* http://domain.com/contact/5
* ```
*
* But sometimes, you only want to match pages within a certain directory. For
* example, an application that is a filemanager. You might want to
* specify root and routes like:
*
* ```js
* route.urlData = new RoutePushstate();
* route.urlData.root = "/filemanager/";
* route.register( "file-{fileId}" );
* route.register( "folder-{fileId}" );
* ```
*
* Which matches URLs like:
*
* ```
* http://domain.com/filemanager/file-34234
* ```
*
*/

// Start of `location.pathname` is the root.
// (Can be configured via `route.urlData.root`)
root: "/",
Expand Down