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:
Category | Components | Description |
---|---|---|
Form | Input | Text input field |
Textarea | Multi-line text input | |
Select | Dropdown selection | |
Checkbox | Single checkbox input | |
Radio Group | Radio button group | |
Switch | Toggle switch | |
Form | Form validation and handling | |
Input OTP | One-time password input | |
Dialog | Dialog | Modal dialog |
Alert Dialog | Alert confirmation | |
Sheet | Slide-out dialog | |
Drawer | Slide-out panel | |
Popover | Floating content | |
Hover Card | Hover content card | |
Navigation | Tabs | Tabbed interface |
Navigation Menu | Navigation menu | |
Breadcrumb | Breadcrumb navigation | |
Menubar | Menu bar navigation | |
Pagination | Page navigation | |
Data Display | Table | Data table |
Card | Content card | |
Calendar | Date picker | |
Carousel | Image carousel | |
Avatar | User avatar | |
Badge | Status badge | |
Layout | Accordion | Collapsible sections |
Collapsible | Toggle content | |
Separator | Visual separator | |
Aspect Ratio | Maintain aspect ratio | |
Scroll Area | Custom scrollbar | |
Resizable | Resizable panels | |
Feedback | Alert | Status alert |
Progress | Progress indicator | |
Skeleton | Loading placeholder | |
Toast | Toast notification | |
Sonner | Toast manager | |
Command | Command 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:
Category | Components | Description |
---|---|---|
Text Effects | Animated Gradient Text | Text with animated gradient |
Morphing Text | Text morphing animation | |
Sparkles Text | Text with sparkle effects | |
Word Rotate | Rotating word animation | |
Hyper Text | Interactive text effects | |
Flip Text | Text flip animation | |
Typing Animation | Typewriter effect | |
Interactive Elements | Animated Beam | Animated beam effect |
Border Beam | Border animation | |
Pulsating Button | Button with pulse effect | |
Shimmer Button | Button with shimmer | |
Rainbow Button | Rainbow effect button | |
Ripple Button | Button with ripple | |
Shiny Button | Button with shine | |
Layout Components | Magic Card | Interactive card |
Animated Grid Pattern | Animated grid background | |
Bento Grid | Bento box layout | |
Marquee | Scrolling content | |
Hero Video Dialog | Video modal | |
Box Reveal | Reveal animation | |
Special Effects | Confetti | Confetti animation |
Meteors | Meteor effect | |
Blur Fade | Blur transition | |
Ripple | Ripple effect | |
Dot Pattern | Dot background | |
Grid Pattern | Grid 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
andsrc/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
andsrc/components/tailark
directories are excluded from Biome linting and formatting.
Available Blocks
The Tailark directories include:
Category | Description |
---|---|
Hero Sections | Engaging, attention-grabbing page headers |
Logo Cloud | Display partner or client logos |
Features | Highlight your product's key capabilities |
Integrations | Showcase third-party integrations |
Content | General content display sections |
Stats | Display important metrics and statistics |
Team | Present your team members |
Testimonials | Display customer reviews and testimonials |
Call-to-action | Encourage user actions |
Footer | Page footers with links and information |
Pricing | Showcase your pricing plans |
Comparator | Compare different product features or plans |
FAQs | Answer common questions |
Login | Login related components |
Sign-up | Sign-up related components |
Forgot Password | Password recovery interfaces |
Contact | Contact forms and information |
Business Components
Business-specific components are organized in dedicated directories under src/components
. Each module has its own directory:
Adding Custom Components
When adding new components to your project:
- Choose the Right Location: Place components in the appropriate business module directory
- Follow Naming Conventions: Use descriptive, PascalCase names for components
- Maintain Consistency: Follow the existing component structure and patterns
Example of adding a new component:
References
Next Steps
Now that you understand how to use components in MkSaaS, you might want to explore these related topics: