mantur-components 0.1.0 → 0.1.1

package/README.md

@@ -1,57 +1,67 @@
 # mantur-components
 
-Reusable Mantur React component library for React and Arco Design.
+Mantur React 组件库，基于 React 和 Arco Design。
 
-## Install
+## 安装
 
 ```bash
 npm install mantur-components
 ```
 
-Required peer dependencies:
+需要宿主项目提供以下 peer dependencies：
 
 ```bash
 npm install react react-dom @arco-design/web-react next-themes react-i18next
 ```
 
-The library uses Tailwind utility classes and does not export a standalone CSS file.
+组件库使用 Tailwind 工具类，不再导出独立的 CSS 文件，不需要引入 `mantur-components/style.css`。
 
 ## ManturHeader
 
-`ManturHeader` is the shared Mantur user header. It owns the header UI and the API calls for:
+`ManturHeader` 是 Mantur 用户端共用 Header。组件内部已经封装以下能力：
 
-- tenant list
-- current tenant
-- tenant switching
-- user points
-- profile update
-- logout
-- language switch
-- theme switch
+- 获取团队列表
+- 获取当前团队
+- 切换团队
+- 获取用户积分
+- 个人资料更新
+- 退出登录
+- 语言切换
+- 主题切换
 
-Basic usage:
+### 基础使用
 
 ```tsx
 import { ManturHeader } from "mantur-components";
 
-export function Header({ userInfo }: { userInfo: { username?: string; nickname?: string; avatar?: string } | null }) {
+export function Header({
+  userInfo,
+}: {
+  userInfo: { username?: string; nickname?: string; avatar?: string } | null;
+}) {
   return <ManturHeader user={userInfo} />;
 }
 ```
 
-With disabled tenant switching and custom slots:
+### 禁用团队切换和自定义插槽
 
 ```tsx
 import { ManturHeader } from "mantur-components";
 
-export function Header({ userInfo, disabled }: { userInfo: UserInfo | null; disabled?: boolean }) {
+export function Header({
+  userInfo,
+  disabled,
+}: {
+  userInfo: UserInfo | null;
+  disabled?: boolean;
+}) {
   return (
     <ManturHeader
       user={userInfo}
       disabled={disabled}
-      brandSlot={<span className="text-lg font-bold">Custom Brand</span>}
+      brandSlot={<span className="text-lg font-bold">自定义品牌</span>}
     >
-      <div className="px-4">Custom center content</div>
+      <div className="px-4">自定义中间内容</div>
     </ManturHeader>
   );
 }
@@ -68,15 +78,15 @@ interface ManturHeaderProps {
 }
 ```
 
-`user`: Current user shown in the right user menu.
+`user`：右侧用户菜单展示的当前用户信息。
 
-`disabled`: Disables tenant switching. When true, the tenant selector is shown as disabled and cannot be opened or switched.
+`disabled`：是否禁用团队切换。为 `true` 时，团队选择器展示为禁用态，无法展开和切换。
 
-`brandSlot`: Replaces the default brand title next to the logo. If omitted, the default localized title is shown.
+`brandSlot`：Logo 右侧品牌标题插槽。传入后显示传入内容；不传则显示默认国际化标题。
 
-`children`: Renders custom content in the middle flexible header area. If omitted, the area stays empty.
+`children`：Header 中间弹性区域插槽。传入后显示传入内容；不传则保持为空。
 
-### User Type
+### 用户类型
 
 ```ts
 interface ManturHeaderUser {
@@ -88,25 +98,27 @@ interface ManturHeaderUser {
 }
 ```
 
-### API Base
+## API 配置
 
-By default, API requests use `import.meta.env.VITE_API` and fall back to `/api`.
+默认情况下，组件库接口请求使用 `import.meta.env.VITE_API`，如果没有配置则回退到 `/api`。
 
-You can override it before rendering:
+可以在渲染组件前通过全局变量覆盖：
 
 ```ts
 window.__MANTUR_COMPONENTS_API_BASE__ = "/api";
 ```
 
-Points endpoint defaults to `/users/me/points`. It can be overridden:
+积分接口默认是 `/users/me/points`，也可以覆盖：
 
 ```ts
 window.__MANTUR_COMPONENTS_POINTS_ENDPOINT__ = "/users/me/points";
 ```
 
-### Tenant Context Event
+## 团队上下文同步
+
+团队列表、当前团队、切换团队都由 `ManturHeader` 内部处理。
 
-The header fetches and switches tenants internally. If the host app needs to sync local stores, listen to `MANTUR_TENANT_CONTEXT_CHANGE_EVENT`.
+如果宿主项目需要同步自己的 store，例如 `activeTenantId`、权限、角色、已开通应用，可以监听 `MANTUR_TENANT_CONTEXT_CHANGE_EVENT`。
 
 ```tsx
 import {
@@ -118,7 +130,7 @@ import {
 function applyTenantContext(detail: ManturTenantContextDetail) {
   const tenantId = detail.auth?.tenantId || detail.currentTenant?.tenantId;
 
-  // Sync host app stores here.
+  // 在这里同步宿主项目的状态。
   // setActiveTenantId(tenantId)
   // setPermissions(detail.auth?.permissions || [])
   // setRoles(detail.auth?.roles || [])
@@ -137,7 +149,7 @@ if (snapshot) {
 }
 ```
 
-Tenant context detail:
+团队上下文数据结构：
 
 ```ts
 interface ManturTenantContextDetail {
@@ -154,7 +166,7 @@ interface ManturTenantContextDetail {
 }
 ```
 
-### Exported Helpers
+## 导出的工具方法
 
 ```ts
 import {
@@ -171,7 +183,7 @@ import {
 } from "mantur-components";
 ```
 
-## Build
+## 构建
 
 ```bash
 npm run build

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mantur-components",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Reusable Mantur React component library.",
   "type": "module",
   "main": "./dist/mantur-components.umd.cjs",