LogoMkSaaS Docs

Components

Learn about the components available in MkSaaS and how to use them effectively

MkSaaS includes a comprehensive collection of UI components organized into different categories. The components are carefully structured to maintain consistency, and ease of updates.

Component Structure

The components in MkSaaS are organized into several key directories:

Shadcn/ui Components

Located in the src/components/ui directory, these are the foundational components from shadcn/ui. This directory contains base components that serve as building blocks for your application.

  • Do not modify components in the src/components/ui directory.
  • These components are regularly synchronized with the official shadcn/ui releases.
  • Any modifications may cause conflicts during sync your codebase with the template.
  • The src/components/ui directory is excluded from Biome linting and formatting.

Available Components

The src/components/ui directory includes:

CategoryComponentsDescription
FormInputText input field
TextareaMulti-line text input
SelectDropdown selection
CheckboxSingle checkbox input
Radio GroupRadio button group
SwitchToggle switch
FormForm validation and handling
Input OTPOne-time password input
DialogDialogModal dialog
Alert DialogAlert confirmation
SheetSlide-out dialog
DrawerSlide-out panel
PopoverFloating content
Hover CardHover content card
NavigationTabsTabbed interface
Navigation MenuNavigation menu
BreadcrumbBreadcrumb navigation
MenubarMenu bar navigation
PaginationPage navigation
Data DisplayTableData table
CardContent card
CalendarDate picker
CarouselImage carousel
AvatarUser avatar
BadgeStatus badge
LayoutAccordionCollapsible sections
CollapsibleToggle content
SeparatorVisual separator
Aspect RatioMaintain aspect ratio
Scroll AreaCustom scrollbar
ResizableResizable panels
FeedbackAlertStatus alert
ProgressProgress indicator
SkeletonLoading placeholder
ToastToast notification
SonnerToast manager
CommandCommand palette

Magic UI Components

The src/components/magicui directory contains specialized UI components with advanced animations and interactions.

  • Do not modify components in the src/components/magicui directory.
  • These components are regularly synchronized with the official magicui releases.
  • Avoid modifying these components as they are synchronized with official updates.
  • The src/components/magicui directory is excluded from Biome linting and formatting.

Available Components

The src/components/magicui directory includes:

CategoryComponentsDescription
Text EffectsAnimated Gradient TextText with animated gradient
Morphing TextText morphing animation
Sparkles TextText with sparkle effects
Word RotateRotating word animation
Hyper TextInteractive text effects
Flip TextText flip animation
Typing AnimationTypewriter effect
Interactive ElementsAnimated BeamAnimated beam effect
Border BeamBorder animation
Pulsating ButtonButton with pulse effect
Shimmer ButtonButton with shimmer
Rainbow ButtonRainbow effect button
Ripple ButtonButton with ripple
Shiny ButtonButton with shine
Layout ComponentsMagic CardInteractive card
Animated Grid PatternAnimated grid background
Bento GridBento box layout
MarqueeScrolling content
Hero Video DialogVideo modal
Box RevealReveal animation
Special EffectsConfettiConfetti animation
MeteorsMeteor effect
Blur FadeBlur transition
RippleRipple effect
Dot PatternDot background
Grid PatternGrid background

Tailark Marketing Blocks

Tailark marketing blocks are split between the src/app/[locale]/preview and src/components/tailark directories.

  • Do not modify components in the src/app/[locale]/preview and src/components/tailark directories.
  • These components are regularly synchronized with the official tailark releases.
  • Avoid modifying these components as they are synchronized with official updates.
  • The src/app/[locale]/preview and src/components/tailark directories are excluded from Biome linting and formatting.

Available Blocks

The Tailark directories include:

CategoryDescription
Hero SectionsEngaging, attention-grabbing page headers
Logo CloudDisplay partner or client logos
FeaturesHighlight your product's key capabilities
IntegrationsShowcase third-party integrations
ContentGeneral content display sections
StatsDisplay important metrics and statistics
TeamPresent your team members
TestimonialsDisplay customer reviews and testimonials
Call-to-actionEncourage user actions
FooterPage footers with links and information
PricingShowcase your pricing plans
ComparatorCompare different product features or plans
FAQsAnswer common questions
LoginLogin related components
Sign-upSign-up related components
Forgot PasswordPassword recovery interfaces
ContactContact forms and information

Business Components

Business-specific components are organized in dedicated directories under src/components. Each module has its own directory:

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

Adding Custom Components

When adding new components to your project:

  1. Choose the Right Location: Place components in the appropriate business module directory
  2. Follow Naming Conventions: Use descriptive, PascalCase names for components
  3. Maintain Consistency: Follow the existing component structure and patterns

Example of adding a new component:

// 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>
  )
}

References

Next Steps

Now that you understand how to use components in MkSaaS, you might want to explore these related topics:

Table of Contents