usePanelConfig - 获取面板小程序运行时对应的产品配置信息，如面板小程序主题配置数据、定时功能配置、跳转链接配置、自定义配置等等

usePanelConfig()

版本要求:

@ray-js/panel-sdk≥1.12.0

描述

获取面板小程序运行时对应的产品配置信息，如定时功能配置、跳转链接配置、自定义配置等等。

参数

无

返回值

类型：Config

Config 对象，包含 iot（IoT 公版配置）、fun（功能配置）、bic（云定时/跳转链接）、themeInfo（主题 CSS 变量）和 initialized（是否加载完毕）

Config

属性	类型	说明
`initialized`	boolean	是否初始化完毕
		IoT 的产品配置信息，仅公版面板支持
		IoT 的功能配置信息
		IoT 平台配置的云定时和跳转链接
		小程序主题配置数据

合法值

`ThemeValue.rangeType`

值	说明	最低版本
`bool`	-	-
`enum`	-	-
`blank`	-	-

`IoTPublicConfig.theme`

值	说明	最低版本
`default`	-	-
`light`	-	-

`FunConfig.tyabirysr4_app`

值	说明	最低版本
`follow`	-	-
`--app-B1`	-	-

`FunConfig.tyabis5d9w_app`

值	说明	最低版本
`follow`	-	-
`--app-M1`	-	-

示例代码

示例

import { usePanelConfig } from '@ray-js/panel-sdk';

function ThemeProvider({ children }) {
  const config = usePanelConfig();

  if (!config.initialized) {
    return <Loading />;
  }

  const bgColor = config.iot?.global?.background;
  return <View style={{ backgroundColor: bgColor }}>{children}</View>;
}

常见问题

Q：为什么在 App 根组件下使用会出现异常崩溃

A：usePanelConfig 内部实现依赖页面的 ready 事件，请勿在 App 根组件下直接使用该 hooks，此时页面还没有初次渲染完毕。

Q：面板小程序运行时的产品配置来源在哪里

如下图分别为：

图1：定时功能配置、跳转链接配置，对应返回值中的 panelConfig.bic
图2、3：自定义云能力配置入口及配置界面，对应返回值中的 panelConfig.fun

usePanelConfig()

描述

参数

返回值

Config

合法值

ThemeValue.rangeType

IoTPublicConfig.theme

FunConfig.tyabirysr4_app

FunConfig.tyabis5d9w_app