{
"project": {
"name": "itsa-react-input",
"description": "Beautiful functional input-element for react",
"logo": "https://avatars0.githubusercontent.com/u/8314644?v=3&s=84",
"version": "0.0.1"
},
"files": {
"lib/component.jsx": {
"name": "lib/component.jsx",
"modules": {
"itsa-react-input": 1
},
"classes": {
"Input": 1
},
"fors": {},
"namespaces": {}
}
},
"modules": {
"itsa-react-input": {
"name": "itsa-react-input",
"submodules": {},
"elements": {},
"classes": {
"Input": 1
},
"fors": {},
"namespaces": {},
"tag": "module",
"file": "lib/component.jsx",
"line": 3,
"description": "Description here\n\n\n\nCopyright (c) 2016 ItsAsbreuk - http://itsasbreuk.nl
\nNew BSD License - http://choosealicense.com/licenses/bsd-3-clause/",
"since": "0.0.1"
}
},
"classes": {
"Input": {
"name": "Input",
"shortname": "Input",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "itsa-react-input",
"namespace": "",
"file": "lib/component.jsx",
"line": 3,
"description": "Description here\n\n\n\nCopyright (c) 2016 ItsAsbreuk - http://itsasbreuk.nl
\nNew BSD License - http://choosealicense.com/licenses/bsd-3-clause/"
}
},
"elements": {},
"classitems": [
{
"file": "lib/component.jsx",
"line": 49,
"description": "componentDidMount will call `this.activatePlaces()`;",
"itemtype": "method",
"name": "componentDidMount",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 63,
"description": "componentWilUnmount does some cleanup.",
"itemtype": "method",
"name": "componentWillUnmount",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 73,
"description": "Returns the rendered React-Element that serves as the source dom-element",
"itemtype": "method",
"name": "element",
"params": [
{
"name": "props",
"description": "props to be passed through to the Component",
"type": "Object"
}
],
"return": {
"description": "ReactComponent"
},
"since": "0.0.4",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 85,
"description": "Sets the focus on the Component.",
"itemtype": "method",
"name": "focus",
"params": [
{
"name": "transitionTime",
"description": "transition-time to focus the element into the view",
"type": "Number",
"optional": true
}
],
"chainable": 1,
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 107,
"description": "The method that is called whenever the input-Element gets blurred.\nIt will change its internal state, so that the css looks right and\nalso any validation-messages appear.",
"itemtype": "method",
"name": "handleBlur",
"params": [
{
"name": "e",
"description": "event-payload",
"type": "Object"
}
],
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 126,
"description": "The method that is called whenever the input-Element changes its value.\nWill update the Redux-store (signupuser.homeaddress);",
"itemtype": "method",
"name": "handleChange",
"params": [
{
"name": "e",
"description": "event-payload",
"type": "Object"
}
],
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 143,
"description": "The method that is called whenever the input-Element gets clicked.",
"itemtype": "method",
"name": "handleClick",
"params": [
{
"name": "e",
"description": "event-payload",
"type": "Object"
}
],
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 157,
"description": "Callback that sets the focus to the descendent element by calling `focus()`",
"itemtype": "method",
"name": "handleContainerFocus",
"params": [
{
"name": "e",
"description": "event-payload",
"type": "Object"
}
],
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 168,
"description": "The method that is called whenever the input-Element gets the focus.\nIt will change its internal state, so that the css looks right and\nalso any validation-messages disappear.",
"itemtype": "method",
"name": "handleFocus",
"params": [
{
"name": "e",
"description": "event-payload",
"type": "Object"
}
],
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 189,
"description": "The method that is called whenever the input-Element recieves a keyDown.",
"itemtype": "method",
"name": "handleKeyDown",
"params": [
{
"name": "e",
"description": "event-payload",
"type": "Object"
}
],
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 203,
"description": "The method that is called whenever the input-Element recieves a keyPress.",
"itemtype": "method",
"name": "handleKeyPress",
"params": [
{
"name": "e",
"description": "event-payload",
"type": "Object"
}
],
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 220,
"description": "The method that is called whenever the input-Element recieves a keyUp.",
"itemtype": "method",
"name": "handleKeyUp",
"params": [
{
"name": "e",
"description": "event-payload",
"type": "Object"
}
],
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 231,
"description": "React render-method --> renderes the Component.",
"itemtype": "method",
"name": "render",
"return": {
"description": "ReactComponent"
},
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 319,
"description": "Merges the `data-*` attributes from props into the object",
"itemtype": "method",
"name": "_mergeDataAttrs",
"params": [
{
"name": "inputProps",
"description": "the source props which will be extended",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"return": {
"description": "object all the data-* attributes"
},
"since": "0.2.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 339,
"description": "Whether to autofocus the Component.",
"itemtype": "property",
"name": "autoFocus",
"type": "Boolean",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 348,
"description": "The class that should be set on the element",
"itemtype": "property",
"name": "className",
"type": "String",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 357,
"description": "The class that should be set on the underlying input-element",
"itemtype": "property",
"name": "classNameInput",
"type": "String",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 366,
"description": "The error-message that appears when the element is wrong validated.",
"itemtype": "property",
"name": "errorMsg",
"type": "String",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 375,
"description": "Whether the component is disabled",
"itemtype": "property",
"name": "disabled",
"type": "Boolean",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 384,
"description": "Whether the parent-form has been validated.\nThis value is needed to determine if the validate-status should be set.",
"itemtype": "property",
"name": "formValidated",
"type": "Boolean",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 394,
"description": "The text that should appear when the element is wrong validated.",
"itemtype": "property",
"name": "helpText",
"type": "String",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 403,
"description": "The `id` of the element.",
"itemtype": "property",
"name": "id",
"type": "String",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 412,
"description": "Whether to mark the Component when successfully validated.",
"itemtype": "property",
"name": "markValidated",
"type": "Boolean",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 421,
"description": "Whether the Component should show an validate-reclamation (star)",
"itemtype": "property",
"name": "markValidated",
"type": "Boolean",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 430,
"description": "The `name` for the element.",
"itemtype": "property",
"name": "name",
"type": "String",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 439,
"description": "The `onBlur` function, when happening on the DOM-Element.",
"itemtype": "property",
"name": "onBlur",
"type": "Function",
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 448,
"description": "The `onChange` function, which should update the `state`.",
"itemtype": "property",
"name": "onChange",
"type": "Function",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 457,
"description": "The `onClick` function, when happening on the DOM-Element.",
"itemtype": "property",
"name": "onClick",
"type": "Function",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 466,
"description": "The `onFocus` function, when happening on the DOM-Element.",
"itemtype": "property",
"name": "onFocus",
"type": "Function",
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 475,
"description": "The `onKeyDown` function, when happening on the DOM-Element.",
"itemtype": "property",
"name": "onKeyDown",
"type": "Function",
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 484,
"description": "The `onKeyEnter` function, when the enter-key is pressed.",
"itemtype": "property",
"name": "onKeyEnter",
"type": "Function",
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 493,
"description": "The `onKeyPress` function, when happening on the DOM-Element.",
"itemtype": "property",
"name": "onKeyPress",
"type": "Function",
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 502,
"description": "The `onKeyUp` function, when happening on the DOM-Element.",
"itemtype": "property",
"name": "onKeyUp",
"type": "Function",
"since": "0.1.0",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 511,
"description": "The `placeholder` for the element.",
"itemtype": "property",
"name": "placeholder",
"type": "String",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 520,
"description": "Inline style",
"itemtype": "property",
"name": "style",
"type": "object",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 529,
"description": "The `type` of the input-element.",
"itemtype": "property",
"name": "type",
"type": "String",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 538,
"description": "The tabindex of the Component.",
"itemtype": "property",
"name": "type",
"type": "Number",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 547,
"description": "Whether the property is validated right.",
"itemtype": "property",
"name": "validated",
"type": "Boolean",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
},
{
"file": "lib/component.jsx",
"line": 556,
"description": "The `value` of the input-element.",
"itemtype": "property",
"name": "value",
"type": "String",
"since": "0.0.1",
"class": "Input",
"module": "itsa-react-input"
}
],
"warnings": []
}