LogoMkSaaS文档

组件

了解 MkSaaS 中可用的组件以及如何有效使用它们

MkSaaS 包含一个全面的 UI 组件集合,组织成不同的类别。这些组件经过精心构建,以保持一致性和易于更新。

组件结构

MkSaaS 中的组件组织在几个关键目录中:

Shadcn/ui 组件

位于 src/components/ui 目录中,都是 Shadcn/ui 的基础组件。此目录包含作为应用程序构建块的基础组件。

  • 不要修改 src/components/ui 目录中的组件。
  • 这些组件定期与官方 shadcn/ui 发布版本同步。
  • 任何修改可能会在与模板同步代码库时导致冲突。
  • src/components/ui 目录被排除在 Biome 代码检查和格式化之外。

可用组件

src/components/ui 目录包括:

类别组件描述
表单Input文本输入字段
Textarea多行文本输入
Select下拉选择
Checkbox单个复选框输入
Radio Group单选按钮组
Switch切换开关
Form表单验证和处理
Input OTP一次性密码输入
对话框Dialog模态对话框
Alert Dialog警告确认
Sheet滑出对话框
Drawer滑出面板
Popover浮动内容
Hover Card悬停内容卡片
导航Tabs选项卡界面
Navigation Menu导航菜单
Breadcrumb面包屑导航
Menubar菜单栏导航
Pagination页面导航
数据显示Table数据表格
Card内容卡片
Calendar日期选择器
Carousel图片轮播
Avatar用户头像
Badge状态徽章
布局Accordion可折叠部分
Collapsible切换内容
Separator视觉分隔符
Aspect Ratio保持宽高比
Scroll Area自定义滚动条
Resizable可调整大小的面板
反馈Alert状态警告
Progress进度指示器
Skeleton加载占位符
Toast提示通知
Sonner提示管理器
Command命令面板

Shadcn/ui Components

Magic UI 组件

src/components/magicui 目录包含具有高级动画和交互的专业 UI 组件,都是 Magic UI 的组件。

  • 不要修改 src/components/magicui 目录中的组件。
  • 这些组件定期与官方 magicui 发布版本同步。
  • 避免修改这些组件,因为它们与官方更新同步。
  • src/components/magicui 目录被排除在 Biome 代码检查和格式化之外。

可用组件

src/components/magicui 目录包括:

类别组件描述
文本效果Animated Gradient Text带动画渐变的文本
Morphing Text文本变形动画
Sparkles Text带闪烁效果的文本
Word Rotate旋转单词动画
Hyper Text交互式文本效果
Flip Text文本翻转动画
Typing Animation打字机效果
交互元素Animated Beam动画光束效果
Border Beam边框动画
Pulsating Button带脉冲效果的按钮
Shimmer Button带闪烁的按钮
Rainbow Button彩虹效果按钮
Ripple Button带涟漪的按钮
Shiny Button带光泽的按钮
布局组件Magic Card交互式卡片
Animated Grid Pattern动画网格背景
Bento Grid便当盒布局
Marquee滚动内容
Hero Video Dialog视频模态
Box Reveal揭示动画
特殊效果Confetti五彩纸屑动画
Meteors流星效果
Blur Fade模糊过渡
Ripple涟漪效果
Dot Pattern点状背景
Grid Pattern网格背景

您可以在 Magic UI 组件 页面中找到嵌入在 MkSaaS 模板中的一些 Magic UI 组件。

Magic UI Blocks

Animate UI 组件

src/components/animate-ui 目录包含为现代动态界面设计的动画 UI 组件集合。这些组件是模块化的,可用于增强应用程序的交互性和视觉吸引力。

  • 不要修改 src/components/animate-ui 目录中的组件。
  • 这些组件定期与官方 Animate UI 发布版本同步。
  • 避免修改这些组件,因为它们与官方更新同步。
  • src/components/animate-ui 目录被排除在 Biome 代码检查和格式化之外。

可用组件

src/components/animate-ui 目录包括:

类别组件描述
文本动画Typing Text打字机风格的动画文本
Writing Text手写动画效果
Counting Number动画数字计数效果
Gradient Text带动画渐变的文本
Highlight Text动画文本高亮效果
Sliding Number数字滑动动画
UI 元素Playful Todolist动画交互式待办事项列表
按钮Ripple Button带涟漪动画的按钮
Copy Button带复制到剪贴板动画的按钮
Flip Button带翻转动画的按钮
GitHub Stars Button动画 GitHub 星标按钮
Icon Button动画图标按钮
Liquid Button带液体动画效果的按钮
效果Motion Effect通用运动效果包装器
Motion Highlight交互元素的运动高亮效果
组件Code Editor动画代码编辑器组件
Radix UICheckbox基于 Radix UI 的动画复选框
背景Hexagon Background动画六边形背景
Hole Background动画洞穴背景效果
Stars Background动画星空背景
Bubble Background动画气泡背景
Gradient Background动画渐变背景
基础Progress动画进度指示器

Tailark 营销组件

Tailark 营销组件位于 src/components/tailark 目录中。

  • 不要修改 src/components/tailark 目录中的组件。
  • 这些组件定期与官方 Tailark 发布版本同步。
  • 避免修改这些组件,因为它们与官方更新同步。
  • src/components/tailark 目录被排除在 Biome 代码检查和格式化之外。

可用组件

Tailark 目录包括:

类别描述
Hero引人注目的页面标题
Logo 云显示合作伙伴或客户 logo
功能突出您产品的关键功能
集成展示第三方集成
内容通用内容显示部分
统计显示重要指标和统计数据
团队展示您的团队成员
推荐显示客户评价和推荐
CTA鼓励用户行动
页脚带链接和信息的页脚
定价展示您的定价计划
比较器比较不同的产品功能或计划
常见问题回答常见问题
登录登录相关组件
注册注册相关组件
忘记密码密码恢复界面
联系联系表单和信息

您可以在 Tailark 组件 页面中找到所有内置在模板中的组件,并且可以在组件预览的右上角获取组件文件路径。

Tailark Blocks

业务组件

业务特定组件放在 src/components 下的专用目录中,每个模块都有自己的目录:

login-form.tsx
register-form.tsx
auth-card.tsx

添加自定义组件

向项目添加新组件时:

  1. 选择正确的位置:将组件放在适当的业务模块目录中
  2. 遵循命名约定:为组件使用描述性的 PascalCase 名称
  3. 保持一致性:遵循现有的组件结构和模式

添加新组件的示例:

// src/components/dashboard/AnalyticsChart.tsx
import { Card } from "@/components/ui/card"
import { Chart } from "@/components/ui/chart"

export function AnalyticsChart() {
  return (
    <Card>
      <Chart data={...} />
    </Card>
  )
}

参考

视频教程

下一步

现在您了解了如何在 MkSaaS 中使用组件,您可能想要探索这些相关主题: