📚 按钮参数说明
📚 按钮参数说明
📚 按钮参数说明 📚 按钮参数说明 Modified September 4, 2024 使用场景 按钮组件是一个可交互的组件,支持配置特定链接的跳转功能或触发预设技能的操作。 使用示例 链接跳转 action 为 navigate,需要配合 url 属性一起使用。 Code block Markdown <button type="primary" width="default" action="navigate" url="https://www.feishu.cn" 跳转到飞书官网 </button 使用技能 action 为 message,需要配合 message 和 skill (可选)属性一起使用。 Code block Markdown <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" 点击使用展示 title 的技能 </button 组件属性说明 属性 类型 必填 默认值 说明 type default | primary | danger | text | primaryFilled | dangerFilled | primaryText | dangerText 否 default 按钮的样式,支持 8 种样式设置。 Web 端 飞书端 width string 否 default 按钮的宽度: • default:默认宽度策略(根据渲染环境不同会不同) • fill:填充父容器宽度 • Npx:指定宽度,100px, 200px 等,N 取值范围为 [100px, 不限制上限] size tiny | small | medium | large 否 medium 按钮的尺寸: • tiny:超小尺寸,PC 端为 24px;移动端为 28px • small:小尺寸,PC 端为 28px;移动端为 28px • medium:中尺寸,PC 端为 32px;移动端为 36px • large:大尺寸,PC 端为 40px;移动端为 48px action navigate | message 是 按钮点击后的行为: • navigate:跳转到指定的 url,需要配置 url 参数 • message:需要发送的消息,需要配置 message 参数 url string action 为 navigate 时必填 跳转到的 url 地址 urlMode default | raw 否 default URL 打开行为: • default:采用消息渠道特化的 URL 打开方式,如飞书中通过侧拉窗打开 URL • raw:使用本地浏览器(PC / Mobile)打开 URL message string 否 发送的消息内容 skill string 否 明确指定技能,不指定时智能识别(比用户指定技能的优先级更高) 形式如 skill mvkzddgxspaag(目前可以在对应技能页面 url 的最后一段来获取) 📌 技能需要是「开启状态」才能被调用 skillInput object 否 传递给调用技能的入参,与被调用技能开始节点的自定义参数定义一一对应。 Code block <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" skillInput={ "customParam": "hello" } 点击使用展示 title 的技能 </button 注意事项 1. 暂不支持一行展示多个按钮,如有需要请暂时用多栏布局模拟 Code block HTML <row <col flex=1 <button type="primary" width="default" action="navigate" url="https://www.feishu.cn" 跳转到飞书官网 </button </col <col flex=1 <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" 点击使用展示 title 的技能 </button </col </row 技能 使用场景 按钮组件是一个可交互的组件,支持配置特定链接的跳转功能或触发预设技能的操作。 技能 使用示例 链接跳转 action 为 navigate,需要配合 url 属性一起使用。 Code block Markdown <button type="primary" width="default" action="navigate" url="https://www.feishu.cn" 跳转到飞书官网 </button Code block Markdown <button type="primary" width="default" action="navigate" url="https://www.feishu.cn" 跳转到飞书官网 </button 使用技能 action 为 message,需要配合 message 和 skill (可选)属性一起使用。 Code block Markdown <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" 点击使用展示 title 的技能 </button Code block Markdown <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" 点击使用展示 title 的技能 </button 组件属性说明 属性 类型 必填 默认值 说明 type default | primary | danger | text | primaryFilled | dangerFilled | primaryText | dangerText 否 default 按钮的样式,支持 8 种样式设置。 Web 端 飞书端 width string 否 default 按钮的宽度: • default:默认宽度策略(根据渲染环境不同会不同) • fill:填充父容器宽度 • Npx:指定宽度,100px, 200px 等,N 取值范围为 [100px, 不限制上限] size tiny | small | medium | large 否 medium 按钮的尺寸: • tiny:超小尺寸,PC 端为 24px;移动端为 28px • small:小尺寸,PC 端为 28px;移动端为 28px • medium:中尺寸,PC 端为 32px;移动端为 36px • large:大尺寸,PC 端为 40px;移动端为 48px action navigate | message 是 按钮点击后的行为: • navigate:跳转到指定的 url,需要配置 url 参数 • message:需要发送的消息,需要配置 message 参数 url string action 为 navigate 时必填 跳转到的 url 地址 urlMode default | raw 否 default URL 打开行为: • default:采用消息渠道特化的 URL 打开方式,如飞书中通过侧拉窗打开 URL • raw:使用本地浏览器(PC / Mobile)打开 URL message string 否 发送的消息内容 skill string 否 明确指定技能,不指定时智能识别(比用户指定技能的优先级更高) 形式如 skill mvkzddgxspaag(目前可以在对应技能页面 url 的最后一段来获取) 📌 技能需要是「开启状态」才能被调用 skillInput object 否 传递给调用技能的入参,与被调用技能开始节点的自定义参数定义一一对应。 Code block <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" skillInput={ "customParam": "hello" } 点击使用展示 title 的技能 </button 属性 属性 类型 类型 必填 必填 默认值 默认值 说明 说明 type type default | primary | danger | text | primaryFilled | dangerFilled | primaryText | dangerText default | primary | danger | text | primaryFilled | dangerFilled | primaryText | dangerText 否 否 default default 按钮的样式,支持 8 种样式设置。 Web 端 飞书端 按钮的样式,支持 8 种样式设置。 Web 端 飞书端 Web 端 Web 端 飞书端 飞书端 width width string string 否 否 default default 按钮的宽度: • default:默认宽度策略(根据渲染环境不同会不同) • fill:填充父容器宽度 • Npx:指定宽度,100px, 200px 等,N 取值范围为 [100px, 不限制上限] 按钮的宽度: • default:默认宽度策略(根据渲染环境不同会不同) • fill:填充父容器宽度 • Npx:指定宽度,100px, 200px 等,N 取值范围为 [100px, 不限制上限] size size tiny | small | medium | large tiny | small | medium | large 否 否 medium medium 按钮的尺寸: • tiny:超小尺寸,PC 端为 24px;移动端为 28px • small:小尺寸,PC 端为 28px;移动端为 28px • medium:中尺寸,PC 端为 32px;移动端为 36px • large:大尺寸,PC 端为 40px;移动端为 48px 按钮的尺寸: • tiny:超小尺寸,PC 端为 24px;移动端为 28px • small:小尺寸,PC 端为 28px;移动端为 28px • medium:中尺寸,PC 端为 32px;移动端为 36px • large:大尺寸,PC 端为 40px;移动端为 48px action action navigate | message navigate | message 是 是 按钮点击后的行为: • navigate:跳转到指定的 url,需要配置 url 参数 • message:需要发送的消息,需要配置 message 参数 按钮点击后的行为: • navigate:跳转到指定的 url,需要配置 url 参数 • message:需要发送的消息,需要配置 message 参数 url url string string action 为 navigate 时必填 action 为 navigate 时必填 跳转到的 url 地址 跳转到的 url 地址 urlMode urlMode default | raw default | raw 否 否 default default URL 打开行为: • default:采用消息渠道特化的 URL 打开方式,如飞书中通过侧拉窗打开 URL • raw:使用本地浏览器(PC / Mobile)打开 URL URL 打开行为: • default:采用消息渠道特化的 URL 打开方式,如飞书中通过侧拉窗打开 URL • raw:使用本地浏览器(PC / Mobile)打开 URL message message string string 否 否 发送的消息内容 发送的消息内容 skill skill string string 否 否 明确指定技能,不指定时智能识别(比用户指定技能的优先级更高) 形式如 skill mvkzddgxspaag(目前可以在对应技能页面 url 的最后一段来获取) 📌 技能需要是「开启状态」才能被调用 明确指定技能,不指定时智能识别(比用户指定技能的优先级更高) 形式如 skill mvkzddgxspaag(目前可以在对应技能页面 url 的最后一段来获取) 📌 技能需要是「开启状态」才能被调用 技能需要是「开启状态」才能被调用 skillInput skillInput object object 否 否 传递给调用技能的入参,与被调用技能开始节点的自定义参数定义一一对应。 Code block <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" skillInput={ "customParam": "hello" } 点击使用展示 title 的技能 </button 传递给调用技能的入参,与被调用技能开始节点的自定义参数定义一一对应。 Code block <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" skillInput={ "customParam": "hello" } 点击使用展示 title 的技能 </button Code block <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" skillInput={ "customParam": "hello" } 点击使用展示 title 的技能 </button 注意事项 1. 暂不支持一行展示多个按钮,如有需要请暂时用多栏布局模拟 Code block HTML <row <col flex=1 <button type="primary" width="default" action="navigate" url="https://www.feishu.cn" 跳转到飞书官网 </button </col <col flex=1 <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" 点击使用展示 title 的技能 </button </col </row Code block HTML <row <col flex=1 <button type="primary" width="default" action="navigate" url="https://www.feishu.cn" 跳转到飞书官网 </button </col <col flex=1 <button type="primary" width="default" action="message" message="hello" skill="skill 583728f942b7" 点击使用展示 title 的技能 </button </col </row