# @frontify/sidebar-settings 中文文档

规范地址：https://npmcn.com/package/%40frontify/sidebar-settings/

版本：0\.12\.0
npm 元数据更新时间：2026-04-30T17:35:09.192Z
中文译文更新时间：2026-11-15T15:45:25.828Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40frontify/sidebar-settings
原文对照：https://npmcn.com/package/%40frontify/sidebar-settings/?lang=original
项目主页：https://github.com/Frontify/brand-sdk#readme
源码仓库：https://github.com/Frontify/brand-sdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：867 kB，65 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react ^18，react-dom ^18
- 首次发布：2022-11-29T17:32:31.727Z
- 最新版本发布：2026-04-30T17:35:08.880Z
- 近 30 天下载量：4178（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：83（近 12 个月 6 个）

## 中文简介

为设置边栏提供类型和帮助

## 安装

```sh
npm install @frontify/sidebar-settings
```

也可以使用：`pnpm add @frontify/sidebar-settings`、`yarn add @frontify/sidebar-settings`、`bun add @frontify/sidebar-settings`

## README

# 侧边栏设置

提供准则块的设置类型.

## 示例

```ts
/* (c) Copyright Frontify Ltd., all rights reserved. */

import { BlockSettings, Bundle } from '@frontify/guideline-blocks-settings';

export const settings: BlockSettings = {
    main: [
        {
            id: 'example',
            type: 'dropdown',
            size: 'Large',
            defaultValue: 'solid',
            choices: [
                {
                    value: 'noline',
                    icon: 'LineSpacer',
                    label: 'Spacer (no line)',
                },
                {
                    value: 'solid',
                    icon: 'LineSolid',
                    label: 'Line',
                },
            ],
            onChange: (bundle: Bundle): void => {
                const blockWidth = Number(bundle.getBlock('widthCustom')?.value);
                if (!Number.isNaN(blockWidth)) {
                    bundle.setBlockValue('widthCustom', `${blockWidth}%`);
                }
            },
        },
    ],
};
```

## 常见问题

### @frontify/sidebar-settings 是什么？

为设置边栏提供类型和帮助

### 如何安装 @frontify/sidebar-settings？

在项目目录运行 npm install @frontify/sidebar-settings，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18）、react-dom（^18）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @frontify/sidebar-settings 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @frontify/sidebar-settings 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @frontify/sidebar-settings 可以商用吗？

@frontify/sidebar-settings 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @frontify/sidebar-settings 的下载量有多少？

根据 npm 官方下载统计，@frontify/sidebar-settings 在 2026/10/16 – 2026/11/14 这 30 天内被下载 4,178 次，日均约 139 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @frontify/sidebar-settings 还在维护吗？

最新版本 0\.12\.0 发布于 2026/05/01（6 个月前）；至今共发布 83 个版本，其中过去 12 个月发布了 6 个；首次发布于 2022/11/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。