@pisell/materials 1.8.41 → 1.8.43

package/es/components/pisellCustomerBrief/docs/pisellCustomerBrief.$tab-dev.md

@@ -1,73 +0,0 @@
----
-title: 开发文档
-order: 3
-category: pro
----
-
-# PisellCustomerBrief 开发文档
-
-## 1. 基础信息
-
-- **组件名称**：PisellCustomerBrief（Customer Info）
-- **组件版本**：1.0
-- **组件分类**：Data Display / Plus Components
-- **依赖**：基于 PisellEntityCard 封装，无额外业务弹窗。
-
-## 2. 需求点罗列
-
-1. **客户身份信息**：客户名称（主文案）、副标题（电话/编号）、头像（无则默认占位）。
-2. **扩展信息**：Email、Address、Company、Date、自定义属性，映射为 Entity Card 的 secondaryTexts，顺序固定为 email → address →
-   company → date → extendedFields。
-3. **标签**：客户级等级、状态等，透传 Entity Card tags。
-4. **操作区**：透传 Entity Card actions（仅图标 / 图标+文本 / 按钮）；Actions 为空时不占位。
-5. **密度与布局**：透传 density（B1/B2/B5/B9）、layout（horizontal/vertical）、width。
-6. **左滑删除**：透传 swipeToDelete、onDelete。
-7. **显隐**：showAvatar、showPrimaryText、showSubtitle、showExtended、showTags、showActions。
-8. **插槽**：透传 renderMedia、renderPrimary、renderSubtitle、renderSecondary、renderTags、renderActions。
-
-## 3. 组件描述
-
-PisellCustomerBrief 是基于 PisellEntityCard
-的客户简要卡片，用于统一展示客户实体的核心识别信息与客户级属性。将客户领域字段（name、subtitle、email、address、company、date、extendedFields、tags）映射为
-Entity Card 的结构化配置，无头像时由 Entity Card 显示默认占位 Avatar。
-
-## 4. 组件 API 罗列
-
-- **继承 BaseCard 能力**：className, style, hoverStyle, activeStyle, disabledStyle, clickable, disabled, onClick。
-- **核心身份**：name, subtitle, avatar。
-- **扩展信息**：email, address, company, date, extendedFields；showExtended。
-- **标签与操作**：tags, actions；showTags, showActions。
-- **显隐**：showAvatar, showPrimaryText, showSubtitle。
-- **密度与布局**：density, layout, width；tagPosition, contentGap, primaryLineClamp, secondaryLineClamp。
-- **左滑删除**：swipeToDelete, onDelete。
-- **插槽**：renderMedia, renderPrimary, renderSubtitle, renderSecondary, renderTags, renderActions。
-
-## 5. 模块拆解与实现方案
-
-### 5.1 组成与引用
-
-- **PisellEntityCard**：唯一子组件，接收映射后的 props。
-- **PisellCustomerBrief**：负责将客户语义 Props 映射为 Entity Card 的
-  media、primaryText、subtitleText、secondaryTexts、tags、actions 及显隐/密度/布局/插槽。
-
-### 5.2 数据映射
-
-- `name` → primaryText
-- `subtitle` → subtitleText
-- `avatar`（或 undefined）→ media: { type: 'avatar', src, alt: name, size: 40, shape: 'circle' }
-- `email`、`address`、`company`、`date`、`extendedFields` 按顺序合并为 secondaryTexts
-- `tags`、`actions` 透传
-- showAvatar → showMedia，showExtended → showSecondaryText，其余 show* 一一对应
-
-### 5.3 结构图
-
-```
-PisellCustomerBrief（根：PisellEntityCard + 类名 pisell-customer-brief-root）
-└── 内部即 PisellEntityCard 结构（媒体区 + 文案区 + 标签 + 操作区）
-```
-
-### 5.4 实现要点
-
-- 无 avatar 时仍传 media（src 为 undefined），由 Entity Card / Avatar 显示默认占位。
-- 扩展信息顺序固定，便于 B5/B9 等多行展示时语义一致。
-- 样式仅增加 .pisell-customer-brief-root 作用域，具体样式由 Entity Card 提供。

package/es/components/pisellCustomerBrief/docs/pisellCustomerBrief.$tab-test.md

@@ -1,66 +0,0 @@
----
-title: 测试文档
-order: 4
-category: pro
----
-
-# PisellCustomerBrief 组件测试用例文档
-
-## 测试概览
-
-本文档列出 PisellCustomerBrief 组件的测试用例点，基于 types.ts 与组件实现（委托 PisellEntityCard）。
-
----
-
-## 一、基础渲染测试
-
-| 测试项          | 测试步骤                       | 预期结果                                                                                  | 测试类型 |
-|--------------|----------------------------|---------------------------------------------------------------------------------------|------|
-| 根节点渲染        | 仅传 name                    | 存在 .pisell-entity-card-wrap 且内含 .pisell-customer-brief-root（通过 EntityCard 根 class 合并） | 自动化  |
-| 主文案渲染        | 传入 name="客户A"              | 页面显示「客户A」                                                                             | 自动化  |
-| 副标题渲染        | 传入 subtitle="+86 138"      | 页面显示「+86 138」                                                                         | 自动化  |
-| 扩展信息渲染       | 传入 email、company           | 次级区域显示邮箱与公司                                                                           | 自动化  |
-| 标签渲染         | 传入 tags=[{ text: 'VIP' }]  | 页面显示「VIP」                                                                             | 自动化  |
-| 无头像默认占位      | 不传 avatar，showAvatar=true  | 存在媒体区（默认 Avatar 占位）                                                                   | 自动化  |
-| className 合并 | 传入 className="custom"      | 根节点 class 包含 custom 与 pisell-customer-brief-root                                      | 自动化  |
-| style 透传     | 传入 style={{ padding: 16 }} | 卡片应用对应样式                                                                              | 自动化  |
-
----
-
-## 二、显隐与默认值测试
-
-| 测试项                  | 测试步骤                             | 预期结果    | 测试类型 |
-|----------------------|----------------------------------|---------|------|
-| showAvatar 默认 true   | 不传 showAvatar                    | 显示媒体区   | 自动化  |
-| showAvatar=false     | showAvatar=false                 | 不显示媒体区  | 自动化  |
-| showSubtitle=false   | 传入 subtitle 且 showSubtitle=false | 不显示副标题  | 自动化  |
-| showExtended=false   | 传入 email 且 showExtended=false    | 不显示扩展信息 | 自动化  |
-| showActions 默认 false | 传入 actions，不传 showActions        | 不显示操作区  | 自动化  |
-| showActions=true     | 传入 actions 且 showActions=true    | 显示操作区   | 自动化  |
-
----
-
-## 三、数据映射测试
-
-| 测试项               | 测试步骤                                             | 预期结果                                                      | 测试类型 |
-|-------------------|--------------------------------------------------|-----------------------------------------------------------|------|
-| extendedFields 顺序 | 传入 extendedFields=[{ text: 'A' }, { text: 'B' }] | 次级区域按 A、B 顺序展示                                            | 自动化  |
-| 扩展信息顺序            | 传入 email、address、company、date、extendedFields     | 次级展示顺序为 email → address → company → date → extendedFields | 自动化  |
-
----
-
-## 四、左滑删除与交互测试
-
-| 测试项    | 测试步骤                                    | 预期结果                   | 测试类型 |
-|--------|-----------------------------------------|------------------------|------|
-| 透传左滑删除 | swipeToDelete=true、onDelete 为 jest.fn() | 存在滑动容器，点击删除触发 onDelete | 自动化  |
-| 点击卡片   | 传入 onClick 为 jest.fn()，点击卡片             | onClick 被调用            | 自动化  |
-
----
-
-## 五、密度与布局测试
-
-| 测试项           | 测试步骤              | 预期结果        | 测试类型 |
-|---------------|-------------------|-------------|------|
-| density 默认 B2 | 不传 density        | 按 B2 规则展示次级 | 自动化  |
-| layout 透传     | layout="vertical" | 文案区竖向排布     | 自动化  |

package/es/components/pisellCustomerBrief/docs/pisellCustomerBrief.md

@@ -1,132 +0,0 @@
----
-nav:
-  title: 组件
-  order: 1
-group:
-  title: Data Display
-  order: 1
-title: PisellCustomerBrief
-order: 1
-category: pro
----
-
-# PisellCustomerBrief 客户简要卡片
-
-基于 **PisellEntityCard** 的 Plus 组件，用于在界面中展示**客户（Customer）实体的核心识别信息与客户级属性**。在 Entity Card
-提供的统一实体结构之上，补充客户领域特有的字段与语义。
-
-## 设计文档
-
-详见 [设计文档](./pisellCustomerBrief.$tab-design.md)。
-
-## 何时使用
-
-- 客户列表 / 客户搜索结果
-- 订单、合同、会员等模块中的客户引用
-- 客户详情页的概要区域
-
-## 代码示例
-
-### 基础用法
-
-```tsx
-import {PisellCustomerBrief} from '@pisell/materials';
-
-export default function Demo() {
-    return (
-        <PisellCustomerBrief
-            name="某某公司"
-            subtitle="+86 138 0000 0000"
-            email="contact@company.com"
-            company="某某科技有限公司"
-            tags={[{text: 'VIP'}, {text: '已签约'}]}
-        />
-    );
-}
-```
-
-### 带扩展信息与操作
-
-```tsx
-import {PisellCustomerBrief} from '@pisell/materials';
-import {EditOutlined} from '@ant-design/icons';
-
-export default function Demo() {
-    return (
-        <PisellCustomerBrief
-            name="某某公司"
-            subtitle="客户编号 C001"
-            email="contact@company.com"
-            address="浙江省杭州市余杭区"
-            company="某某科技有限公司"
-            date="2024-01-15 创建"
-            tags={[{text: 'VIP'}, {text: '已签约'}]}
-            showActions
-            actions={[
-                {type: 'icon', icon: <EditOutlined/>, onClick: () => console.log('编辑')},
-                {type: 'text', label: '查看详情', onClick: () => console.log('详情')},
-            ]}
-            density="B5"
-        />
-    );
-}
-```
-
-### 无头像（默认占位）
-
-不传 `avatar` 时显示默认占位 Avatar。
-
-```tsx
-import {PisellCustomerBrief} from '@pisell/materials';
-
-export default function Demo() {
-    return <PisellCustomerBrief name="新客户" subtitle="待完善"/>;
-}
-```
-
-### 密度与布局
-
-- `density`: B1（一行）/ B2（两行）/ B5（五行）/ B9（全部）
-- `layout`: horizontal（横向）/ vertical（竖向）
-
-```tsx
-import {PisellCustomerBrief} from '@pisell/materials';
-
-export default function Demo() {
-    return (
-        <PisellCustomerBrief
-            name="客户名称"
-            email="a@b.com"
-            company="公司名"
-            density="B5"
-            layout="vertical"
-        />
-    );
-}
-```
-
-## API
-
-| 属性             | 说明               | 类型                            | 默认值          |
-|----------------|------------------|-------------------------------|--------------|
-| name           | 客户名称（主文案）        | string                        | -            |
-| subtitle       | 副标题，与主标题同行       | string                        | -            |
-| avatar         | 头像地址，不传则默认占位     | string                        | -            |
-| email          | 邮箱（扩展信息）         | string                        | -            |
-| address        | 地址（扩展信息）         | string                        | -            |
-| company        | 公司（扩展信息）         | string                        | -            |
-| date           | 日期类信息（扩展信息）      | string                        | -            |
-| extendedFields | 自定义扩展字段列表        | CustomerBriefExtendedField[]  | []           |
-| tags           | 标签（如等级、状态）       | EntityCardTagItem[]           | []           |
-| actions        | 操作项              | EntityCardActionItem[]        | []           |
-| showActions    | 是否显示操作区          | boolean                       | false        |
-| showAvatar     | 是否显示头像           | boolean                       | true         |
-| showExtended   | 是否显示扩展信息         | boolean                       | true         |
-| showTags       | 是否显示标签           | boolean                       | true         |
-| density        | 信息密度 B1/B2/B5/B9 | EntityCardDensity             | 'B2'         |
-| layout         | 布局方向             | 'horizontal' \| 'vertical'    | 'horizontal' |
-| width          | 卡片宽度             | 'content' \| 'full' \| number | 'content'    |
-| swipeToDelete  | 是否开启左滑删除         | boolean                       | false        |
-| onDelete       | 左滑删除回调           | () => void                    | -            |
-
-更多样式与插槽见 [types.ts](../types.ts)。

package/es/components/pisellCustomerBrief/index.d.ts

@@ -1,2 +0,0 @@
-import { CustomerBriefExtendedField, PisellCustomerBriefProps } from "./types.js";
-import { PisellCustomerBrief } from "./PisellCustomerBrief.js";

package/es/components/pisellCustomerBrief/types.d.ts

@@ -1,86 +0,0 @@
-import { PisellBaseCardProps } from "../pisellBaseCard/types.js";
-import { EntityCardActionItem, EntityCardDensity, EntityCardLayout, EntityCardTagItem, EntityCardWidth } from "../pisellEntityCard/types.js";
-import { ReactNode } from "react";
-
-//#region src/components/pisellCustomerBrief/types.d.ts
-/**
- * 客户简要卡片扩展字段项（用于 B5/B9 等多行展示）
- * 与 Entity Card 的 secondaryTexts 对应，语义为客户领域
- */
-interface CustomerBriefExtendedField {
-  /** 展示文案（如 Email、Address、Company、Date、自定义属性） */
-  text: string;
-  /** 是否显示提示图标 */
-  showTooltip?: boolean;
-}
-/**
- * PisellCustomerBrief 组件 Props
- * 基于 PisellEntityCard，用于展示客户（Customer）实体的核心识别信息与客户级属性
- * 设计文档：Customer Info (pcl_customerInfon_V1.0)
- */
-interface PisellCustomerBriefProps extends Pick<PisellBaseCardProps, 'className' | 'style' | 'hoverStyle' | 'activeStyle' | 'disabledStyle' | 'clickable' | 'disabled' | 'onClick'> {
-  /** 客户名称（主文案） */
-  name: string;
-  /** 副标题，与主标题同行（如电话、客户编号） */
-  subtitle?: string;
-  /** 头像图片地址；不传则显示默认占位 Avatar */
-  avatar?: string;
-  /** 邮箱 */
-  email?: string;
-  /** 地址 */
-  address?: string;
-  /** 公司 */
-  company?: string;
-  /** 日期类信息（如创建日期、跟进日期） */
-  date?: string;
-  /** 自定义扩展字段，顺序即展示顺序 */
-  extendedFields?: CustomerBriefExtendedField[];
-  /** 标签列表（如等级、状态） */
-  tags?: EntityCardTagItem[];
-  /** 操作项：仅图标 / 图标+文本 / 按钮 */
-  actions?: EntityCardActionItem[];
-  /** 是否显示操作区 @default false */
-  showActions?: boolean;
-  /** 是否显示头像 @default true */
-  showAvatar?: boolean;
-  /** 是否显示主文案 @default true */
-  showPrimaryText?: boolean;
-  /** 是否显示副标题 @default true */
-  showSubtitle?: boolean;
-  /** 是否显示扩展信息（email/address/company/date/extendedFields） @default true */
-  showExtended?: boolean;
-  /** 是否显示标签 @default true */
-  showTags?: boolean;
-  /** 信息密度 @default 'B2' */
-  density?: EntityCardDensity;
-  /** 布局方向 @default 'horizontal' */
-  layout?: EntityCardLayout;
-  /** 卡片宽度 @default 'content' */
-  width?: EntityCardWidth;
-  /** 是否开启左滑删除 @default false */
-  swipeToDelete?: boolean;
-  /** 左滑删除回调 */
-  onDelete?: () => void;
-  /** 标签位置 @default 'below' */
-  tagPosition?: 'inline' | 'below';
-  /** 内容区间距 */
-  contentGap?: number | string;
-  /** 主文案行数限制 */
-  primaryLineClamp?: number;
-  /** 扩展信息行数限制（按密度有默认值） */
-  secondaryLineClamp?: number;
-  /** 自定义渲染媒体区 */
-  renderMedia?: () => ReactNode;
-  /** 自定义渲染主文案区 */
-  renderPrimary?: () => ReactNode;
-  /** 自定义渲染副标题区 */
-  renderSubtitle?: () => ReactNode;
-  /** 自定义渲染扩展信息区 */
-  renderSecondary?: () => ReactNode;
-  /** 自定义渲染标签区 */
-  renderTags?: () => ReactNode;
-  /** 自定义渲染操作区 */
-  renderActions?: () => ReactNode;
-}
-//#endregion
-export { CustomerBriefExtendedField, PisellCustomerBriefProps };

package/es/components/pisellEntityCard/PisellEntityCard.d.ts

@@ -1,47 +0,0 @@
-import { PisellEntityCardProps } from "./types.js";
-import React from "react";
-//#region src/components/pisellEntityCard/PisellEntityCard.d.ts
-/**
- * PisellEntityCard 实体卡片
- * 基于 PisellBaseCard，使用结构化配置展示实体信息，支持密度、布局、左滑删除与插槽
- */
-declare function PisellEntityCard({
-  children,
-  className,
-  style,
-  hoverStyle,
-  activeStyle,
-  disabledStyle,
-  clickable,
-  disabled,
-  onClick,
-  media,
-  primaryText,
-  subtitleText,
-  secondaryTexts,
-  tags,
-  actions,
-  showMedia,
-  showPrimaryText,
-  showSubtitle,
-  showSecondaryText,
-  showTags,
-  showActions,
-  density,
-  layout,
-  width,
-  swipeToDelete,
-  onDelete,
-  tagPosition,
-  contentGap,
-  primaryLineClamp,
-  secondaryLineClamp: secondaryLineClampProp,
-  renderMedia,
-  renderPrimary,
-  renderSubtitle,
-  renderSecondary,
-  renderTags,
-  renderActions
-}: PisellEntityCardProps): React.JSX.Element;
-//#endregion
-export { PisellEntityCard };