Skip to content
This repository has been archived by the owner on Jul 15, 2019. It is now read-only.

Commit

Permalink
add api document
Browse files Browse the repository at this point in the history
  • Loading branch information
kaesonho committed Jul 23, 2015
1 parent 043900a commit 72a10f4
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/api/createNavLink.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# createNavLink

`createNavLink` is a function for you to create a NavLink component, you are able to pass options to overwrite attributes to generate the NavLink. e.g., custom mixin or click handler.

## Parameters

| Param Name | Param Type | Description |
|-----------|-----------|-------------|
| options | Object | the object taken to overwrite the default attribute when we create NavLink |


## Example Usage

```js
var createNavLink = require('fluxible-router').createNavLink;

module.exports = createNavLink({
displayName: 'CustomNavLink',
mixins: [someMixin],
clickHandler: function (e) {
// custom click handler
this.dispatchNavAction(e);
}
});
```

0 comments on commit 72a10f4

Please sign in to comment.