设置对话框

受控的应用程序级设置对话框,具有常规、配置文件、工具和存储视图。它通往文档正文,拥有其内部页面导航,并将触发器和打开状态留给安装它的任何页面、侧边栏或账户菜单。

安装

设置模式是一个多文件应用程序块,具有多个基本组件依赖项。通过 CLI 安装它,以便将完整的设置文件夹、共享组件、挂钩、样式和 npm 包一起解析:

已支持深色模式,此 组件 会自动使用 BoardUI 的语义设计变量。 设置主题切换.

npx boardui@latest add settings-modal

使用共享 UI 包或自定义导入别名? 配置您的安装路径 在运行 CLI 之前。复制粘贴示例使用默认导入。

触发模态

该块故意不渲染自己的触发器。保留 isOpen 在拥有该操作的主机中 - 例如侧边栏、用户菜单或设置按钮 - 并通过以下方式关闭它 onClose。背景按下、Escape 和关闭按钮都调用相同的处理程序。

const [settingsOpen, setSettingsOpen] = useState(false); <SidebarItem onPress={() => setSettingsOpen(true)}> Settings</SidebarItem> <SettingsModal isOpen={settingsOpen} onClose={() => setSettingsOpen(false)} defaultPage="profile"/>

初始页面

使用 defaultPage 当上下文操作应直接打开“常规”、“配置文件”、“工具”或“存储”时。每次打开对话框时,所选页面都会重置为该值。

<SettingsModal isOpen={isOpen} onClose={close} defaultPage="storage"/>

规划图稿

默认情况下,常规视图包含组件本机抽象处理。传递自己的公众形象 planArtSrc 提供动画当前计划图稿,而不将安装的块耦合到 BoardUI 资源。

<SettingsModal isOpen={isOpen} onClose={close} planArtSrc="/brand/your-plan-art.png"/>; // Omit planArtSrc to use the built-in token-based abstract artwork.