mdxui.dev
npm7.0.0-alpha.0
Alpha: Ships on npm at 7.0.0-alpha.07.0.0-alpha.0

@mdxui/site exports

Every runtime export of @mdxui/site: its kind, what it does and its signature.

Every runtime export of @mdxui/site, read from the installed package and its type declarations.

33 runtime exports of @mdxui/site@7.0.0-alpha.0, read from the package and its index.d.ts.

ExportKindDoesSignature or type
BENTO_SPECIMENS3 valuesThe Section types a bento tile holdsreadonly ["terminal", "agent-prompt", "api-call"]
BLOCKSobject, 27 keysEvery Section type: its CSS and its renderer—
BlockSchemaZod schemaParses one Section type—
FEATURE_GRID_COUNTS5 valuesThe item counts feature-grid admitsreadonly [2, 3, 4, 6, 8]
HIGHLIGHT_LANGUAGES44 valuesEvery language a fence may namestring[]
NAV_ROW_BUDGETnumber, 96The units one nav row holds—
PageSchemaZod schemaParses a Page record—
SectionHeadSchemaZod schemaParses a section head—
SectionSchemaZod schemaParses one section—
baseCssCSS, 2 KBThe reset and body type—
blockTitlefunctionA plain title over a table or listblockTitle(title: string, opts?: { level?: 1 | 2; note?: string; }): string
blocksCssCSS, 68 KBEvery Section type, styled—
buttonIconfunctionA button glyph in the button inkbuttonIcon(ctx: RenderContext, name: IconName, kind: 'solid' | 'ghost' | 'invert'): string
composefunctionSections to a page body, dividers derivedcompose(c: Composition): string
contextfunctionThe render context for a Theme and a surfacecontext(theme: Theme, surface?: Surface, delivery?: IconDelivery): RenderContext
copyControlfunctionA copy button that needs no scriptcopyControl(ctx: RenderContext, label: string, o?: { from?: string; float?: boolean; }): string
dividerBetweenfunctionThe divider between two sectionsdividerBetween(prev: SectionSpec, next: SectionSpec, p: DividerPolicy): Divider
documentfunctionA body to a whole documentdocument(d: DocumentProps): string
escfunctionEscapes text for HTMLesc(text: string): string
findBlockfunctionThe first section of a type in a recordfindBlock(p: Page, type: Block['type']): Block | undefined
highlightfunctionCode to highlighted HTMLhighlight(lang: string | undefined, code: string): string
metaRowfunctionA tag and dateline rowmetaRow(m: { tag?: string; dateline?: Dateline; }, cls: string): string
navRowCostfunctionThe units a nav row costs—
pagefunctionThe page frame around every sectionpage(p: PageShell, sections: string): string
panelfunctionA painted panel around part of a sectionpanel(p: PanelShell, inner: string): string
primitivesCssCSS, 11 KBThe shared pieces every Section type uses—
renderBlockfunctionOne Section type to HTMLrenderBlock(b: Block, ctx: RenderContext): string
renderPagefunctionA Page record to one HTML documentrenderPage(p: Page, opts?: RenderOptions): string
renderSpecimenfunctionA specimen slot to HTMLrenderSpecimen(s: Specimen, ctx: RenderContext): string
resolveRolefunctionA role to its literal value on a surfaceresolveRole(theme: Theme, role: string, surface: Surface, seen?: Set<string>): string
sectionfunctionOne section shell around rendered HTMLsection(s: SectionShell, block: string, tag?: 'section' | 'header' | 'div'): string
sectionHeadfunctionA section head to HTMLsectionHead(h: SectionHead, ctx: RenderContext, opts?: { level?: 1 | 2; }): string
shellCssCSS, 7 KBThe shell, frame and dividers—