itsa-react-button
Version:
Interactive button, like a normal button, but with extended behaviour
459 lines • 15.7 kB
JSON
{
"project": {
"name": "itsa-react-button",
"description": "Interactive button, like a normal button, but with extended behaviour",
"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-button": 1
},
"classes": {
"Button": 1
},
"fors": {},
"namespaces": {}
}
},
"modules": {
"itsa-react-button": {
"name": "itsa-react-button",
"submodules": {},
"elements": {},
"classes": {
"Button": 1
},
"fors": {},
"namespaces": {},
"tag": "module",
"file": "lib/component.jsx",
"line": 3,
"description": "React-Component: refined Button.\n\n\n\n<i>Copyright (c) 2016 ItsAsbreuk - http://itsasbreuk.nl</i><br>\nNew BSD License - http://choosealicense.com/licenses/bsd-3-clause/",
"since": "0.0.1"
}
},
"classes": {
"Button": {
"name": "Button",
"shortname": "Button",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "itsa-react-button",
"namespace": "",
"file": "lib/component.jsx",
"line": 3,
"description": "React-Component: refined Button.\n\n\n\n<i>Copyright (c) 2016 ItsAsbreuk - http://itsasbreuk.nl</i><br>\nNew BSD License - http://choosealicense.com/licenses/bsd-3-clause/"
}
},
"elements": {},
"classitems": [
{
"file": "lib/component.jsx",
"line": 58,
"description": "Blurs the Component.",
"itemtype": "method",
"name": "blur",
"chainable": 1,
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 71,
"description": "componentDidMount does some initialization.",
"itemtype": "method",
"name": "componentDidMount",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 86,
"description": "componentWilUnmount does some cleanup.",
"itemtype": "method",
"name": "componentWillUnmount",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 104,
"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": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 122,
"description": "Callback-fn for the onClick-event.\nWill invoke `this.props.onChange`",
"itemtype": "method",
"name": "handleClick",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 160,
"description": "Callback-fn for the onKeyDown-event.",
"itemtype": "method",
"name": "handleKeyDown",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 213,
"description": "Callback-fn for the onKeyUp-event.",
"itemtype": "method",
"name": "handleKeyUp",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 234,
"description": "Callback-fn for the onMouseDown-event.",
"itemtype": "method",
"name": "handleMouseDown",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 289,
"description": "Callback-fn for the onMouseUp-event.",
"itemtype": "method",
"name": "handleMouseUp",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 308,
"description": "Callback-fn for the onClick-event.\nWill invoke `this.props.onChange`",
"itemtype": "method",
"name": "press",
"params": [
{
"name": "boolean",
"description": "[directResponse] whether directly call onClick, or wait until the button raises up."
}
],
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 320,
"description": "React render-method --> renderes the Component.",
"itemtype": "method",
"name": "render",
"return": {
"description": "ReactComponent"
},
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 406,
"description": "Extracts the `data-*` attributes from props.",
"itemtype": "method",
"name": "_getDataAttrs",
"access": "private",
"tagname": "",
"return": {
"description": "object all the data-* attributes"
},
"since": "0.0.3",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 425,
"description": "React render-method --> renderes the Component.",
"itemtype": "method",
"name": "_processKeyUp",
"params": [
{
"name": "Boolean",
"description": "manual whether this routine gets called manually (keypress), or from a click-event"
},
{
"name": "Boolean",
"description": "directResponse Whether to direct response or wait for the button to raise up"
},
{
"name": "Boolean",
"description": "force whether to force (initiated by the method `press`)"
}
],
"access": "private",
"tagname": "",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 461,
"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": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 476,
"description": "Array with the keys that can press the button when focussed.\nDefault: [13, 32]",
"itemtype": "property",
"name": "activatedBy",
"type": "Array",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 486,
"description": "The aria-label. When not set, it will equal the buttonText",
"itemtype": "property",
"name": "aria-label",
"type": "String",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 495,
"description": "Whether to autofocus the Component.",
"itemtype": "property",
"name": "autoFocus",
"type": "Boolean",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 504,
"description": "The Button-text. Will be escaped. If you need HTML, then use `buttonHTML` instead.",
"itemtype": "property",
"name": "buttonText",
"type": "String",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 513,
"description": "The Button-text, retaining html-code. If you don't need HTML,\nthen `buttonText` is preferred.",
"itemtype": "property",
"name": "buttonHTML",
"type": "String",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 523,
"description": "The time that the button retains in its `pressed-state` when activated by a key-press.\n\nDefault: 300ms",
"itemtype": "property",
"name": "buttonPressTime",
"type": "Number",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 534,
"description": "The class that should be set on the element",
"itemtype": "property",
"name": "className",
"type": "String",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 543,
"description": "Whether the button resonses rapidly (keydown and mousedown).\nNote: native HTMLButtonElements don't resonse rapidly --> the onClick event happens on mouseUp.\n\nDefault: true",
"itemtype": "property",
"name": "directResponse",
"type": "Boolean",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 555,
"description": "Whether the button is disabled",
"itemtype": "property",
"name": "disabled",
"type": "Boolean",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 564,
"description": "The name-attribute of the button",
"itemtype": "property",
"name": "name",
"type": "String",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 573,
"description": "Callback whenever the button gets clicked by the left mousebutton.",
"itemtype": "property",
"name": "onClick",
"type": "Function",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 582,
"description": "Callback wheneveer the button gets clicked by the middle mousebuttin.",
"itemtype": "property",
"name": "onMiddleClick",
"type": "Function",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 599,
"description": "Callback wheneveer the button gets clicked by the right mouse-button.",
"itemtype": "property",
"name": "onRightClick",
"type": "Function",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 608,
"description": "Whether the checkbox is readonly",
"itemtype": "property",
"name": "readOnly",
"type": "Boolean",
"default": "false",
"since": "15.2.0",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 618,
"description": "Whether keypress should show active status. (should be set `false` for file-uploadbuttons)\nDefault: true",
"itemtype": "property",
"name": "showActivated",
"type": "Boolean",
"since": "0.0.5",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 628,
"description": "Inline style",
"itemtype": "property",
"name": "style",
"type": "object",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 637,
"description": "The tabIndex",
"itemtype": "property",
"name": "tabIndex",
"type": "Number",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 646,
"description": "Whether the button is in a toggle-state.\nYou don;t need to use this directly: use the module ToggleButton instead.",
"itemtype": "property",
"name": "toggled",
"type": "Boolean",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
},
{
"file": "lib/component.jsx",
"line": 656,
"description": "The type of the button\nDefault: \"button\"",
"itemtype": "property",
"name": "children",
"type": "String",
"since": "0.0.1",
"class": "Button",
"module": "itsa-react-button"
}
],
"warnings": []
}