{
"project": {
"name": "itsa-react-select",
"description": "React-Component: Select",
"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-select": 1
},
"classes": {
"Select": 1
},
"fors": {},
"namespaces": {}
}
},
"modules": {
"itsa-react-select": {
"name": "itsa-react-select",
"submodules": {},
"elements": {},
"classes": {
"Select": 1
},
"fors": {},
"namespaces": {},
"tag": "module",
"file": "lib/component.jsx",
"line": 3,
"description": "Nice select for react.\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": {
"Select": {
"name": "Select",
"shortname": "Select",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "itsa-react-select",
"namespace": "",
"file": "lib/component.jsx",
"line": 3,
"description": "Nice select for react.\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": 63,
"description": "componentDidMount does some initialization.",
"itemtype": "method",
"name": "componentDidMount",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 84,
"description": "componentWilUnmount does some cleanup.",
"itemtype": "method",
"name": "componentWillUnmount",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 102,
"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": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 114,
"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": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 125,
"description": "Callback-fn for the onClick-event.\nWill invoke `this.props.onChange`",
"itemtype": "method",
"name": "handleClick",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 155,
"description": "Callback-fn when an item is clicked",
"itemtype": "method",
"name": "handleItemClick",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 201,
"description": "Callback-fn when an item is scrolled by keys",
"itemtype": "method",
"name": "handleItemScroll",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 216,
"description": "Callback-fn for the onKeyDown-event.",
"itemtype": "method",
"name": "handleKeyDown",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 244,
"description": "Callback-fn for the onKeyUp-event.",
"itemtype": "method",
"name": "handleKeyUp",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 254,
"description": "Callback-fn for the onMouseDown-event.",
"itemtype": "method",
"name": "handleMouseDown",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 267,
"description": "Callback-fn for the onMouseUp-event.",
"itemtype": "method",
"name": "handleMouseUp",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 282,
"description": "React render-method --> renderes the Component.",
"itemtype": "method",
"name": "render",
"return": {
"description": "ReactComponent"
},
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 413,
"description": "Returns a html that represent the item as how it should be rendered.",
"itemtype": "method",
"name": "_defaultItemRenderer",
"access": "private",
"tagname": "",
"params": [
{
"name": "String|Object",
"description": "list-item"
}
],
"return": {
"description": "String html that represent the item"
},
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 426,
"description": "Returns the ul-element that contains all li-elements.",
"itemtype": "method",
"name": "_getUlContainerNode",
"access": "private",
"tagname": "",
"return": {
"description": "Element"
},
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 440,
"description": "Callback for a click on the document. Is needed to close the Component when clicked outside.",
"itemtype": "method",
"name": "_handleDocumentClick",
"access": "private",
"tagname": "",
"params": [
{
"name": "Object",
"description": "e"
}
],
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 458,
"description": "Returns a save string",
"itemtype": "method",
"name": "_saveHTML",
"access": "private",
"tagname": "",
"params": [
{
"name": "String",
"description": "html the text that should be removed from any html-entities"
}
],
"return": {
"description": "String"
},
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 473,
"description": "Whether to autofocus the Component.",
"itemtype": "property",
"name": "autoFocus",
"type": "Boolean",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 482,
"description": "ClassName that should be set to the select-button",
"itemtype": "property",
"name": "btnClassName",
"type": "String",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 491,
"description": "A render-function for the buttonText. When not supplied (default),\nThe selected item will be rendered as the buttonText.",
"itemtype": "property",
"name": "btnRenderer",
"type": "Function",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 501,
"description": "ClassName that should be set to the Element",
"itemtype": "property",
"name": "className",
"type": "String",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 510,
"description": "Whether the dropdown-list should be collapsed when an item is clicked.",
"itemtype": "property",
"name": "closeOnClick",
"type": "Boolean",
"default": "true",
"since": "15.3.32",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 520,
"description": "Whether the component is disabled",
"itemtype": "property",
"name": "disabled",
"type": "Boolean",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 529,
"description": "The HTML that the select should show when no item is selected.\nDefaults \"Choose...\"",
"itemtype": "property",
"name": "emptyHTML",
"type": "String",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 539,
"description": "The errormessage to show when the Select is not validated.",
"itemtype": "property",
"name": "errorMsg",
"type": "String",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 548,
"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": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 558,
"description": "List with all the items, either as Strings or Objects.",
"itemtype": "property",
"name": "items",
"type": "Array",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 567,
"description": "The height of the select-list. If not set, then all items are shown without a scroller.",
"itemtype": "property",
"name": "listHeight",
"type": "Number",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 576,
"description": "Whether the loop the items when the last/first item is reached.",
"itemtype": "property",
"name": "loop",
"default": "false",
"type": "Boolean",
"since": "15.0.0",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 586,
"description": "Whether the Component should show an validate-reclamation (star)\nwhen it requires a selected item yet when there is no item selected.",
"itemtype": "property",
"name": "markValidated",
"type": "Boolean",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 596,
"description": "Whether the dropdown-list accepts multiple selected items.",
"itemtype": "property",
"name": "multiSelect",
"type": "Boolean",
"default": "false",
"since": "15.3.32",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 606,
"description": "The `onChange` function, which should update the `state`.",
"itemtype": "property",
"name": "onChange",
"type": "Function",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 615,
"description": "Whether the checkbox is readonly",
"itemtype": "property",
"name": "readOnly",
"type": "Boolean",
"default": "false",
"since": "15.2.0",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 625,
"description": "Whether to Component requires a valid selection",
"itemtype": "property",
"name": "required",
"type": "Boolean",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 634,
"description": "The index that is selected",
"itemtype": "property",
"name": "readOnly",
"type": "number",
"default": "null",
"since": "15.2.0",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 644,
"description": "Inline style",
"itemtype": "property",
"name": "style",
"type": "object",
"since": "0.0.1",
"class": "Select",
"module": "itsa-react-select"
},
{
"file": "lib/component.jsx",
"line": 653,
"description": "The tabindex of the Component.",
"itemtype": "property",
"name": "type",
"type": "Number",
"since": "0.1.2",
"class": "Select",
"module": "itsa-react-select"
}
],
"warnings": []
}