From b0309a0f69a79f7b9972cbd80d20c2a8e5d820fa Mon Sep 17 00:00:00 2001 From: kaesonho Date: Mon, 27 Jul 2015 16:00:48 -0700 Subject: [PATCH] update document and params name --- docs/api/createNavLinkComponent.md | 2 +- lib/createNavLinkComponent.js | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/createNavLinkComponent.md b/docs/api/createNavLinkComponent.md index c873504..a0cd907 100644 --- a/docs/api/createNavLinkComponent.md +++ b/docs/api/createNavLinkComponent.md @@ -6,7 +6,7 @@ | Param Name | Param Type | Description | |-----------|-----------|-------------| -| options | Object | the object taken to overwrite the default attribute when we create NavLink | +| overwriteSpec | Object | the spec object taken to overwrite the default spec when we create NavLink using React.createClass | ## Example Usage diff --git a/lib/createNavLinkComponent.js b/lib/createNavLinkComponent.js index f8e3881..01ae341 100644 --- a/lib/createNavLinkComponent.js +++ b/lib/createNavLinkComponent.js @@ -20,10 +20,10 @@ function isModifiedEvent (e) { /** * create NavLink component with custom options - * @param {Object} options to overwrite the default attributes to create NavLink + * @param {Object} overwriteSpec spec to overwrite the default spec to create NavLink * @returns {React.Component} NavLink component */ -module.exports = function createNavLinkComponent (options) { +module.exports = function createNavLinkComponent (overwriteSpec) { var NavLink = React.createClass(objectAssign({}, { displayName: 'NavLink', contextTypes: { @@ -169,6 +169,6 @@ module.exports = function createNavLinkComponent (options) { this.props.children ); } - }, options)); + }, overwriteSpec)); return NavLink; };