diff --git a/README.md b/README.md index 0fcd40b..3c57ba7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # can-stache-route-helpers -[![Build Status](https://travis-ci.org/donejs/can-stache-route-helpers.svg?branch=master)](https://travis-ci.org/donejs/can-stache-route-helpers) +[![Build Status](https://travis-ci.org/canjs/can-stache-route-helpers.svg?branch=master)](https://travis-ci.org/canjs/can-stache-route-helpers) helpers for can-route diff --git a/can-stache-route-helpers.js b/can-stache-route-helpers.js index 22050d5..6ce00c8 100644 --- a/can-stache-route-helpers.js +++ b/can-stache-route-helpers.js @@ -46,7 +46,7 @@ helpers.registerHelper('routeUrl',function(){ var routeCurrent = function(){ var args = calculateArgs.apply(this, arguments); - var result = route.current( args.finalParams, typeof args.finalMerge === "boolean" ? args.finalMerge : undefined ); + var result = route.isCurrent( args.finalParams, typeof args.finalMerge === "boolean" ? args.finalMerge : undefined ); if( args.optionsArg && !(args.optionsArg instanceof stacheExpression.Call) ) { if( result ) { diff --git a/docs/can-stache-route-helpers.md b/docs/can-stache-route-helpers.md index d511f4e..aaeb490 100644 --- a/docs/can-stache-route-helpers.md +++ b/docs/can-stache-route-helpers.md @@ -13,7 +13,7 @@ Use the `routeUrl` helper like: ```html - {{recipe.name}} + {{recipe.name}} ``` This produces (with no pretty routing rules): @@ -26,8 +26,8 @@ Use the `routeCurrent` helper like: ```html -
  • - {{recipe.name}} +
  • + {{recipe.name}}
  • ``` diff --git a/docs/routeCurrent.md b/docs/routeCurrent.md index c994090..5160e26 100644 --- a/docs/routeCurrent.md +++ b/docs/routeCurrent.md @@ -1,11 +1,11 @@ -@function can-stache-route-helpers.routeCurrent {{#routeCurrent(hash)}} +@function can-stache-route-helpers.routeCurrent {{# routeCurrent(hash) }} @parent can-stache-route-helpers Returns if the hash values match the [can-route]’s current properties. @signature `routeCurrent( hashes... [,subsetMatch] )` - Calls [can-route.current route.current] with `hashes` and returns the result. This + Calls [can-route.isCurrent route.isCurrent] with `hashes` and returns the result. This can be used in conjunction with other helpers: ```html @@ -15,7 +15,7 @@ Returns if the hash values match the [can-route]’s current properties. Or on its own: ```html -Todos +Todos ``` @param {can-stache/expressions/hash} hashes A hash expression like `page='edit' recipeId=id`. @@ -24,15 +24,15 @@ Or on its own: return `true` if every value in `hashes` matches the current route data, even if the route data has additional properties that are not matched. - @return {Boolean} Returns the result of calling [can-route.current route.current]. + @return {Boolean} Returns the result of calling [can-route.isCurrent route.isCurrent]. -@signature `{{#routeCurrent([subsetMatch,] hashes...)}}FN{{else}}INVERSE{{/routeCurrent}}` +@signature `{{# routeCurrent([subsetMatch,] hashes...) }}FN{{else}}INVERSE{{/ routeCurrent }}` -Renders `FN` if the `hashes` passed to [can-route.current route.current] returns `true`. -Renders the `INVERSE` if [can-route.current route.current] returns `false`. +Renders `FN` if the `hashes` passed to [can-route.isCurrent route.isCurrent] returns `true`. +Renders the `INVERSE` if [can-route.isCurrent route.isCurrent] returns `false`. ```html -Todos +Todos ``` @param {Boolean} [subsetMatch] If an optional `true` is passed, `routeCurrent` will @@ -59,8 +59,8 @@ Renders the `INVERSE` if [can-route.current route.current] returns `false`. Use the `routeCurrent` helper like: ```html -
  • - {{recipe.name}} +
  • + {{recipe.name}}
  • ``` diff --git a/docs/routeUrl.md b/docs/routeUrl.md index 0377e96..f428d7d 100644 --- a/docs/routeUrl.md +++ b/docs/routeUrl.md @@ -1,11 +1,11 @@ -@function can-stache-route-helpers.routeUrl {{routeUrl(hashes)}} +@function can-stache-route-helpers.routeUrl {{ routeUrl(hashes) }} @parent can-stache-route-helpers Returns a url using [can-route.url route.url]. @signature `routeUrl( hashes... [,merge] )` -Calls [can-route.url] with `hashes` as its `data` argument and an +Calls [can-route.url route.url] with `hashes` as its `data` argument and an optional `merge`. This can be used on its own to create `` `href`s like: @@ -17,15 +17,15 @@ This can be used on its own to create `` `href`s like: Or in conjunction with other helpers: ```html -{{makeLink( "details", routeUrl(page='todos', true) )}} +{{ makeLink( "details", routeUrl(page='todos', true) ) }} ``` -@signature `{{routeUrl([merge,] hashes...)}}` +@signature `{{ routeUrl([merge,] hashes...) }}` Passes the hashes to `route.url` and returns the result. ```html -details +details ``` @param {Boolean} [merge] Pass `true` to create a url that merges `hashes` into the @@ -42,7 +42,7 @@ current [can-route] properties. Use the `routeUrl` helper like: ```html -{{recipe.name}} +{{recipe.name}} ``` This produces (with no pretty routing rules):