UNPKG

cnd-components-mcp

Version:

An MCP service for Cnd components query | 一个减少 Cnd 组件代码生成幻觉的 MCP 服务,包含系统提示词、组件文档、API 文档、代码示例和更新日志查询

160 lines (116 loc) 4.79 kB
## 简介 全局提示常用于提供成功、错误、运行中等状态信息的提示,显示后会自动消失,属于不会阻断用户操作的轻量级反馈提示。 ## 示例 ```tsx import React from 'react'; import { Message, Button } from '@alicloud/console-components'; const showSuccess = () => Message.success('成功'); const showWarning = () => Message.warning('警告'); const showError = () => Message.error('错误'); const showNotice = () => Message.notice('通知'); const showHelp = () => Message.help('帮助'); const showLoading = () => Message.loading('加载'); export default () => { const style = { marginRight: 10, }; return ( <div> <Button onClick={showSuccess} style={style}> 成功 </Button> <Button onClick={showWarning} style={style}> 警告 </Button> <Button onClick={showError} style={style}> 错误 </Button> <Button onClick={showNotice} style={style}> 通知 </Button> <Button onClick={showHelp} style={style}> 帮助 </Button> <Button onClick={showLoading} style={style}> 加载 </Button> </div> ); }; export const meta = { title: '使用示例', describe: '通过增加closeable属性可以控制提示框是否可关闭。', }; ``` ## 使用建议 #### DO * 全局提示位置固定在页面顶部居中; * 全局提示消失时间不能小于3秒。 #### CAUTION * 如果希望中断用户操作进行提示,建议使用对话框; * 如果希望提示信息长期稳定存在,建议使用信息提示条(Message Strip)。 ## 文案使用建议 全局提示与消息弹窗、警告提示的不同之处在于,它没有标题和交互按钮,只有消息主体,而且会在很短的时间内自主消失。 此类消息包括以下类型: 1\. 成功(Success) 2\. 警告(Warning) 3\. 错误(Error) 4\. 说明(Information) 5\. 进行中(In Progress) ### 1. 成功(success) #### Do * 内容要求:描述成功完成的事项;使用简洁明了的表述,如果只有单个句子则末尾不加句号。 * 内容模板(供参考):(中文)动词 + 名词 + “成功” / (英文)Object + Verb (past participle) #### Don't * 内容要求:(英文)不使用“Successfully”一词 #### 文案示例 • 正确:创建实例成功 错误:创建实例成功。如需查看实例,请前往实例列表。 解析:由于全局提示会在几秒内自动消失,所以内容不宜过长。 • 正确:Contact created 错误:Contact created successfully. 解析:句末的“successfully”显得多余,而且由于是省略句(非完整句),末尾不应加句点。 ### 2. 警告(Warning) 用于告知用户当前操作可能造成的不良后果。 #### Do • 内容要求:说明可能造成不良后果的操作及可能的后果。使用简洁明了的表述,如果只有单个句子则末尾不加句号。 #### Don't • 内容不宜过长 文案示例 • 正确:刷新过于频繁可能导致系统不稳定 错误:刷新过于频繁可能导致系统不稳定,建议您降低刷新频率。 解析:由于全局提示会在几秒内自动消失,所以内容不宜过长。 ### 3. 错误(Error) 用于告知用户其操作没有取得目标结果。 #### Do • 内容要求:告知出错的事实。使用简洁明了的表述,如果只有单个句子则末尾不加句号 • 内容模板(供参考): (中文)场景描述 + “时出错” (中文)场景描述 + “失败” (中文)“无法” + 场景描述 (英文)"Failed to" + description of operation (英文)Description of operation + "failed" #### 文案示例 • 正确:无法连接服务器,请稍后重试。 错误:目前无法连接服务器,所以无法加载最新数据。请检查您的网络连接是否正常,或者稍后重试。 解析:由于全局提示会在几秒内自动消失,所以内容不宜过长。 • 正确:Cannot load filters 错误:We have trouble loading the filters currently. 解析:由于全局提示会在几秒内自动消失,所以内容不宜过长。 ### 4. 说明(Information) 仅用于告知信息,用户无需采取任何行动。 #### Do • 内容要求:简要说明正在执行中的操作或命令 • 内容模板(供参考): (中文)“正在” + 操作 / 命令 + “...” (中文)操作 / 命令 + “中...” (中文)“无法” + 场景描述 (英文)Gerund + Object + "..." (英文)Noun + "in progress..." #### 文案示例 正确:正在下载... 错误:正在下载。。。 解析:不能以三个中文句号代替“...” ## API ```tsx ```