@x-edu/live-player 0.0.10 → 0.0.12

package/README.md

@@ -3,6 +3,7 @@
 初版，API可能后续会大幅调整
 
 ## Demo
+### PublicLiveDetail 直播详情页
 
 ```jsx
 import { PublicLiveDetail, getLiveOnlineCount } from '@x-edu/live-player'
@@ -96,11 +97,50 @@ export default function LiveTest() {
 }
 ```
 
+### 直播列表页
+```jsx
+import { PublicLiveList } from '@x-edu/live-player'
+import React, { useContext } from 'react'
+import style from './style.module.less'
+import { getLoginUrl, uc } from '@/util/auth/func'
+import UserContext from '@/component/Login/UserContext'
+
+export default function LiveTest() {
+  const loginInfo = useContext(UserContext)
+
+  // 部分直播需要登录后才可以播放，这是要求登录的回调
+  const handleLogin = (item) => {
+    // 处理必须登陆的情况
+    window.location.href = getLoginUrl()
+  }
+
+  const handleDetailClick = (item) => {
+    // 根据 item 决定怎么跳转详情页
+    // 默认跳转中小学直播详情 window.open(`https://basic.smartedu.cn/publicLive/${liveId}}`)
+  }
+ 
+  return (
+    <div>
+      <PublicLiveList
+        scopeType='e_teacher_studio' // 适用范围，如名师工作室：e_teacher_studio 机构工作室：e_inst_studio 专家工作室：e_expert_studio 精准匹配
+        scopeId='xxx' // 适用id，如专家工作室id 精准匹配，必须有scope_type才生效
+        containerClassName={style.container} // 容器样式
+        uc={uc} // 登陆状态下必填
+        loginInfo={loginInfo} // 登陆状态下必填，特别的里面的 userInfo
+        handleLogin={handleLogin} // 用于需要强制登陆的回调，会传传入当前直播作为参数
+        onDetailClick={handleDetailClick}
+      />
+    </div>
+  )
+}
+```
+
 ## 预生产
 
 ```js
 import { 
   PublicLiveDetail,
-  getLiveOnlineCount 
+  getLiveOnlineCount，
+  PublicLiveList
 } from '@x-edu/live-player/dist/XEduLivePlayerPre.common'
 ```