From b7407b07ae7a3f61fedb7a25f11aa317eb240017 Mon Sep 17 00:00:00 2001 From: "dr.dimitru" Date: Wed, 8 Jun 2022 16:02:51 +0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=94=20Documentation=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 +++---- docs/README.md | 108 +++++++++++++++--------------- docs/api/README.md | 44 ++++++------ docs/api/current.md | 2 +- docs/api/decodeQueryParamsOnce.md | 4 +- docs/api/getRouteName.md | 2 +- docs/api/go.md | 4 +- docs/api/group.md | 10 +-- docs/api/initialize.md | 2 +- docs/api/path.md | 2 +- docs/api/pathRegExp.md | 6 +- docs/api/refresh.md | 6 +- docs/api/reload.md | 2 +- docs/api/render.md | 8 +-- docs/api/route.md | 4 +- docs/api/setParams.md | 6 +- docs/api/setQueryParams.md | 6 +- docs/api/triggers.md | 4 +- docs/api/url.md | 2 +- docs/api/wait.md | 2 +- docs/api/watchPathChange.md | 8 +-- docs/api/withReplaceState.md | 4 +- docs/auto-scroll.md | 2 +- docs/fast-render-integration.md | 10 +-- docs/full.md | 20 +++--- docs/helpers/README.md | 28 ++++---- docs/hooks/README.md | 18 ++--- docs/hooks/action.md | 10 +-- docs/hooks/data.md | 10 +-- docs/hooks/endWaiting.md | 4 +- docs/hooks/onNoData.md | 2 +- docs/hooks/triggersEnter.md | 10 +-- docs/hooks/triggersExit.md | 8 +-- docs/hooks/waitOn.md | 2 +- docs/hooks/waitOnResources.md | 2 +- docs/hooks/whileWaiting.md | 4 +- docs/quick-start.md | 12 ++-- docs/templating-with-data.md | 14 ++-- docs/templating-with-regions.md | 8 +-- docs/templating.md | 10 +-- 40 files changed, 218 insertions(+), 218 deletions(-) diff --git a/README.md b/README.md index eb9b3aa..dcd9d48 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,14 @@ It exposes a great API for changing the URL and getting data from the URL. Howev ## Features: -- 📦 Not dependent on Blaze, ready for [__React.js__](https://github.com/VeliovGroup/flow-router/blob/master/docs/react.md) and other templating/components engines/libs; +- 📦 Not dependent on Blaze, ready for [__React.js__](https://github.com/veliovgroup/flow-router/blob/master/docs/react.md) and other templating/components engines/libs; - 📦 No `underscore` package dependency; -- 👨‍🔬 Great [tests coverage](https://github.com/VeliovGroup/flow-router/tree/master/test); -- 🥑 Up-to-date [dependencies](https://github.com/VeliovGroup/flow-router/blob/master/package.js); -- 📦 Support of [Fast Render](https://github.com/VeliovGroup/flow-router/blob/master/docs/fast-render-integration.md) and [other great packages](https://github.com/VeliovGroup/flow-router#related-packages); -- 📋 Following semver with regular [releases](https://github.com/VeliovGroup/flow-router/releases); -- 📋 Great [wiki](https://github.com/VeliovGroup/flow-router/wiki); -- 📋 Great [quick start tutorial](https://github.com/VeliovGroup/flow-router/blob/master/docs/quick-start.md). +- 👨‍🔬 Great [tests coverage](https://github.com/veliovgroup/flow-router/tree/master/test); +- 🥑 Up-to-date [dependencies](https://github.com/veliovgroup/flow-router/blob/master/package.js); +- 📦 Support of [Fast Render](https://github.com/veliovgroup/flow-router/blob/master/docs/fast-render-integration.md) and [other great packages](https://github.com/veliovgroup/flow-router#related-packages); +- 📋 Following semver with regular [releases](https://github.com/veliovgroup/flow-router/releases); +- 📋 Great [wiki](https://github.com/veliovgroup/flow-router/wiki); +- 📋 Great [quick start tutorial](https://github.com/veliovgroup/flow-router/blob/master/docs/quick-start.md). ## Install @@ -69,15 +69,15 @@ FlowRouter.route('*', { ## Documentation -- Continue with our [wiki](https://github.com/VeliovGroup/flow-router/wiki); -- [Quick start](https://github.com/VeliovGroup/flow-router/blob/master/docs/quick-start.md) tutorial; -- All docs as [single document](https://github.com/VeliovGroup/flow-router/blob/master/docs/full.md). +- Continue with our [wiki](https://github.com/veliovgroup/flow-router/wiki); +- [Quick start](https://github.com/veliovgroup/flow-router/blob/master/docs/quick-start.md) tutorial; +- All docs as [single document](https://github.com/veliovgroup/flow-router/blob/master/docs/full.md). ### Related packages: -- [`ostrio:flow-router-title`](https://github.com/VeliovGroup/Meteor-flow-router-title) - Reactive page title (`document.title`) -- [`ostrio:flow-router-meta`](https://github.com/VeliovGroup/Meteor-flow-router-meta) - Per route `meta` tags, `script` and `link` (CSS), set per-route stylesheets and scripts -- [`communitypackages:fast-render`](https://github.com/Meteor-Community-Packages/meteor-fast-render) - Fast Render can improve the initial load time of your app, giving you 2-10 times faster initial page loads. [`fast-render` integration tutorial](https://github.com/VeliovGroup/flow-router/blob/master/docs/fast-render-integration.md) +- [`ostrio:flow-router-title`](https://github.com/veliovgroup/Meteor-flow-router-title) - Reactive page title (`document.title`) +- [`ostrio:flow-router-meta`](https://github.com/veliovgroup/Meteor-flow-router-meta) - Per route `meta` tags, `script` and `link` (CSS), set per-route stylesheets and scripts +- [`communitypackages:fast-render`](https://github.com/Meteor-Community-Packages/meteor-fast-render) - Fast Render can improve the initial load time of your app, giving you 2-10 times faster initial page loads. [`fast-render` integration tutorial](https://github.com/veliovgroup/flow-router/blob/master/docs/fast-render-integration.md) - [`communitypackages:inject-data`](https://github.com/Meteor-Community-Packages/meteor-inject-data) - This is the package used by `fast-render` to push data to the client with the initial HTML - [`flean:flow-router-autoscroll`](https://github.com/flean/flow-router-autoscroll) - Autoscroll for Flow Router - [`mealsunite:flow-routing-extra`](https://github.com/MealsUnite/flow-routing) - Add-on for User Accounts diff --git a/docs/README.md b/docs/README.md index ee1cd4a..bfafac2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -38,79 +38,79 @@ For the new apps it is recommended to set `decodeQueryParamsOnce` to `true`. Thi ## General tutorials: -- [Quick Start](https://github.com/VeliovGroup/flow-router/blob/master/docs/quick-start.md) -- [Templating](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating.md) -- [Templating with "Regions"](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating-with-regions.md) -- [Templating with Data](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating-with-data.md) -- [Auto-scroll](https://github.com/VeliovGroup/flow-router/blob/master/docs/auto-scroll.md) -- [React.js usage](https://github.com/VeliovGroup/flow-router/blob/master/docs/react.md) +- [Quick Start](https://github.com/veliovgroup/flow-router/blob/master/docs/quick-start.md) +- [Templating](https://github.com/veliovgroup/flow-router/blob/master/docs/templating.md) +- [Templating with "Regions"](https://github.com/veliovgroup/flow-router/blob/master/docs/templating-with-regions.md) +- [Templating with Data](https://github.com/veliovgroup/flow-router/blob/master/docs/templating-with-data.md) +- [Auto-scroll](https://github.com/veliovgroup/flow-router/blob/master/docs/auto-scroll.md) +- [React.js usage](https://github.com/veliovgroup/flow-router/blob/master/docs/react.md) ## Hooks (*in execution order*): -- [`.whileWaiting()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/whileWaiting.md) -- [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) -- [`.waitOnResources()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOnResources.md) -- [`.endWaiting()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/endWaiting.md) -- [`.data()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/data.md) -- [`.onNoData()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/onNoData.md) -- [`.triggersEnter()` hooks](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersEnter.md) -- [`.action()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/action.md) -- [`.triggersExit()` hooks](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersExit.md) +- [`.whileWaiting()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/whileWaiting.md) +- [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) +- [`.waitOnResources()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOnResources.md) +- [`.endWaiting()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/endWaiting.md) +- [`.data()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/data.md) +- [`.onNoData()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/onNoData.md) +- [`.triggersEnter()` hooks](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersEnter.md) +- [`.action()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/action.md) +- [`.triggersExit()` hooks](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersExit.md) ## Helpers: -- [`isActiveRoute` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/isActiveRoute.md) -- [`isActivePath` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/isActivePath.md) -- [`isNotActiveRoute` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/isNotActiveRoute.md) -- [`isNotActivePath` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/isNotActivePath.md) -- [`pathFor` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/pathFor.md) -- [`urlFor` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/urlFor.md) -- [`linkTo` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/linkTo.md) -- [`param` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/param.md) -- [`queryParam` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/queryParam.md) -- [`currentRouteName` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/currentRouteName.md) -- [`currentRouteOption` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/currentRouteOption.md) -- [`isActiveRoute` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/isActiveRoute.md) -- [`RouterHelpers` class](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/RouterHelpers.md) -- [`templatehelpers` package](https://github.com/VeliovGroup/Meteor-Template-helpers) +- [`isActiveRoute` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/isActiveRoute.md) +- [`isActivePath` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/isActivePath.md) +- [`isNotActiveRoute` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/isNotActiveRoute.md) +- [`isNotActivePath` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/isNotActivePath.md) +- [`pathFor` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/pathFor.md) +- [`urlFor` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/urlFor.md) +- [`linkTo` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/linkTo.md) +- [`param` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/param.md) +- [`queryParam` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/queryParam.md) +- [`currentRouteName` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/currentRouteName.md) +- [`currentRouteOption` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/currentRouteOption.md) +- [`isActiveRoute` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/isActiveRoute.md) +- [`RouterHelpers` class](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/RouterHelpers.md) +- [`templatehelpers` package](https://github.com/veliovgroup/Meteor-Template-helpers) ## API: - __General Methods:__ - - [`.go()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/go.md) - - [`.route()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/route.md) - - [`.group()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/group.md) - - [`.render()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/render.md) - - [Global `.triggers`](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/triggers.md) + - [`.go()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/go.md) + - [`.route()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/route.md) + - [`.group()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/group.md) + - [`.render()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/render.md) + - [Global `.triggers`](https://github.com/veliovgroup/flow-router/blob/master/docs/api/triggers.md) - __Workarounds:__ - - [`.refresh()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/refresh.md) - - [`.reload()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/reload.md) - - [`.pathRegExp` option](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/pathRegExp.md) - - [`.decodeQueryParamsOnce` option](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/decodeQueryParamsOnce.md) + - [`.refresh()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/refresh.md) + - [`.reload()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/reload.md) + - [`.pathRegExp` option](https://github.com/veliovgroup/flow-router/blob/master/docs/api/pathRegExp.md) + - [`.decodeQueryParamsOnce` option](https://github.com/veliovgroup/flow-router/blob/master/docs/api/decodeQueryParamsOnce.md) - __Manipulation:__ - - [`.getParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getParam.md) - - [`.getQueryParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getQueryParam.md) - - [`.setParams()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/setParams.md) - - [`.setQueryParams()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/setQueryParams.md) + - [`.getParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getParam.md) + - [`.getQueryParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getQueryParam.md) + - [`.setParams()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/setParams.md) + - [`.setQueryParams()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/setQueryParams.md) - __URLs and data:__ - - [`.url()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/url.md) - - [`.path()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/path.md) - - [`.current()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/current.md) - - [`.getRouteName()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getRouteName.md) + - [`.url()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/url.md) + - [`.path()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/path.md) + - [`.current()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/current.md) + - [`.getRouteName()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getRouteName.md) - __Reactivity:__ - - [`.watchPathChange()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/watchPathChange.md) - - [`.withReplaceState()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/withReplaceState.md) + - [`.watchPathChange()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/watchPathChange.md) + - [`.withReplaceState()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/withReplaceState.md) - __For add-on developers:__ - - [`.onRouteRegister()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/onRouteRegister.md) + - [`.onRouteRegister()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/onRouteRegister.md) - __Tweaking:__ - - [`.wait()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/wait.md) - - [`.initialize()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/initialize.md) + - [`.wait()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/wait.md) + - [`.initialize()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/initialize.md) ## Related packages: -- [`ostrio:flow-router-title`](https://github.com/VeliovGroup/Meteor-flow-router-title) - Reactive page title (`document.title`) -- [`ostrio:flow-router-meta`](https://github.com/VeliovGroup/Meteor-flow-router-meta) - Per route `meta` tags, `script` and `link` (CSS), set per-route stylesheets and scripts -- [`communitypackages:fast-render`](https://github.com/Meteor-Community-Packages/meteor-fast-render) - Fast Render can improve the initial load time of your app, giving you 2-10 times faster initial page loads. [`fast-render` integration tutorial](https://github.com/VeliovGroup/flow-router/blob/master/docs/fast-render-integration.md) +- [`ostrio:flow-router-title`](https://github.com/veliovgroup/Meteor-flow-router-title) - Reactive page title (`document.title`) +- [`ostrio:flow-router-meta`](https://github.com/veliovgroup/Meteor-flow-router-meta) - Per route `meta` tags, `script` and `link` (CSS), set per-route stylesheets and scripts +- [`communitypackages:fast-render`](https://github.com/Meteor-Community-Packages/meteor-fast-render) - Fast Render can improve the initial load time of your app, giving you 2-10 times faster initial page loads. [`fast-render` integration tutorial](https://github.com/veliovgroup/flow-router/blob/master/docs/fast-render-integration.md) - [`communitypackages:inject-data`](https://github.com/Meteor-Community-Packages/meteor-inject-data) - This is the package used by `fast-render` to push data to the client with the initial HTML - [`flean:flow-router-autoscroll`](https://github.com/flean/flow-router-autoscroll) - Autoscroll for Flow Router - [`mealsunite:flow-routing-extra`](https://github.com/MealsUnite/flow-routing) - Add-on for User Accounts diff --git a/docs/api/README.md b/docs/api/README.md index fa56343..49e0d0b 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -1,31 +1,31 @@ # API: - __General Methods:__ - - [`.go()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/go.md) - - [`.route()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/route.md) - - [`.group()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/group.md) - - [`.render()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/render.md) - - [Global `.triggers`](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/triggers.md) + - [`.go()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/go.md) + - [`.route()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/route.md) + - [`.group()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/group.md) + - [`.render()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/render.md) + - [Global `.triggers`](https://github.com/veliovgroup/flow-router/blob/master/docs/api/triggers.md) - __Workarounds:__ - - [`.refresh()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/refresh.md) - - [`.reload()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/reload.md) - - [`.pathRegExp` option](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/pathRegExp.md) - - [`.decodeQueryParamsOnce` option](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/decodeQueryParamsOnce.md) + - [`.refresh()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/refresh.md) + - [`.reload()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/reload.md) + - [`.pathRegExp` option](https://github.com/veliovgroup/flow-router/blob/master/docs/api/pathRegExp.md) + - [`.decodeQueryParamsOnce` option](https://github.com/veliovgroup/flow-router/blob/master/docs/api/decodeQueryParamsOnce.md) - __Manipulation:__ - - [`.getParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getParam.md) - - [`.getQueryParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getQueryParam.md) - - [`.setParams()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/setParams.md) - - [`.setQueryParams()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/setQueryParams.md) + - [`.getParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getParam.md) + - [`.getQueryParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getQueryParam.md) + - [`.setParams()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/setParams.md) + - [`.setQueryParams()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/setQueryParams.md) - __URLs and data:__ - - [`.url()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/url.md) - - [`.path()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/path.md) - - [`.current()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/current.md) - - [`.getRouteName()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getRouteName.md) + - [`.url()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/url.md) + - [`.path()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/path.md) + - [`.current()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/current.md) + - [`.getRouteName()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getRouteName.md) - __Reactivity:__ - - [`.watchPathChange()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/watchPathChange.md) - - [`.withReplaceState()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/withReplaceState.md) + - [`.watchPathChange()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/watchPathChange.md) + - [`.withReplaceState()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/withReplaceState.md) - __For add-on developers:__ - - [`.onRouteRegister()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/onRouteRegister.md) + - [`.onRouteRegister()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/onRouteRegister.md) - __Tweaking:__ - - [`.wait()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/wait.md) - - [`.initialize()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/initialize.md) + - [`.wait()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/wait.md) + - [`.initialize()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/initialize.md) diff --git a/docs/api/current.md b/docs/api/current.md index 37b7734..613c39b 100644 --- a/docs/api/current.md +++ b/docs/api/current.md @@ -26,4 +26,4 @@ console.log(current); ``` #### Further reading - - [`.watchPathChange()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/watchPathChange.md) + - [`.watchPathChange()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/watchPathChange.md) diff --git a/docs/api/decodeQueryParamsOnce.md b/docs/api/decodeQueryParamsOnce.md index 1dcf6dc..6a09d00 100644 --- a/docs/api/decodeQueryParamsOnce.md +++ b/docs/api/decodeQueryParamsOnce.md @@ -37,5 +37,5 @@ FlowRouter.current().queryParams; The former is no longer recommended, but to maintain compatibility with legacy apps, `false` is the default value for this flag. Enabling this flag manually with `true` is recommended for all new apps. For more info, see [#78](https://github.com/veliovgroup/flow-router/issues/78). #### Further reading - - [`.getQueryParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getQueryParam.md) - - [`.current()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/current.md) + - [`.getQueryParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getQueryParam.md) + - [`.current()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/current.md) diff --git a/docs/api/getRouteName.md b/docs/api/getRouteName.md index 36c1529..9656ef5 100644 --- a/docs/api/getRouteName.md +++ b/docs/api/getRouteName.md @@ -16,4 +16,4 @@ Tracker.autorun(function () { ``` #### Further reading - - [`.current()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/current.md) + - [`.current()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/current.md) diff --git a/docs/api/go.md b/docs/api/go.md index 8e2c88d..0ffe9ba 100644 --- a/docs/api/go.md +++ b/docs/api/go.md @@ -19,5 +19,5 @@ FlowRouter.go('blogPost', { _id: 'post_id' }, { commentId: '123' }); // /blog/po ``` #### Further reading - - [`.route()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/route.md) - - [`.getRouteName()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getRouteName.md) + - [`.route()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/route.md) + - [`.getRouteName()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getRouteName.md) diff --git a/docs/api/group.md b/docs/api/group.md index 5a7ce6d..bfb1660 100644 --- a/docs/api/group.md +++ b/docs/api/group.md @@ -7,7 +7,7 @@ Use group routes for better route organization. - `options.name` {*String*} - [Optional] Route's name - `options.prefix` {*String*} - [Optional] Route prefix - `options[prop-name]` {*Any*} - [Optional] Any property which will be available inside route call - - `options[hook-name]` {*Function*} - [Optional] See [all available hooks](https://github.com/VeliovGroup/flow-router/tree/master/docs#hooks-in-execution-order) + - `options[hook-name]` {*Function*} - [Optional] See [all available hooks](https://github.com/veliovgroup/flow-router/tree/master/docs#hooks-in-execution-order) - Returns {*Group*} ```js @@ -61,7 +61,7 @@ FlowRouter.current().route.group.parent.name ``` #### Further reading - - [`.triggersEnter()` hooks](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersEnter.md) - - [`.action()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/action.md) - - [`.route()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/route.md) - - [`.current()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/current.md) + - [`.triggersEnter()` hooks](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersEnter.md) + - [`.action()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/action.md) + - [`.route()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/route.md) + - [`.current()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/current.md) diff --git a/docs/api/initialize.md b/docs/api/initialize.md index 5798ea8..52acd82 100644 --- a/docs/api/initialize.md +++ b/docs/api/initialize.md @@ -26,4 +26,4 @@ WhenEverYourAppIsReady(() => { #### Further reading -- [`.wait()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/wait.md) +- [`.wait()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/wait.md) diff --git a/docs/api/path.md b/docs/api/path.md index 902fbab..232b068 100644 --- a/docs/api/path.md +++ b/docs/api/path.md @@ -20,4 +20,4 @@ console.log(path); // --> "/blog/met%20eor/abc?show=y%2Be%3Ds&color=black" If there are no `params` or `qs`, it will simply return the path as it is. #### Further reading - - [`.url()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/url.md) + - [`.url()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/url.md) diff --git a/docs/api/pathRegExp.md b/docs/api/pathRegExp.md index 45eedc3..652e1d2 100644 --- a/docs/api/pathRegExp.md +++ b/docs/api/pathRegExp.md @@ -7,8 +7,8 @@ FlowRouter.pathRegExp = /(:[\w\(\)\\\+\*\.\?\[\]]+)+/g; - `pathRegExp` {*RegExp*} - Default - `/(:[\w\(\)\\\+\*\.\?\[\]\-]+)+/g` -Use to change the URI RegEx parser used for `params`, for more info see [#25](https://github.com/VeliovGroup/flow-router/issues/25). +Use to change the URI RegEx parser used for `params`, for more info see [#25](https://github.com/veliovgroup/flow-router/issues/25). #### Further reading - - [`.route()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/route.md) - - [`.group()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/group.md) + - [`.route()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/route.md) + - [`.group()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/group.md) diff --git a/docs/api/refresh.md b/docs/api/refresh.md index 589061d..86bb31b 100644 --- a/docs/api/refresh.md +++ b/docs/api/refresh.md @@ -48,6 +48,6 @@ Meteor.logout((error) => { ``` #### Further reading - - [`.go()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/go.md) - - [`.route()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/route.md) - - [`.group()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/group.md) + - [`.go()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/go.md) + - [`.route()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/route.md) + - [`.group()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/group.md) diff --git a/docs/api/reload.md b/docs/api/reload.md index 1280b20..2b96f44 100644 --- a/docs/api/reload.md +++ b/docs/api/reload.md @@ -10,4 +10,4 @@ FlowRouter routes are idempotent. That means, even if you call `FlowRouter.go()` So, if you really need to reload the route, this is the method you want. #### Further reading - - [`.refresh()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/refresh.md) + - [`.refresh()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/refresh.md) diff --git a/docs/api/render.md b/docs/api/render.md index 5f99771..3d9350a 100644 --- a/docs/api/render.md +++ b/docs/api/render.md @@ -1,6 +1,6 @@ ### render method -`this.render()` method is available only [inside hooks](https://github.com/VeliovGroup/flow-router/tree/master/docs#hooks-in-execution-order). +`this.render()` method is available only [inside hooks](https://github.com/veliovgroup/flow-router/tree/master/docs#hooks-in-execution-order). - __Note__: `this.render()` method is available only if application has `templating` and `blaze`, or `blaze-html-templates` packages installed. @@ -61,6 +61,6 @@ FlowRouter.onRenderError = function (error) { #### Further reading -- [Templating](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating.md) -- [Templating with "Regions"](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating-with-regions.md) -- [Templating with Data](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating-with-data.md) +- [Templating](https://github.com/veliovgroup/flow-router/blob/master/docs/templating.md) +- [Templating with "Regions"](https://github.com/veliovgroup/flow-router/blob/master/docs/templating-with-regions.md) +- [Templating with Data](https://github.com/veliovgroup/flow-router/blob/master/docs/templating-with-data.md) diff --git a/docs/api/route.md b/docs/api/route.md index af780f2..af6ffaa 100644 --- a/docs/api/route.md +++ b/docs/api/route.md @@ -5,7 +5,7 @@ - `options` {*Object*} - `options.name` {*String*} - Route's name - `options[prop-name]` {*Any*} - [Optional] Any property which will be available inside route call - - `options[hook-name]` {*Function*} - [Optional] See [all available hooks](https://github.com/VeliovGroup/flow-router/tree/master/docs#hooks-in-execution-order) + - `options[hook-name]` {*Function*} - [Optional] See [all available hooks](https://github.com/veliovgroup/flow-router/tree/master/docs#hooks-in-execution-order) - Returns {*Route*} ```js @@ -33,4 +33,4 @@ FlowRouter.route('*', { ``` #### Further reading - - [`.path()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/path.md) + - [`.path()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/path.md) diff --git a/docs/api/setParams.md b/docs/api/setParams.md index 3a22546..e63d98b 100644 --- a/docs/api/setParams.md +++ b/docs/api/setParams.md @@ -18,6 +18,6 @@ FlowRouter.setParams({appId: 'new-id'}); ``` #### Further reading - - [`.setQueryParams()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/setQueryParams.md) - - [`.getQueryParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getQueryParam.md) - - [`.getParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getParam.md) + - [`.setQueryParams()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/setQueryParams.md) + - [`.getQueryParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getQueryParam.md) + - [`.getParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getParam.md) diff --git a/docs/api/setQueryParams.md b/docs/api/setQueryParams.md index 382595d..815c9ee 100644 --- a/docs/api/setQueryParams.md +++ b/docs/api/setQueryParams.md @@ -14,6 +14,6 @@ FlowRouter.setQueryParams({ paramToRemove: null }); ``` #### Further reading - - [`.getQueryParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getQueryParam.md) - - [`.setParams()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/setParams.md) - - [`.getParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getParam.md) + - [`.getQueryParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getQueryParam.md) + - [`.setParams()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/setParams.md) + - [`.getParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getParam.md) diff --git a/docs/api/triggers.md b/docs/api/triggers.md index 8b020e5..bdc4d67 100644 --- a/docs/api/triggers.md +++ b/docs/api/triggers.md @@ -13,5 +13,5 @@ To filter routes use `only` or `except` keywords. You can't use both `only` and `except` at once. #### Further reading - - [`.triggersEnter()` hooks](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersEnter.md) - - [`.triggersExit()` hooks](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersExit.md) + - [`.triggersEnter()` hooks](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersEnter.md) + - [`.triggersExit()` hooks](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersExit.md) diff --git a/docs/api/url.md b/docs/api/url.md index adbfd64..3b57744 100644 --- a/docs/api/url.md +++ b/docs/api/url.md @@ -9,4 +9,4 @@ FlowRouter.url(path, params, qs); - Returns {*String*} - Absolute URL using `Meteor.absoluteUrl` #### Further reading - - [`.path()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/path.md) + - [`.path()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/path.md) diff --git a/docs/api/wait.md b/docs/api/wait.md index c8a451a..42b7b67 100644 --- a/docs/api/wait.md +++ b/docs/api/wait.md @@ -18,4 +18,4 @@ WhenEverYourAppIsReady(() => { ``` #### Further reading - - [`.initialize()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/initialize.md) + - [`.initialize()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/initialize.md) diff --git a/docs/api/watchPathChange.md b/docs/api/watchPathChange.md index 2804644..7e3383b 100644 --- a/docs/api/watchPathChange.md +++ b/docs/api/watchPathChange.md @@ -16,7 +16,7 @@ Tracker.autorun(() => { ``` #### Further reading - - [`.current()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/current.md) - - [`.getQueryParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getQueryParam.md) - - [`.getParam()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getParam.md) - - [`.getRouteName()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/getRouteName.md) + - [`.current()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/current.md) + - [`.getQueryParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getQueryParam.md) + - [`.getParam()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getParam.md) + - [`.getRouteName()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/getRouteName.md) diff --git a/docs/api/withReplaceState.md b/docs/api/withReplaceState.md index 06a1f46..32acd98 100644 --- a/docs/api/withReplaceState.md +++ b/docs/api/withReplaceState.md @@ -27,6 +27,6 @@ FlowRouter.withReplaceState(() => { ``` #### Further reading - - [`.go()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/go.md) - - [`.setParams()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/setParams.md) + - [`.go()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/go.md) + - [`.setParams()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/setParams.md) diff --git a/docs/auto-scroll.md b/docs/auto-scroll.md index b97c63f..d3f3d6b 100644 --- a/docs/auto-scroll.md +++ b/docs/auto-scroll.md @@ -2,7 +2,7 @@ *FlowRouter* causes the page to remain at the same scroll position on navigation between routes (which people are often surprised by). Little snipped below would fix this behavior to more common, when each page loaded at the top of the scrolling position. -Originated from [`#9`](https://github.com/VeliovGroup/flow-router/issues/9). +Originated from [`#9`](https://github.com/veliovgroup/flow-router/issues/9). ```js import { FlowRouter } from 'meteor/ostrio:flow-router-extra'; diff --git a/docs/fast-render-integration.md b/docs/fast-render-integration.md index cf9e7e2..e5b6b23 100644 --- a/docs/fast-render-integration.md +++ b/docs/fast-render-integration.md @@ -56,8 +56,8 @@ FlowRouter.route('/:_id', { #### Further Reading - [Fast Render Repository](https://github.com/abecks/meteor-fast-render) -- [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) -- [`.subscriptions()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/original-readme.md#subscription-management) -- [`.data()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/data.md) -- [`.action()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/action.md) -- [`.render()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/render.md) +- [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) +- [`.subscriptions()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/original-readme.md#subscription-management) +- [`.data()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/data.md) +- [`.action()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/action.md) +- [`.render()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/render.md) diff --git a/docs/full.md b/docs/full.md index aee9867..f2c3575 100644 --- a/docs/full.md +++ b/docs/full.md @@ -244,7 +244,7 @@ Use group routes for better route organization. - `options.name` {*String*} - [Optional] Route's name - `options.prefix` {*String*} - [Optional] Route prefix - `options[prop-name]` {*Any*} - [Optional] Any property which will be available inside route call - - `options[hook-name]` {*Function*} - [Optional] See [all available hooks](https://github.com/VeliovGroup/flow-router/tree/master/docs#hooks-in-execution-order) + - `options[hook-name]` {*Function*} - [Optional] See [all available hooks](https://github.com/veliovgroup/flow-router/tree/master/docs#hooks-in-execution-order) - Returns {*Group*} ```js @@ -371,7 +371,7 @@ FlowRouter.pathRegExp = /(:[\w\(\)\\\+\*\.\?\[\]]+)+/g; - `pathRegExp` {*RegExp*} - Default - `/(:[\w\(\)\\\+\*\.\?\[\]\-]+)+/g` -Use to change the URI RegEx parser used for `params`, for more info see [#25](https://github.com/VeliovGroup/flow-router/issues/25). +Use to change the URI RegEx parser used for `params`, for more info see [#25](https://github.com/veliovgroup/flow-router/issues/25). ------- @@ -481,7 +481,7 @@ So, if you really need to reload the route, this is the method you want. ### render method -`this.render()` method is available only [inside hooks](https://github.com/VeliovGroup/flow-router/tree/master/docs#hooks-in-execution-order). +`this.render()` method is available only [inside hooks](https://github.com/veliovgroup/flow-router/tree/master/docs#hooks-in-execution-order). - __Note__: `this.render()` method is available only if application has `templating` and `blaze`, or `blaze-html-templates` packages installed. @@ -519,7 +519,7 @@ So, if you really need to reload the route, this is the method you want. - `options` {*Object*} - `options.name` {*String*} - Route's name - `options[prop-name]` {*Any*} - [Optional] Any property which will be available inside route call - - `options[hook-name]` {*Function*} - [Optional] See [all available hooks](https://github.com/VeliovGroup/flow-router/tree/master/docs#hooks-in-execution-order) + - `options[hook-name]` {*Function*} - [Optional] See [all available hooks](https://github.com/veliovgroup/flow-router/tree/master/docs#hooks-in-execution-order) - Returns {*Route*} ```js @@ -697,11 +697,11 @@ FlowRouter.withReplaceState(() => { - Return: {*void*} `.action()` hook is triggered right after page is navigated to route, or after (*exact order, if any of those is defined*): - - [`.whileWaiting()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/whileWaiting.md) - - [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) - - [`.waitOnResources()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOnResources.md) - - [`.triggersEnter()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersEnter.md) - - [`.data()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/data.md) + - [`.whileWaiting()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/whileWaiting.md) + - [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) + - [`.waitOnResources()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOnResources.md) + - [`.triggersEnter()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersEnter.md) + - [`.data()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/data.md) ------- @@ -804,7 +804,7 @@ FlowRouter.route('/post/:_id', { `triggersEnter` is option (*not actually a hook*), it accepts array of *Function*s, each function will be called with next arguments: - `context` {*Route*} - Output of `FlowRouter.current()` - - `redirect` {*Function*} - Use to redirect to another route, same as [`FlowRouter.go()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/go.md) + - `redirect` {*Function*} - Use to redirect to another route, same as [`FlowRouter.go()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/go.md) - `stop` {*Function*} - Use to abort current route execution - `data` {*Mix*} - Value returned from `.data()` hook - Return: {*void*} diff --git a/docs/helpers/README.md b/docs/helpers/README.md index 2cc5c27..dda483e 100644 --- a/docs/helpers/README.md +++ b/docs/helpers/README.md @@ -1,16 +1,16 @@ # Helpers: -- [`isActiveRoute` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/isActiveRoute.md) -- [`isActivePath` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/isActivePath.md) -- [`isNotActiveRoute` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/isNotActiveRoute.md) -- [`isNotActivePath` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/isNotActivePath.md) -- [`pathFor` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/pathFor.md) -- [`urlFor` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/urlFor.md) -- [`linkTo` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/linkTo.md) -- [`param` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/param.md) -- [`queryParam` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/queryParam.md) -- [`currentRouteName` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/currentRouteName.md) -- [`currentRouteOption` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/currentRouteOption.md) -- [`isActiveRoute` template helper](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/isActiveRoute.md) -- [`RouterHelpers` class](https://github.com/VeliovGroup/flow-router/blob/master/docs/helpers/RouterHelpers.md) -- [`templatehelpers` package](https://github.com/VeliovGroup/Meteor-Template-helpers) +- [`isActiveRoute` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/isActiveRoute.md) +- [`isActivePath` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/isActivePath.md) +- [`isNotActiveRoute` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/isNotActiveRoute.md) +- [`isNotActivePath` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/isNotActivePath.md) +- [`pathFor` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/pathFor.md) +- [`urlFor` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/urlFor.md) +- [`linkTo` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/linkTo.md) +- [`param` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/param.md) +- [`queryParam` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/queryParam.md) +- [`currentRouteName` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/currentRouteName.md) +- [`currentRouteOption` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/currentRouteOption.md) +- [`isActiveRoute` template helper](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/isActiveRoute.md) +- [`RouterHelpers` class](https://github.com/veliovgroup/flow-router/blob/master/docs/helpers/RouterHelpers.md) +- [`templatehelpers` package](https://github.com/veliovgroup/Meteor-Template-helpers) diff --git a/docs/hooks/README.md b/docs/hooks/README.md index 56556b5..801c5f6 100644 --- a/docs/hooks/README.md +++ b/docs/hooks/README.md @@ -1,11 +1,11 @@ # Hooks (*in execution order*): -- [`.whileWaiting()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/whileWaiting.md) -- [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) -- [`.waitOnResources()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOnResources.md) -- [`.endWaiting()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/endWaiting.md) -- [`.data()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/data.md) -- [`.onNoData()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/onNoData.md) -- [`.triggersEnter()` hooks](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersEnter.md) -- [`.action()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/action.md) -- [`.triggersExit()` hooks](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersExit.md) +- [`.whileWaiting()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/whileWaiting.md) +- [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) +- [`.waitOnResources()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOnResources.md) +- [`.endWaiting()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/endWaiting.md) +- [`.data()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/data.md) +- [`.onNoData()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/onNoData.md) +- [`.triggersEnter()` hooks](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersEnter.md) +- [`.action()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/action.md) +- [`.triggersExit()` hooks](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersExit.md) diff --git a/docs/hooks/action.md b/docs/hooks/action.md index 0b2775f..0bff044 100644 --- a/docs/hooks/action.md +++ b/docs/hooks/action.md @@ -7,8 +7,8 @@ - Return: {*void*} `.action()` hook is triggered right after page is navigated to route, or after (*exact order, if any of those is defined*): - - [`.whileWaiting()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/whileWaiting.md) - - [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) - - [`.waitOnResources()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOnResources.md) - - [`.triggersEnter()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersEnter.md) - - [`.data()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/data.md) + - [`.whileWaiting()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/whileWaiting.md) + - [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) + - [`.waitOnResources()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOnResources.md) + - [`.triggersEnter()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersEnter.md) + - [`.data()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/data.md) diff --git a/docs/hooks/data.md b/docs/hooks/data.md index 01a04a5..41938da 100644 --- a/docs/hooks/data.md +++ b/docs/hooks/data.md @@ -59,8 +59,8 @@ FlowRouter.route('/post/:_id', { ``` #### Further reading - - [`.triggersEnter()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersEnter.md) - - [`.onNoData()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/onNoData.md) - - [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) - - [`.render()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/render.md) - - [Templating with Data](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating-with-data.md) + - [`.triggersEnter()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersEnter.md) + - [`.onNoData()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/onNoData.md) + - [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) + - [`.render()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/render.md) + - [Templating with Data](https://github.com/veliovgroup/flow-router/blob/master/docs/templating-with-data.md) diff --git a/docs/hooks/endWaiting.md b/docs/hooks/endWaiting.md index 7b72c9a..4c877f4 100644 --- a/docs/hooks/endWaiting.md +++ b/docs/hooks/endWaiting.md @@ -6,5 +6,5 @@ `.endWaiting()` hook is triggered right after all resources in `.waitOn()` and `.waitOnResources()` hooks are ready. #### Further reading - - [`.whileWaiting()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/whileWaiting.md) - - [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) + - [`.whileWaiting()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/whileWaiting.md) + - [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) diff --git a/docs/hooks/onNoData.md b/docs/hooks/onNoData.md index 6fbe81d..d513024 100644 --- a/docs/hooks/onNoData.md +++ b/docs/hooks/onNoData.md @@ -21,4 +21,4 @@ FlowRouter.route('/post/:_id', { ``` #### Further reading - - [`.data()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/data.md) + - [`.data()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/data.md) diff --git a/docs/hooks/triggersEnter.md b/docs/hooks/triggersEnter.md index 00d7f07..aeb4909 100644 --- a/docs/hooks/triggersEnter.md +++ b/docs/hooks/triggersEnter.md @@ -2,7 +2,7 @@ `triggersEnter` is option (*not actually a hook*), it accepts array of *Function*s, each function will be called with next arguments: - `context` {*Route*} - Output of `FlowRouter.current()` - - `redirect` {*Function*} - Use to redirect to another route, same as [`FlowRouter.go()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/go.md) + - `redirect` {*Function*} - Use to redirect to another route, same as [`FlowRouter.go()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/go.md) - `stop` {*Function*} - Use to abort current route execution - `data` {*Mix*} - Value returned from `.data()` hook - Return: {*void*} @@ -48,7 +48,7 @@ FlowRouter.triggers.enter([cb1, cb2]); ``` #### Further reading - - [`.current()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/current.md) - - [Global `.triggers`](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/triggers.md) - - [`.action()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/action.md) - - [`.triggersExit()` hooks](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersExit.md) + - [`.current()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/current.md) + - [Global `.triggers`](https://github.com/veliovgroup/flow-router/blob/master/docs/api/triggers.md) + - [`.action()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/action.md) + - [`.triggersExit()` hooks](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersExit.md) diff --git a/docs/hooks/triggersExit.md b/docs/hooks/triggersExit.md index 95d9ed5..4ac65f2 100644 --- a/docs/hooks/triggersExit.md +++ b/docs/hooks/triggersExit.md @@ -32,7 +32,7 @@ FlowRouter.triggers.exit([cb1, cb2]); ``` #### Further reading - - [`.current()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/current.md) - - [Global `.triggers`](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/triggers.md) - - [`.action()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/action.md) - - [`.triggersEnter()` hooks](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/triggersEnter.md) + - [`.current()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/current.md) + - [Global `.triggers`](https://github.com/veliovgroup/flow-router/blob/master/docs/api/triggers.md) + - [`.action()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/action.md) + - [`.triggersEnter()` hooks](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/triggersEnter.md) diff --git a/docs/hooks/waitOn.md b/docs/hooks/waitOn.md index 0ffbb5b..894ce13 100644 --- a/docs/hooks/waitOn.md +++ b/docs/hooks/waitOn.md @@ -157,4 +157,4 @@ FlowRouter.route('/posts', { #### Further reading -- [`.waitOnResources()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOnResources.md) +- [`.waitOnResources()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOnResources.md) diff --git a/docs/hooks/waitOnResources.md b/docs/hooks/waitOnResources.md index a10afad..4342095 100644 --- a/docs/hooks/waitOnResources.md +++ b/docs/hooks/waitOnResources.md @@ -81,4 +81,4 @@ FlowRouter.globals.push({ ``` #### Further reading - - [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) + - [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) diff --git a/docs/hooks/whileWaiting.md b/docs/hooks/whileWaiting.md index c86ec85..44de2a5 100644 --- a/docs/hooks/whileWaiting.md +++ b/docs/hooks/whileWaiting.md @@ -20,5 +20,5 @@ FlowRouter.route('/post/:_id', { ``` #### Further reading - - [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) - - [Templating with Data](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating-with-data.md) + - [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) + - [Templating with Data](https://github.com/veliovgroup/flow-router/blob/master/docs/templating-with-data.md) diff --git a/docs/quick-start.md b/docs/quick-start.md index a15c961..0624e59 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -88,9 +88,9 @@ Package['kadira:flow-router'] = Package['ostrio:flow-router-extra']; ``` #### Further reading - - [Templating](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating.md) - - [Templating with Data](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating-with-data.md) - - [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) - - [`.data()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/data.md) - - [`.action()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/action.md) - - [`.render()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/render.md) + - [Templating](https://github.com/veliovgroup/flow-router/blob/master/docs/templating.md) + - [Templating with Data](https://github.com/veliovgroup/flow-router/blob/master/docs/templating-with-data.md) + - [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) + - [`.data()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/data.md) + - [`.action()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/action.md) + - [`.render()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/render.md) diff --git a/docs/templating-with-data.md b/docs/templating-with-data.md index 5ae4a65..28e02b2 100644 --- a/docs/templating-with-data.md +++ b/docs/templating-with-data.md @@ -96,10 +96,10 @@ FlowRouter.route('/article/:_id', { ``` #### Further Reading - - [`.action()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/action.md) - - [`.data()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/data.md) - - [`.onNoData()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/onNoData.md) - - [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) - - [`.whileWaiting()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/whileWaiting.md) - - [`.render()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/render.md) - - [Templating with "Regions"](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating-with-regions.md) + - [`.action()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/action.md) + - [`.data()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/data.md) + - [`.onNoData()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/onNoData.md) + - [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) + - [`.whileWaiting()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/whileWaiting.md) + - [`.render()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/render.md) + - [Templating with "Regions"](https://github.com/veliovgroup/flow-router/blob/master/docs/templating-with-regions.md) diff --git a/docs/templating-with-regions.md b/docs/templating-with-regions.md index 0946e2f..e533d68 100644 --- a/docs/templating-with-regions.md +++ b/docs/templating-with-regions.md @@ -91,7 +91,7 @@ FlowRouter.route('/', { ``` #### Further Reading - - [`.action()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/action.md) - - [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) - - [`.render()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/render.md) - - [Templating with Data](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating-with-data.md) + - [`.action()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/action.md) + - [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) + - [`.render()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/render.md) + - [Templating with Data](https://github.com/veliovgroup/flow-router/blob/master/docs/templating-with-data.md) diff --git a/docs/templating.md b/docs/templating.md index b2c8c68..a15a907 100644 --- a/docs/templating.md +++ b/docs/templating.md @@ -125,8 +125,8 @@ FlowRouter.route('/item/:_id', { #### Further Reading -- [`.action()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/action.md) -- [`.waitOn()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/waitOn.md) -- [`.whileWaiting()` hook](https://github.com/VeliovGroup/flow-router/blob/master/docs/hooks/whileWaiting.md) -- [`.render()` method](https://github.com/VeliovGroup/flow-router/blob/master/docs/api/render.md) -- [Templating with "Regions"](https://github.com/VeliovGroup/flow-router/blob/master/docs/templating-with-regions.md) +- [`.action()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/action.md) +- [`.waitOn()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/waitOn.md) +- [`.whileWaiting()` hook](https://github.com/veliovgroup/flow-router/blob/master/docs/hooks/whileWaiting.md) +- [`.render()` method](https://github.com/veliovgroup/flow-router/blob/master/docs/api/render.md) +- [Templating with "Regions"](https://github.com/veliovgroup/flow-router/blob/master/docs/templating-with-regions.md)