docs(Company): 添加组件目录结构文档
为 Company 模块下的主要组件添加 README.md: - CompanyHeader: 搜索栏组件 - CompanyOverview: 公司概览(基本信息 + 深度分析) - FinancialPanorama: 财务全景 - ForecastReport: 盈利预测 - MarketDataView: 市场数据 - StockQuoteCard: 股票行情卡片 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
41
src/views/Company/components/CompanyHeader/README.md
Normal file
41
src/views/Company/components/CompanyHeader/README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# CompanyHeader 组件
|
||||
|
||||
Company 页面顶部搜索栏组件,采用 FUI 科幻风格。
|
||||
|
||||
## 目录结构
|
||||
|
||||
```
|
||||
CompanyHeader/
|
||||
├── index.tsx # 主组件入口
|
||||
├── constants.ts # 样式常量配置
|
||||
└── README.md # 本文档
|
||||
```
|
||||
|
||||
## 功能说明
|
||||
|
||||
- 股票代码/名称搜索(AutoComplete)
|
||||
- 搜索结果下拉展示
|
||||
- 支持拼音缩写搜索
|
||||
|
||||
## 组件结构
|
||||
|
||||
```
|
||||
CompanyHeader
|
||||
└── SearchBox # 搜索框子组件
|
||||
└── AutoComplete (antd) # 自动完成输入
|
||||
└── Input # 搜索输入框
|
||||
```
|
||||
|
||||
## 使用示例
|
||||
|
||||
```tsx
|
||||
import CompanyHeader from '@views/Company/components/CompanyHeader';
|
||||
|
||||
<CompanyHeader onStockChange={(code) => handleStockChange(code)} />
|
||||
```
|
||||
|
||||
## Props
|
||||
|
||||
| 属性 | 类型 | 必填 | 说明 |
|
||||
|------|------|------|------|
|
||||
| `onStockChange` | `(code: string) => void` | 是 | 股票切换回调 |
|
||||
Reference in New Issue
Block a user