Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@syanbo
syanbo committed Mar 29, 2019
1 parent af34d35 commit f8708db
Show file tree
Hide file tree
Showing 4 changed files with 135 additions and 750 deletions.
48 changes: 24 additions & 24 deletions docs/api/classes/agoraview.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Inherited from Component.__constructor</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:404</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:400</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -179,7 +179,7 @@ <h4 class="tsd-returns-title">Returns <a href="agoraview.html" class="tsd-signat
<aside class="tsd-sources">
<p>Inherited from Component.__constructor</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:406</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:402</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -214,7 +214,7 @@ <h3>context</h3>
<aside class="tsd-sources">
<p>Inherited from Component.context</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:404</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:400</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -237,11 +237,11 @@ <h3>context</h3>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="props" class="tsd-anchor"></a>
<h3>props</h3>
<div class="tsd-signature tsd-kind-icon">props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PropsWithChildren</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-signature tsd-kind-icon">props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AgoraViewProps</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<p>Inherited from Component.props</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:429</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:425</li>
</ul>
</aside>
</section>
Expand All @@ -252,7 +252,7 @@ <h3>refs</h3>
<aside class="tsd-sources">
<p>Inherited from Component.refs</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:435</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:431</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -278,7 +278,7 @@ <h3>state</h3>
<aside class="tsd-sources">
<p>Inherited from Component.state</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:430</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:426</li>
</ul>
</aside>
</section>
Expand All @@ -289,7 +289,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
<aside class="tsd-sources">
<p>Inherited from Component.contextType</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:389</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:385</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -328,7 +328,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component
<aside class="tsd-sources">
<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:617</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:613</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -366,7 +366,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component
<aside class="tsd-sources">
<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:649</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:645</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -415,7 +415,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> UNSAFE_<wbr>component
<aside class="tsd-sources">
<p>Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:677</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:673</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -465,7 +465,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr
<aside class="tsd-sources">
<p>Inherited from ComponentLifecycle.componentDidCatch</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:546</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:542</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -498,7 +498,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr
<aside class="tsd-sources">
<p>Inherited from ComponentLifecycle.componentDidMount</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:525</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:521</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -521,7 +521,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Did<wbr
<aside class="tsd-sources">
<p>Inherited from NewLifecycle.componentDidUpdate</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:588</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:584</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -557,7 +557,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wb
<aside class="tsd-sources">
<p>Inherited from DeprecatedLifecycle.componentWillMount</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:603</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:599</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -594,7 +594,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wb
<aside class="tsd-sources">
<p>Inherited from DeprecatedLifecycle.componentWillReceiveProps</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:632</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:628</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -642,7 +642,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wb
<aside class="tsd-sources">
<p>Inherited from ComponentLifecycle.componentWillUnmount</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:541</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:537</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -666,7 +666,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> component<wbr>Will<wb
<aside class="tsd-sources">
<p>Inherited from DeprecatedLifecycle.componentWillUpdate</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:662</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:658</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -715,7 +715,7 @@ <h3>force<wbr>Update</h3>
<aside class="tsd-sources">
<p>Inherited from Component.forceUpdate</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:421</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:417</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -738,7 +738,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> getHTMLProps</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/AgoraView.native.tsx#L42">AgoraView.native.tsx:42</a></li>
<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/1448fc0/src/AgoraView.native.tsx#L42">AgoraView.native.tsx:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -762,7 +762,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr>Snapshot<wbr>
<aside class="tsd-sources">
<p>Inherited from NewLifecycle.getSnapshotBeforeUpdate</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:582</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:578</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -801,7 +801,7 @@ <h3>render</h3>
<aside class="tsd-sources">
<p>Overrides Component.render</p>
<ul>
<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/88179d2/src/AgoraView.native.tsx#L31">AgoraView.native.tsx:31</a></li>
<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/1448fc0/src/AgoraView.native.tsx#L31">AgoraView.native.tsx:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -825,7 +825,7 @@ <h3>set<wbr>State</h3>
<aside class="tsd-sources">
<p>Inherited from Component.setState</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:416</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:412</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -858,7 +858,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> should<wbr>Component<
<aside class="tsd-sources">
<p>Inherited from ComponentLifecycle.shouldComponentUpdate</p>
<ul>
<li>Defined in /Users/ly/Project/react-agora/node_modules/@types/react/index.d.ts:536</li>
<li>Defined in /Users/dengbo/Documents/GitHub/react-native-agora/node_modules/@types/react/index.d.ts:532</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit f8708db

Please sign in to comment.