itsa-react-docviewer
Version:
React component that views documents using Google Doc Viewer
462 lines (291 loc) • 13.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Component - itsa-react-docviewer</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="https://avatars0.githubusercontent.com/u/8314644?v=3&s=84" title="itsa-react-docviewer"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.0.1</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Component.html">Component</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/component.jsx.html">component.jsx</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Component Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/lib_component.jsx.html#l3"><code>lib/component.jsx:3</code></a>
</div>
Module: <a href="../modules/component.jsx.html">component.jsx</a>
</div>
<div class="box intro">
<p>React component that views documents using Google Doc Viewer.</p>
<p><i>Copyright (c) 2016 ItsAsbreuk - <a href="http://itsasbreuk.nl">http://itsasbreuk.nl</a></i><br>
New BSD License - <a href="http://choosealicense.com/licenses/bsd-3-clause/">http://choosealicense.com/licenses/bsd-3-clause/</a></p>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_fullScreen">fullScreen</a>
</li>
<li class="index-item method">
<a href="#method_handleSrcLoad">handleSrcLoad</a>
</li>
<li class="index-item method">
<a href="#method_render">render</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property">
<a href="#property_allowFullScreen">allowFullScreen</a>
</li>
<li class="index-item property">
<a href="#property_className">className</a>
</li>
<li class="index-item property">
<a href="#property_loadingMsg">loadingMsg</a>
</li>
<li class="index-item property">
<a href="#property_scrolling">scrolling</a>
</li>
<li class="index-item property">
<a href="#property_showLoadingMsg">showLoadingMsg</a>
</li>
<li class="index-item property">
<a href="#property_src">src</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_fullScreen" class="method item">
<h3 class="name"><code>fullScreen</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_component.jsx.html#l70"><code>lib/component.jsx:70</code></a>
</p>
<p>Available since 0.0.1</p>
</div>
<div class="description">
<p>Will show the content into the full screen. Only if <code>props.allowFullScreen</code>===true.</p>
</div>
</div>
<div id="method_handleSrcLoad" class="method item">
<h3 class="name"><code>handleSrcLoad</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_component.jsx.html#l96"><code>lib/component.jsx:96</code></a>
</p>
<p>Available since 16.0.5</p>
</div>
<div class="description">
<p>Hides the "load-message" as specified by this.props.loadingMsg</p>
</div>
</div>
<div id="method_render" class="method item">
<h3 class="name"><code>render</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_component.jsx.html#l110"><code>lib/component.jsx:110</code></a>
</p>
<p>Available since 15.0.0</p>
</div>
<div class="description">
<p>React render-method --> renderes the Component.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>ReactComponent</p>
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_allowFullScreen" class="property item">
<h3 class="name"><code>allowFullScreen</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_component.jsx.html#l168"><code>lib/component.jsx:168</code></a>
</p>
<p>Available since 15.0.0</p>
</div>
<div class="description">
<p>Allowed to be displayed into full screen mode, by calling <code>fullScreen()</code></p>
</div>
</div>
<div id="property_className" class="property item">
<h3 class="name"><code>className</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_component.jsx.html#l177"><code>lib/component.jsx:177</code></a>
</p>
<p>Available since 15.0.0</p>
</div>
<div class="description">
<p>Any class to be set on the main component.</p>
</div>
</div>
<div id="property_loadingMsg" class="property item">
<h3 class="name"><code>loadingMsg</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_component.jsx.html#l186"><code>lib/component.jsx:186</code></a>
</p>
<p>Available since 16.0.5</p>
</div>
<div class="description">
<p>The message that shows while the document gets loaded</p>
</div>
<p><strong>Default:</strong> "loading..."</p>
</div>
<div id="property_scrolling" class="property item">
<h3 class="name"><code>scrolling</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_component.jsx.html#l196"><code>lib/component.jsx:196</code></a>
</p>
<p>Available since 15.0.0</p>
</div>
<div class="description">
<p>Whether the browser should provide a scroll bar when needed.
Either <code>auto</code>, <code>yes</code> or <code>no</code></p>
</div>
<p><strong>Default:</strong> "auto"</p>
</div>
<div id="property_showLoadingMsg" class="property item">
<h3 class="name"><code>showLoadingMsg</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_component.jsx.html#l207"><code>lib/component.jsx:207</code></a>
</p>
<p>Available since 16.0.5</p>
</div>
<div class="description">
<p>Whether to show a message (this.props.loadingMsg) during document load</p>
</div>
<p><strong>Default:</strong> false</p>
</div>
<div id="property_src" class="property item">
<h3 class="name"><code>src</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/lib_component.jsx.html#l217"><code>lib/component.jsx:217</code></a>
</p>
<p>Available since 15.0.0</p>
</div>
<div class="description">
<p>The url of the document to be viewed. May be absolute or relative.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>