Package Exports
- @mdxui/beacon
- @mdxui/beacon/animated-hero
- @mdxui/beacon/components
- @mdxui/beacon/dynamic-island
- @mdxui/beacon/landing-page
- @mdxui/beacon/marquee
- @mdxui/beacon/shared
- @mdxui/beacon/sticky-scroll
- @mdxui/beacon/templates
Readme
@mdxui/beacon
Site template components for mdxui - landing pages, hero sections, and marketing components.
Installation
npm install @mdxui/beacon @mdxui/primitives
# or
pnpm add @mdxui/beacon @mdxui/primitivesQuick Start
import { Site, Hero, Features, Pricing, FAQs } from '@mdxui/beacon'
export default function LandingPage() {
return (
<Site
logo={<Logo />}
header={{
links: [
{ label: 'Features', href: '#features' },
{ label: 'Pricing', href: '#pricing' },
],
primaryCta: 'Get Started',
}}
hero={{
title: 'Build faster with',
highlightedText: 'mdxui',
description: 'Production-ready components for your next project.',
primaryButtonText: 'Get Started',
primaryButtonHref: '/signup',
}}
features={{
items: [
{ iconName: 'Zap', title: 'Fast', description: 'Lightning fast performance.' },
{ iconName: 'Shield', title: 'Secure', description: 'Built with security in mind.' },
],
}}
pricing={{
title: 'Simple Pricing',
description: 'Choose the plan that works for you.',
tiers: [
{ name: 'Free', price: '$0', features: ['Basic features'] },
{ name: 'Pro', price: '$29', features: ['All features', 'Priority support'] },
],
}}
footer={{
companyName: 'Your Company',
description: 'Building the future.',
}}
/>
)
}Components
Layout Components
Site/LandingPage- Full landing page wrapperLandingLayout- Layout with header/footerHeader- Navigation headerFooter- Site footer
Hero Variants
Hero- Default hero sectionHeroCentered- Centered text heroHeroAnimated- Animated hero with effectsHeroGradient- Gradient background heroHeroImageBeside- Hero with side imageHeroVideoBelow- Hero with video belowHeroCodeBelow- Hero with code snippet
Section Components
Features- Feature grid/listPricing- Pricing tableFAQs- Accordion FAQ sectionTestimonials- Customer testimonialsStats- Statistics displayCTA- Call-to-action sectionLogoCloud- Partner/client logosFeatureGrid- Grid of feature cardsDirectory- Directory listing
Animation Components
Marquee- Infinite scroll marqueeStickyScroll- Scroll-triggered revealsDynamicIsland- iOS-style dynamic islandNotificationIsland- Notification popups
Shared Utilities
Highlighter- Syntax highlightingCodeTabs- Tabbed code blocksTerminal- Terminal displayHatch- Background pattern
Peer Dependencies
react^18.0.0 || ^19.0.0@mdxui/primitives- Required for base UI components
Links
License
MIT