tin-react-components/docs.json

All components used for Omadi apps

[
    {},
    {
        "description": "Component to allow for basic click actions\n",
        "methods": [
            {
                "name": "handleClick",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "e",
                        "type": null
                    }
                ],
                "returns": null
            }
        ],
        "props": {
            "onClick": {
                "type": {
                    "name": "func"
                },
                "required": true,
                "description": "Function whose only argument the event\nas an object with the following argument structure:\n",
                "structure": "{\n     target: 'BUTTON ELEMENT\n}"
            },
            "text": {
                "type": {
                    "name": "string"
                },
                "required": false,
                "description": "Label text."
            },
            "type": {
                "type": {
                    "name": "string"
                },
                "required": false,
                "description": "Type of button\n\n",
                "defaultValue": "primary",
                "options": [
                    "primary",
                    "secondary",
                    "disabled",
                    "warning",
                    "danger"
                ]
            },
            "log": {
                "type": {
                    "name": "func"
                },
                "required": false,
                "description": "Function that allows for advanced logging.\n\n]",
                "arguments": "{\n         type: 'string',\n         name: 'type',\n         description: 'Type of log',\n         options: ['error', 'warning', 'info', 'debug']\n     }"
            },
            "allowLogging": {
                "type": {
                    "name": "bool"
                },
                "required": false,
                "description": "Flag to indicate whether to log events or not"
            }
        },
        "author": "Jason Baddley",
        "name": "Button",
        "example": "\n        <Button\n            onClick={onClick}\n            text={text}\n            type={type}\n            log={log}\n            allowLogging={allowLogging}\n        >\n          {children}\n        </Button>\n    "
    },
    {
        "description": "Component to allow for basic click actions\n",
        "methods": [
            {
                "name": "handleBlur",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "e",
                        "type": null
                    }
                ],
                "returns": null
            },
            {
                "name": "handleChange",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "e",
                        "type": null
                    }
                ],
                "returns": null
            }
        ],
        "props": {
            "onChange": {
                "type": {
                    "name": "func"
                },
                "required": true,
                "description": "Function whose only argument the event\nas an object with the following argument structure:\n",
                "structure": "{\n     target: 'ELEMENT\n}"
            },
            "label": {
                "type": {
                    "name": "string"
                },
                "required": false,
                "description": "Label text."
            },
            "log": {
                "type": {
                    "name": "func"
                },
                "required": false,
                "description": "Function that allows for advanced logging.\n\n]",
                "arguments": "{\n         type: 'string',\n         name: 'type',\n         description: 'Type of log',\n         options: ['error', 'warning', 'info', 'debug']\n     }"
            },
            "allowLogging": {
                "type": {
                    "name": "bool"
                },
                "required": false,
                "description": "Flag to indicate whether to log events or not"
            }
        },
        "author": "GENERATED",
        "name": "Input",
        "example": "\n        <Input\n            onChange={onChange}\n            label={label}\n            log={log}\n            allowLogging={allowLogging}\n        >\n          {children}\n        </Input>\n    "
    },
    {
        "description": "Component to allow for identification and password authentication\n",
        "methods": [
            {
                "name": "handleSubmit",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "e",
                        "type": null
                    }
                ],
                "returns": null
            },
            {
                "name": "renderErrors",
                "docblock": null,
                "modifiers": [],
                "params": [],
                "returns": null
            }
        ],
        "props": {
            "onSubmit": {
                "type": {
                    "name": "func"
                },
                "required": true,
                "description": "Function whose only argument is the user's identifier and password\nas an object with the following argument structure:\n",
                "structure": "{\n     identifier: 'IDENTIFIER',\n     password: 'PASSWORD'\n}"
            },
            "errors": {
                "type": {
                    "name": "array"
                },
                "required": false,
                "description": "Array of errors. Each error is an object with the following structure:\n",
                "structure": "{\n     message: 'Message of the error',\n     placement: 'placement name where error will be seen'\n}"
            },
            "type": {
                "type": {
                    "name": "string"
                },
                "required": false,
                "description": "Either 'block' or 'inline'\n\n",
                "defaultValue": "block",
                "options": [
                    "block",
                    "inline"
                ]
            },
            "identifierLabel": {
                "type": {
                    "name": "string"
                },
                "required": false,
                "description": "Label text for the identifier field.\n",
                "defaultValue": "Email"
            },
            "passwordLabel": {
                "type": {
                    "name": "string"
                },
                "required": false,
                "description": "Label text for the password field.\n",
                "defaultValue": "Password"
            },
            "buttonText": {
                "type": {
                    "name": "string"
                },
                "required": false,
                "description": "Text for the submit button.\n",
                "defaultValue": "Login"
            },
            "log": {
                "type": {
                    "name": "func"
                },
                "required": false,
                "description": "Function that allows for advanced logging.\n\n]",
                "arguments": "{\n         type: 'string',\n         name: 'type',\n         description: 'Type of log',\n         options: ['error', 'warning', 'info', 'debug']\n     }"
            },
            "allowLogging": {
                "type": {
                    "name": "bool"
                },
                "required": false,
                "description": "Flag to indicate whether to log events or not"
            }
        },
        "author": "Jason Baddley",
        "name": "LoginForm",
        "example": "\n        <LoginForm\n            onSubmit={onSubmit}\n            errors={errors}\n            type={type}\n            identifierLabel={identifierLabel}\n            passwordLabel={passwordLabel}\n            buttonText={buttonText}\n            log={log}\n            allowLogging={allowLogging}\n        />\n    "
    },
    {
        "description": "Handles basic navigation",
        "methods": [
            {
                "name": "renderLinks",
                "docblock": null,
                "modifiers": [],
                "params": [],
                "returns": null
            }
        ],
        "props": {
            "links": {
                "type": {
                    "name": "array"
                },
                "required": true,
                "description": "An array of objects for navicagion with the following structure:\n",
                "structure": "{\n \"displayName\": \"Schedule\",\n \"description\": \"Manual Dispatch\",\n \"path\": \"/schedule/manage\",\n \"icon\": \"icon-calendar\"\n}"
            },
            "className": {
                "type": {
                    "name": "string"
                },
                "required": false,
                "description": "Parent class\n",
                "defaultValue": "navigation"
            },
            "log": {
                "type": {
                    "name": "func"
                },
                "required": false,
                "description": "Function that allows for advanced logging.\n\n]",
                "arguments": "{\n         type: 'string',\n         name: 'type',\n         description: 'Type of log',\n         options: ['error', 'warning', 'info', 'debug']\n     }"
            },
            "allowLogging": {
                "type": {
                    "name": "bool"
                },
                "required": false,
                "description": "Flag to indicate whether to log events or not"
            }
        },
        "name": "Nav",
        "example": "\n        <Nav\n            links={links}\n            className={className}\n            log={log}\n            allowLogging={allowLogging}\n        />\n    "
    },
    {
        "description": "Component to allow for basic click actions\n",
        "methods": [
            {
                "name": "handleClick",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "e",
                        "type": null
                    }
                ],
                "returns": null
            },
            {
                "name": "checkName",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "name",
                        "type": null
                    },
                    {
                        "name": "search",
                        "type": null
                    }
                ],
                "returns": null
            },
            {
                "name": "markSelected",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "children",
                        "type": null
                    },
                    {
                        "name": "selected",
                        "type": null
                    },
                    {
                        "name": "col",
                        "type": null
                    }
                ],
                "returns": null
            },
            {
                "name": "expandSearch",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "children",
                        "type": null
                    },
                    {
                        "name": "search",
                        "type": null
                    },
                    {
                        "name": "col",
                        "type": null
                    }
                ],
                "returns": null
            },
            {
                "name": "filterData",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "search",
                        "type": null
                    },
                    {
                        "name": "data",
                        "type": null
                    },
                    {
                        "name": "nodes",
                        "type": null
                    }
                ],
                "returns": null
            },
            {
                "name": "mapData",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "data",
                        "type": null
                    }
                ],
                "returns": null
            },
            {
                "name": "handleSearch",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "e",
                        "type": null
                    }
                ],
                "returns": null
            },
            {
                "name": "renderNodeText",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "text",
                        "type": null
                    }
                ],
                "returns": null
            },
            {
                "name": "renderChildren",
                "docblock": null,
                "modifiers": [],
                "params": [
                    {
                        "name": "children",
                        "type": null
                    },
                    {
                        "name": "level",
                        "type": null
                    }
                ],
                "returns": null
            }
        ],
        "props": {
            "search": {
                "type": {
                    "name": "string"
                },
                "required": false,
                "description": "Text to filter the data by"
            },
            "onClick": {
                "type": {
                    "name": "func"
                },
                "required": false,
                "description": "Function whose only argument the event\nas an object with the following argument structure:\n",
                "structure": "{\n     target: 'ELEMENT\n}"
            },
            "onMouseOver": {
                "type": {
                    "name": "func"
                },
                "required": false,
                "description": "Function whose only argument the event\nas an object with the following argument structure:\n",
                "structure": "{\n     target: 'ELEMENT\n}"
            },
            "onMouseOut": {
                "type": {
                    "name": "func"
                },
                "required": false,
                "description": "Function whose only argument the event\nas an object with the following argument structure:\n",
                "structure": "{\n     target: 'ELEMENT\n}"
            },
            "onOpenNode": {
                "type": {
                    "name": "func"
                },
                "required": false,
                "description": "Function whose only argument the event\nas an object with the following argument structure:\n",
                "structure": "{\n     target: 'ELEMENT\n}"
            },
            "onToggleAll": {
                "type": {
                    "name": "func"
                },
                "required": false,
                "description": "Function whose only argument the event\nas an object with the following argument structure:\n",
                "structure": "{\n     target: 'ELEMENT\n}"
            },
            "nodes": {
                "type": {
                    "name": "object"
                },
                "required": false,
                "description": "Object of open nodes by id\n",
                "structure": "{\n [id]: true\n}"
            },
            "data": {
                "type": {
                    "name": "array"
                },
                "required": false,
                "description": "Data array that represents the tree"
            },
            "log": {
                "type": {
                    "name": "func"
                },
                "required": false,
                "description": "Function that allows for advanced logging.\n\n]",
                "arguments": "{\n         type: 'string',\n         name: 'type',\n         description: 'Type of log',\n         options: ['error', 'warning', 'info', 'debug']\n     }"
            },
            "allowLogging": {
                "type": {
                    "name": "bool"
                },
                "required": false,
                "description": "Flag to indicate whether to log events or not"
            }
        },
        "author": "Jason Baddley",
        "name": "Tree",
        "example": "\n        <Tree\n            search={search}\n            onClick={onClick}\n            onMouseOver={onMouseOver}\n            onMouseOut={onMouseOut}\n            onOpenNode={onOpenNode}\n            onToggleAll={onToggleAll}\n            nodes={nodes}\n            data={data}\n            log={log}\n            allowLogging={allowLogging}\n        />\n    "
    }
]