itsa-react-docviewer/api/data.json

React component that views documents using Google Doc Viewer

{
    "project": {
        "name": "itsa-react-docviewer",
        "description": "React-Component: xxxxx",
        "logo": "https://avatars0.githubusercontent.com/u/8314644?v=3&s=84",
        "version": "0.0.1"
    },
    "files": {
        "lib/component.jsx": {
            "name": "lib/component.jsx",
            "modules": {
                "component.jsx": 1
            },
            "classes": {
                "Component": 1
            },
            "fors": {},
            "namespaces": {}
        }
    },
    "modules": {
        "component.jsx": {
            "name": "component.jsx",
            "submodules": {},
            "elements": {},
            "classes": {
                "Component": 1
            },
            "fors": {},
            "namespaces": {},
            "tag": "module",
            "file": "lib/component.jsx",
            "line": 3,
            "description": "React component that views documents using Google Doc Viewer.\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": "15.0.0"
        }
    },
    "classes": {
        "Component": {
            "name": "Component",
            "shortname": "Component",
            "classitems": [],
            "plugins": [],
            "extensions": [],
            "plugin_for": [],
            "extension_for": [],
            "module": "component.jsx",
            "namespace": "",
            "file": "lib/component.jsx",
            "line": 3,
            "description": "React component that views documents using Google Doc Viewer.\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": 70,
            "description": "Will show the content into the full screen. Only if `props.allowFullScreen`===true.",
            "itemtype": "method",
            "name": "fullScreen",
            "since": "0.0.1",
            "class": "Component",
            "module": "component.jsx"
        },
        {
            "file": "lib/component.jsx",
            "line": 96,
            "description": "Hides the \"load-message\" as specified by this.props.loadingMsg",
            "itemtype": "method",
            "name": "handleSrcLoad",
            "since": "16.0.5",
            "class": "Component",
            "module": "component.jsx"
        },
        {
            "file": "lib/component.jsx",
            "line": 110,
            "description": "React render-method --> renderes the Component.",
            "itemtype": "method",
            "name": "render",
            "return": {
                "description": "ReactComponent"
            },
            "since": "15.0.0",
            "class": "Component",
            "module": "component.jsx"
        },
        {
            "file": "lib/component.jsx",
            "line": 168,
            "description": "Allowed to be displayed into full screen mode, by calling `fullScreen()`",
            "itemtype": "property",
            "name": "allowFullScreen",
            "type": "Boolean",
            "since": "15.0.0",
            "class": "Component",
            "module": "component.jsx"
        },
        {
            "file": "lib/component.jsx",
            "line": 177,
            "description": "Any class to be set on the main component.",
            "itemtype": "property",
            "name": "className",
            "type": "String",
            "since": "15.0.0",
            "class": "Component",
            "module": "component.jsx"
        },
        {
            "file": "lib/component.jsx",
            "line": 186,
            "description": "The message that shows while the document gets loaded",
            "itemtype": "property",
            "name": "loadingMsg",
            "default": "\"loading...\"",
            "type": "String",
            "since": "16.0.5",
            "class": "Component",
            "module": "component.jsx"
        },
        {
            "file": "lib/component.jsx",
            "line": 196,
            "description": "Whether the browser should provide a scroll bar when needed.\nEither `auto`, `yes` or `no`",
            "itemtype": "property",
            "name": "scrolling",
            "default": "\"auto\"",
            "type": "String|Boolean",
            "since": "15.0.0",
            "class": "Component",
            "module": "component.jsx"
        },
        {
            "file": "lib/component.jsx",
            "line": 207,
            "description": "Whether to show a message (this.props.loadingMsg) during document load",
            "itemtype": "property",
            "name": "showLoadingMsg",
            "default": "false",
            "type": "Boolean",
            "since": "16.0.5",
            "class": "Component",
            "module": "component.jsx"
        },
        {
            "file": "lib/component.jsx",
            "line": 217,
            "description": "The url of the document to be viewed. May be absolute or relative.",
            "itemtype": "property",
            "name": "src",
            "type": "String",
            "since": "15.0.0",
            "class": "Component",
            "module": "component.jsx"
        }
    ],
    "warnings": []
}