# @pablo2410/shared-ui 中文文档

规范地址：https://npmcn.com/package/%40pablo2410/shared-ui/

版本：0\.46\.0
npm 元数据更新时间：2026-11-02T02:21:10.093Z
中文译文更新时间：2026-11-02T03:40:32.139Z
软件包许可：UNLICENSED

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

原始 npm 页面：https://www.npmjs.com/package/%40pablo2410/shared-ui
原文对照：https://npmcn.com/package/%40pablo2410/shared-ui/?lang=original
项目主页：https://github.com/Oplytics-Digital/oplytics-shared-ui#readme
源码仓库：https://github.com/Oplytics-Digital/oplytics-shared-ui

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

- 包体积（解压后）：1.7 MB，83 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：42 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2026-03-17T14:04:26.209Z
- 最新版本发布：2026-11-02T02:21:09.915Z
- 已发布版本数：77（近 12 个月 77 个）

## 中文简介

共享UI组件库为所有的Oplytics。数字子域

## 安装

```sh
npm install @pablo2410/shared-ui
```

也可以使用：`pnpm add @pablo2410/shared-ui`、`yarn add @pablo2410/shared-ui`、`bun add @pablo2410/shared-ui`

## README

# @oplytics /共享的ui

为所有人共享UI组件库 **Oplytics.digital** 子域。提供标准化布局、层次管理、RBAC、报告、挂钩和设计令牌作为可重用的构建块。

## 安装

```bash
pnpm add @oplytics/shared-ui
```

> 需要 `.npmrc` 与 `@oplytics:registry=https://npm.pkg.github.com`

## 模块

| 模块 | 进口 | 描述 |
| --- | --- | --- |
| **布局** | `@oplytics/shared-ui/layout` | 配置驱动的侧边栏，页眉，页脚，布局工厂 |
| **层次结构** | `@oplytics/shared-ui/hierarchy` | 组织层次结构类型、选择状态、企业覆盖 |
| **RBAC** | `@oplytics/shared-ui/rbac` | 角色模型，权限检查，错误常量 |
| **报告** | `@oplytics/shared-ui/reporting` | 事件报告和反馈工具栏类型/配置 |
| **组件** | `@oplytics/shared-ui/components` | SharedFooter, NotFound, ErrorBoundary, ViewOnlyBadge， AcceptanceBadge类型 |
| **钩子** | `@oplytics/shared-ui/hooks` | 使用移动，使用组合，使用持久化 |
| **主题** | `@oplytics/shared-ui/theme` | 设计令牌，调色板，排版，CSS变量 |
| **行动** | `@pablo2410/shared-ui/actions` | 到期日期状态（过期，即将到期）及其芯片，用于操作和租约 |
| **I18n** | `@pablo2410/shared-ui/i18n` | 翻译: `useT()`英语后退，语言选择， `formatDate` |

## 快速入门

```tsx
// RBAC — check permissions
import { hasMinimumRole, ALL_ROLES } from "@oplytics/shared-ui/rbac";

if (hasMinimumRole(user.role, "enterprise_admin")) {
  // show admin features
}

// Hierarchy — enterprise override
import { applyEnterpriseOverride } from "@oplytics/shared-ui/hierarchy";

const resolvedUser = applyEnterpriseOverride(user, req.headers.cookie);

// Layout — service config
import {
  SERVICE_CONFIGS,
  defineServiceLayout,
} from "@oplytics/shared-ui/layout";

const myConfig = SERVICE_CONFIGS.sqdcp;

// Theme — design tokens
import { OPLYTICS_COLORS, OPLYTICS_FONTS } from "@oplytics/shared-ui/theme";

// Hooks
import { useMobile, usePersistFn } from "@oplytics/shared-ui/hooks";
```

## Opi旅游

每个模块都以同样的方式进行入门之旅。模块提供 定义和标记其聚光灯步骤指向的元素-仅此而已 是每个模块（没有存储，没有触发，没有叙述代码）：

```tsx
import {
  useRegisterTour,
  type TourDefinition,
} from "@pablo2410/shared-ui/tour";

// Module scope (or useMemo) so the object is stable across renders.
const tour: TourDefinition = {
  id: "policy-deployment", // lowercase-kebab; never rename once shipped
  steps: [
    { id: "welcome", kind: "intro", label: "Welcome", fallbackText: "…" },
    {
      id: "plans",
      kind: "service",
      label: "Policy plans",
      fallbackText: "…",
      spotlight: { selector: "plan-card" }, // <div data-tour-target="plan-card">
    },
  ],
};

function PolicyPage() {
  useRegisterTour(tour);
  // …
}
```

然后共享代码做什么：

-   **触发** - - - - - - `DashboardLayout`的标题只显示“参观” Tour已注册，并从步骤1开始重播。
-   **进步** -通过传送门读写 `onboarding.userTourState` / `setUserTourState`，因此它跟随用户跨模块。没有模块表。
-   **叙述** -每一步调用传送门 `ai.askOpi` 带着保留的 `onboarding` 服务（传送门的登录角色），回落到 一步的 `fallbackText` 如果Opi不可用。
-   **显示歌词** -默认关闭；集 `autoStart: true` 关于的定义 对没有参观过或中途离开的用户开放。模块从来没有 安装他们自己的 `OpiTourHost` - - - - - - `DashboardLayout` 挂载一个。

每个巡回存储需要Portal接受并回显a `tourId` 在这两个方面 端点。在此之前，模块巡视的进度不会被保存（读取失败） 安全，没有自动打开，旅游和它的头回放仍然工作)，和 Service Hub tour自己的进度永远不会被覆盖。

## 翻译

`@pablo2410/shared-ui/i18n` 是每个应用程序使用的一个翻译设置（i18next与react-i18next）。英语是默认值，而退一步：在其他语言中缺少的字符串将以英语显示，永远不会作为其键或空白。键看 `<app>.<page>.<thing>`;共享ui自己的是 `shared.` 钥匙在 `src/i18n/en.json` 和 `fr.json`.

```tsx
import { I18nProvider, createI18n, useT } from "@pablo2410/shared-ui/i18n";

// Once, around the app, with the app's own strings beside shared-ui's:
const i18n = createI18n({ language: user.language, resources: { en, fr } });
<I18nProvider i18n={i18n} onLanguageChange={saveLanguage}>
  …
</I18nProvider>;

// In a component:
const t = useT();
t("portal.home.title");
```

-   在没有提供程序的情况下，shared-ui的组件仍然以英语或浏览器选择的语言呈现。
-   语言选择器位于shell的用户菜单中（英语、法语）。它把选择交给 `onLanguageChange` (在 `DashboardLayout` 或者 `I18nProvider`);如果没有，浏览器会记住它。 `DashboardLayout`的 `language` Prop将外壳切换为应用程序已经知道的语言。
-   一款没有每种语言都有文本的应用程序，但它提供的是： `<I18nProvider languages={["en"]}>`． 然后，选择器只列出那些，保留的语言永远不会是活动语言（即使是之前选择的语言），并且 `useLanguage().languages` 给出相同的列表。如果不设置，则提供所有语言（shared-ui#211）。
-   `formatDate` 和 `formatNumber` (或 `useFormat()`)格式通过 `Intl` 用现在的语言；英语是 `en-GB`.
-   客户自己输入的内容显示为输入的，而不是翻译的。
-   服务器和营销站点的服务目录保持英文。 `localizeService(service, t)` (从 `/services`)提供服务的标语、描述和入门文本 `t`的语言。
-   如果组件呈现不在中的文本，则测试失败 `en.json`，如果显示文本位于代码(a)中 `label`， `title` 或者 `description` 值，一个道具默认值，一个 `*_LABEL` Map)，或者if `fr.json` 不匹配 `en.json` 钥匙对钥匙。

## 主题CSS

导入规范的Oplytics主题变量：

```css
@import "@oplytics/shared-ui/theme/oplytics-theme.css";
```

这提供了所有 `--oplytics-*` 背景、文本、重音、边框、间距、半径和阴影的CSS自定义属性。

## 开发

```bash
pnpm install
pnpm build        # Build with tsup
pnpm test         # Run vitest
pnpm typecheck    # TypeScript check
```

## 体系结构

这个包是可树摇的，每个模块都有单独的入口点。每个子域只导入它需要的内容：

```
src/
  layout/       # SharedSidebar, createServiceLayout, serviceConfigs
  hierarchy/    # orgHierarchy types, enterpriseOverride
  rbac/         # Roles, permissions, error constants
  reporting/    # ReportingToolbar types and config
  components/   # SharedFooter, NotFound, ErrorBoundary types
  hooks/        # useMobile, useComposition, usePersistFn
  theme/        # Design tokens, CSS variables
  actions/      # getDueDateStatus, DueDateChip (Action Manager and Policy Deployment)
  i18n/         # i18next set-up, useT, en.json / fr.json, LanguagePicker, formatDate
```

## 版本控制

-   **v0.x** -类型、配置和纯实用程序（没有React组件渲染）
-   **v1.0** -完整的React组件与shadcn/ui原语捆绑

## 许可证

未经许可-内部整形。仅限数字使用。

## 常见问题

### @pablo2410/shared-ui 是什么？

共享UI组件库为所有的Oplytics。数字子域

### 如何安装 @pablo2410/shared-ui？

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

### @pablo2410/shared-ui 支持 TypeScript 吗？

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

### @pablo2410/shared-ui 支持 ESM 还是 CommonJS？

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

### @pablo2410/shared-ui 可以商用吗？

@pablo2410/shared-ui 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @pablo2410/shared-ui 还在维护吗？

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