https://github.com/nicolaslopezj/meteor-router-layer

A layer for Meteor Routers
https://github.com/nicolaslopezj/meteor-router-layer

Last synced: 4 days ago
JSON representation

A layer for Meteor Routers

• Host: GitHub
• URL: https://github.com/nicolaslopezj/meteor-router-layer
• Owner: nicolaslopezj
• License: mit
• Created: 2015-08-10T15:12:14.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-09T04:37:27.000Z (over 7 years ago)
• Last Synced: 2024-11-01T18:51:31.672Z (11 days ago)
• Language: JavaScript
• Size: 18.6 KB
• Stars: 49
• Watchers: 5
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Meteor Router Layer

```

nicolaslopezj:router-layer

```

This project helps package authors to support multiple routers.

The layer supports:

- [Iron Router](https://github.com/iron-meteor/iron-router)

Requires: ```iron:router```

- [Flow Router](https://github.com/kadirahq/flow-router)

Requires: ```kadira:flow-router``` ```kadira:blaze-layout```

For flow router it allows you to use ```{{# Layout }}``` like

[iron:layout](https://github.com/iron-meteor/iron-layout)

without using it as a dependency (only for plain ```{{> yield }}```).

## Api

#### RouterLayer.route(url, options)

Creates a new route

**Parameters**

**url**: `String`, The path of the route

**options**

**options.template**: `String`, The template for this route

**options.layout**: `String`, Optional. The layout for this route

**options.name**: `String`, Optional. The name of the route

#### RouterLayer.pathFor(routeName, params)

Returns the path for a route

**Parameters**

**routeName**: `String`, The name of the route

**params**: `Object`, Parameters for the route

**Returns**: `String`, The requested url

#### RouterLayer.isActiveRoute(routeName, params)

Check if the current route has the specified name and params (if set)

**Parameters**

**routeName**: `String`, The name of the route

**params**: `Object`, Optional. The parameters of the route

**Returns**: `Boolean`, True if the route is active

#### RouterLayer.isActiveRoutePartial(routeName)

Check if the current route name, divided by dots, starts with the specified name

**Parameters**

**routeName**: `String`, The name of the route

**Returns**: `Boolean`, True if the route is active

#### RouterLayer.go(routeName, params)

Redirects the user to the specified route

**Parameters**

**routeName**: `String`, The name of the route

**params**: `Object`, Optional. The parameters of the route

#### RouterLayer.getParam(paramName)

Returns a parameter of the url

**Parameters**

**paramName**: `String`, The name of the parameter

#### RouterLayer.getQueryParam(queryStringKey)

Returns a parameter of the url

**Parameters**

**queryStringKey**: `String`, The name of the parameter

#### RouterLayer.getPath()

Returns the path of the current route