Skip to content
This repository was archived by the owner on Nov 5, 2024. It is now read-only.

Commit 2d1cd9f

Browse files
authored
release: UIKit v5.0.0 with Agora SDK v4.1.0
2 parents 5ae3cbd + 9be8245 commit 2d1cd9f

553 files changed

Lines changed: 14141 additions & 13120 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.eslintrc.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,15 @@ module.exports = {
33
extends: '@react-native-community',
44
parser: '@typescript-eslint/parser',
55
plugins: ['@typescript-eslint'],
6+
overrides: [
7+
{
8+
files: ['*.ts', '*.tsx'],
9+
rules: {
10+
'@typescript-eslint/no-shadow': ['error'],
11+
'react-native/no-inline-styles': 'off',
12+
'no-shadow': 'off',
13+
'no-undef': 'off',
14+
},
15+
},
16+
],
617
};

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,6 @@ buck-out/
6161

6262
# CocoaPods
6363
/ios/Pods/
64+
65+
example
66+
notes.md

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,8 @@ Instantly integrate Agora video calling or streaming into your React Native appl
1818
To a react-native application generated using react-native-cli, add the following:
1919

2020
```
21-
npm i react-native-agora@3 agora-react-native-rtm agora-rn-uikit
21+
npm i react-native-agora agora-react-native-rtm agora-rn-uikit
2222
```
23-
24-
We're working on supporting [react-native-agora](https://www.npmjs.com/package/react-native-agora) `v4.x` in the coming weeks.
25-
2623
### Usage
2724

2825
This VideoUIKit is very simple to use and contains a high level component called `AgoraUIKit`. You can check out code explanation here.

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/Agora_UIKit._internal_.Component.html

Lines changed: 16 additions & 16 deletions
Large diffs are not rendered by default.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RtcConnection | agora-rn-uikit</title><meta name="description" content="Documentation for agora-rn-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-rn-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-rn-uikit</a></li><li><a href="../modules/Agora_UIKit.html">Agora UIKit</a></li><li><a href="../modules/Agora_UIKit._internal_.html">&lt;internal&gt;</a></li><li><a href="Agora_UIKit._internal_.RtcConnection.html">RtcConnection</a></li></ul><h1>Class RtcConnection </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2+
<p>Contains connection information.</p>
3+
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">RtcConnection</span></li></ul></section><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 tsd-is-external"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="Agora_UIKit._internal_.RtcConnection.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="Agora_UIKit._internal_.RtcConnection.html#channelId" class="tsd-kind-icon">channel<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="Agora_UIKit._internal_.RtcConnection.html#localUid" class="tsd-kind-icon">local<wbr/>Uid</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">new <wbr/>Rtc<wbr/>Connection<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Agora_UIKit._internal_.RtcConnection.html" class="tsd-signature-type" data-tsd-kind="Class">RtcConnection</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="Agora_UIKit._internal_.RtcConnection.html" class="tsd-signature-type" data-tsd-kind="Class">RtcConnection</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="channelId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> channel<wbr/>Id<a href="#channelId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">channel<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/react-native-agora/lib/typescript/IAgoraRtcEngineEx.d.ts:12</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4+
<p>The channel name.</p>
5+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="localUid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> local<wbr/>Uid<a href="#localUid" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">local<wbr/>Uid<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/react-native-agora/lib/typescript/IAgoraRtcEngineEx.d.ts:16</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6+
<p>The ID of the local user.</p>
7+
</div></div></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">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/Agora_UIKit.html">Agora UIKit</a><ul><li class="current tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/Agora_UIKit._internal_.html">&lt;internal&gt;</a></li></ul></li><li class=" tsd-kind-module"><a href="../modules/Built_in_Components.html">Built-<wbr/>in <wbr/>Components</a></li><li class=" tsd-kind-module"><a href="../modules/React_Contexts.html">React <wbr/>Contexts</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="Agora_UIKit._internal_.RtcConnection.html" class="tsd-kind-icon">Rtc<wbr/>Connection</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="Agora_UIKit._internal_.RtcConnection.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="Agora_UIKit._internal_.RtcConnection.html#channelId" class="tsd-kind-icon">channel<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="Agora_UIKit._internal_.RtcConnection.html#localUid" class="tsd-kind-icon">local<wbr/>Uid</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-namespace"><span class="tsd-kind-icon">Namespace</span></li><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</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>

0 commit comments

Comments
 (0)