mdxui

Reference

Type definitions, API reference, and component mappings

Reference

Complete reference documentation for mdxui types, interfaces, and component mappings.

Interfaces

Complete interface documentation:

Props Reference

Comprehensive props documentation for all types:

Mappings

Documentation for implementation packages:

  • Landing - @mdxui/beacon component mapping
  • Dashboards - @mdxui/cockpit component mapping
  • Gaps - Missing components and planned features

Package Exports

// Main exports
import type { SiteComponents, AppComponents } from 'mdxui'
import type { HeroProps, DashboardProps } from 'mdxui'

// Subpath exports
import type { SiteComponents } from 'mdxui/site'
import type { AppComponents } from 'mdxui/app'

// Zod schemas
import { HeroPropsSchema, DashboardPropsSchema } from 'mdxui/zod'

// Auto-wiring helpers
import { siteAutoWiring, appAutoWiring } from 'mdxui'

On this page