应用入口 - Ice — ContextQMD

ice.js 通过应用配置的方式渲染整个应用，开发者可以根据提供的配置定制应用。

应用配置文件

框架以 src/app.ts 作为应用配置文件：

import { defineAppConfig } from 'ice';

export default defineAppConfig(() => ({
  app: {
    strict: true,
  },
}));

推荐通过 defineAppConfig() 的方式导出应用配置，以获得良好的类型提示。

配置项

应用入口的配置项，支持应用常用的相关配置。

app

`rootId`

根节点 id

类型：string
默认值：ice-container

`strict`

是否开启 React 的严格模式 (React.StrictMode)

类型：boolean
默认值：false

`errorBoundary`

是否启用内置的错误边界捕获能力

类型：boolean
默认值：false

router

`type`

路由类型

类型：'hash' | 'browser' | 'memory'
默认值：browser

:::tip

当设置路由类型为 memory 时，需要对应设置 initialEntries。

:::

`initialEntries`

路由类型设置为 MemoryRouter 时，需要渲染的路由。

类型：InitialEntry[]
默认值：['/']

import { defineAppConfig } from 'ice';

export default defineAppConfig(() => ({
  router: {
    type: 'memory',
    // 渲染 home 页面
    initialEntries: ['/home'],
  },
}));

`basename`

路由 basename

类型：string
默认值：/

运行时拓展

应用入口除了支持定义应用配置之外，同时也承担运行时扩展的能力，比如权限配置：

import { defineAppConfig } from 'ice';
import { defineAuthConfig } from '@ice/plugin-auth/types';

// 导出 auth 相关的能力，该能力由 @ice/plugin-auth 插件提供
export const authConfig = defineAuthConfig(() => {
  return {
    initialAuth: {
      admin: true,
    },
  };
});

export default defineAppConfig(() => ({
  app: {
    strict: true,
  },
}));