Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
EkaanshArora committed Jan 19, 2022
1 parent 9238df4 commit 75e8781
Show file tree
Hide file tree
Showing 36 changed files with 22,482 additions and 215 deletions.
20 changes: 10 additions & 10 deletions docs/enums/_internal_.InjectStreamEventStatus-1.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/enums/_internal_.ToggleState.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ToggleState | agora-react-uikit</title><meta name="description" content="Documentation for agora-react-uikit"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">agora-react-uikit</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">agora-react-uikit</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.ToggleState.html">ToggleState</a></li></ul><h1>Enumeration ToggleState</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#disabled" class="tsd-kind-icon">disabled</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#disabling" class="tsd-kind-icon">disabling</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#enabling" class="tsd-kind-icon">enabling</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="disabled" class="tsd-anchor"></a><h3>disabled</h3><div class="tsd-signature tsd-kind-icon">disabled<span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AgoraIO-Community/Web-React-UIKit/blob/3961d6c/src/PropsContext.tsx#L361">src/PropsContext.tsx:361</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="disabling" class="tsd-anchor"></a><h3>disabling</h3><div class="tsd-signature tsd-kind-icon">disabling<span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AgoraIO-Community/Web-React-UIKit/blob/3961d6c/src/PropsContext.tsx#L363">src/PropsContext.tsx:363</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="enabled" class="tsd-anchor"></a><h3>enabled</h3><div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AgoraIO-Community/Web-React-UIKit/blob/3961d6c/src/PropsContext.tsx#L362">src/PropsContext.tsx:362</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="enabling" class="tsd-anchor"></a><h3>enabling</h3><div class="tsd-signature tsd-kind-icon">enabling<span class="tsd-signature-symbol"> = 3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AgoraIO-Community/Web-React-UIKit/blob/3961d6c/src/PropsContext.tsx#L364">src/PropsContext.tsx:364</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum tsd-parent-kind-namespace"><a href="_internal_.ToggleState.html" class="tsd-kind-icon">Toggle<wbr/>State</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#disabled" class="tsd-kind-icon">disabled</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#disabling" class="tsd-kind-icon">disabling</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#enabling" class="tsd-kind-icon">enabling</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ToggleState | agora-react-uikit</title><meta name="description" content="Documentation for agora-react-uikit"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">agora-react-uikit</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">agora-react-uikit</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.ToggleState.html">ToggleState</a></li></ul><h1>Enumeration ToggleState</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#disabled" class="tsd-kind-icon">disabled</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#disabling" class="tsd-kind-icon">disabling</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#enabling" class="tsd-kind-icon">enabling</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="disabled" class="tsd-anchor"></a><h3>disabled</h3><div class="tsd-signature tsd-kind-icon">disabled<span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AgoraIO-Community/Web-React-UIKit/blob/9238df4/src/PropsContext.tsx#L317">src/PropsContext.tsx:317</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="disabling" class="tsd-anchor"></a><h3>disabling</h3><div class="tsd-signature tsd-kind-icon">disabling<span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AgoraIO-Community/Web-React-UIKit/blob/9238df4/src/PropsContext.tsx#L319">src/PropsContext.tsx:319</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="enabled" class="tsd-anchor"></a><h3>enabled</h3><div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AgoraIO-Community/Web-React-UIKit/blob/9238df4/src/PropsContext.tsx#L318">src/PropsContext.tsx:318</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="enabling" class="tsd-anchor"></a><h3>enabling</h3><div class="tsd-signature tsd-kind-icon">enabling<span class="tsd-signature-symbol"> = 3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AgoraIO-Community/Web-React-UIKit/blob/9238df4/src/PropsContext.tsx#L320">src/PropsContext.tsx:320</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum tsd-parent-kind-namespace"><a href="_internal_.ToggleState.html" class="tsd-kind-icon">Toggle<wbr/>State</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#disabled" class="tsd-kind-icon">disabled</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#disabling" class="tsd-kind-icon">disabling</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="_internal_.ToggleState.html#enabling" class="tsd-kind-icon">enabling</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Loading

0 comments on commit 75e8781

Please sign in to comment.