Your next page is taking shape...

Opening Your Next Page…

Loading the guide and preparing its examples for you to explore. The page will appear here automatically when it’s ready, so you can keep this view open without refreshing.

Made for Preact. Built to be yours.

Composition & Layout

Prose

Prose applies typographic defaults for rich text content. Build a clear hierarchy with reusable structure, consistent spacing and semantic surfaces. Keep layout decisions close to the content they organize. Import it from @/components/kamod-ui/prose.

Source · API reference · Theming · Styles


Interactive Live Preview
Try it. Make it yours.
Setting the scene...

Interactive preview

Live Preact example Local preview theme · Responsive styles follow the preview widthFull width

Installation

Import Prose from @/components/kamod-ui/prose.

Install PackagesTerminal
pnpm add @kamod-ch/ui

Copy an example with @kamod-ch/ui or the matching @kamod-ch/ui/… subpath. The code block switches between those two installs. Connect The Global Theme CSS and Tailwind Source Detection before your first render.

Usage

Wrap markdown or article-like HTML in Prose for readable typography.

Import SetupTypeScript
import { Prose } from "@kamod-ch/ui";

Choose a complete composition from the examples below; required child components and props vary by pattern.

Component Examples & Variants

Explore Prose in Different Contexts, from the starting pattern to the compositions below. Begin with Article Prose, then compare the examples that match your content, state and layout. These are working patterns to adapt, not a list of interchangeable variant values: check the API Reference before using a prop or combining behaviors. Look at the surrounding labels, supporting text and spacing as well as the component itself.

Read the Result and Its Implementation Together. Use each showcase’s Code view to inspect imports and composition, or its Prompt view to prepare a setup or adaptation brief. Try the narrow preview and local theme controls before connecting real data, and use Reset to return an example to its initial state. Keep layout changes in class utilities where appropriate; follow the Component Styles Guide for hierarchy and the Theming Guide for shared surfaces and colors. The Accessibility Notes explain what to preserve when making those changes.

Article Prose

Give Long-Form Content a Consistent Reading Rhythm. Wrap article content in Prose to coordinate headings, paragraphs and lists as a reading surface. Semantic HTML provides the document structure, while the typography treatment gives those elements a consistent visual rhythm.

Use meaningful heading levels and real list markup, and inspect links and inline code alongside ordinary text before applying the surface to generated or user-authored content.

src/components/ProseExample.tsx9 lines
import { Prose } from "@kamod-ch/ui";

export const Example = () => (
  <Prose class="max-w-2xl">
    <h2>Documentation heading</h2>
    <p>Readable paragraph styles with sensible defaults.</p>
    <ul><li>First point</li><li>Second point</li></ul>
  </Prose>
);

Narrow Prose

Control Line Length as Well as Font Size. Constrain the prose container's width when the page is primarily intended for reading. Shorter line lengths can make dense explanations easier to follow without changing their heading hierarchy or introducing separate surfaces around every paragraph.

Keep code blocks and tables usable within that width, and check how nested lists and longer links wrap at the smallest supported viewport.

Interactive Live Preview
Try it. Make it yours.
Setting the scene...

Interactive preview

Live Preact example Local preview theme · Responsive styles follow the preview widthFull width
API reference

Props and Data

Configure Prose using the contracts below. Read the documented options alongside the Source Definitions to understand which values your application supplies and which details the component owns. Start with a prop or helper, then follow its type link to inspect the declaration without leaving the page.

Props, slots and variants for this component.

API reference
Your API, from source

Type cards are extracted from this checkout’s TypeScript source at build time. Props inherited through HTMLAttributes, Omit or variant helpers remain references in those declarations; their fields are not flattened here. Match the reference to your installed version, and check a package’s exports before writing an import type. A type exported by a source file is not necessarily re-exported by @kamod-ch/ui.

Component Props

Read each option with its owning component. The
marker identifies required fields verified in that declaration. A ? means a field can be omitted; it does not promise a fallback value. Existing documented defaults remain alongside the descriptions. For callbacks, check the argument and return types before connecting your own state or services.
@kamod-ch/ui/prose0.8 KB min · 0.4 KB gzipSignals: none

Prose

ProseProps

Prose documented props
Prop / typeDescription
children
ComponentChild[] | ComponentChildProseProps

Configure children for Prose. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—
class
string | SignalLike<string | undefined>ProseProps

Configure class for Prose. Compare its accepted type with the Usage Guidance before supplying a value.

Default
—

Data Type Reference

Expand a card to inspect and copy the exact declaration. The code header identifies its repository file; follow imported or inherited types in the Implementation Source when you need the complete dependency chain. Required-field summaries cover fields declared directly in that type. Source-only helpers and inferred schema outputs describe the local implementation, not additional props you can pass to every component.

Prose Props

1 declared field
ProseProps
Exported Source Declaration from Prose.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of ProseProps before adapting it.

Accessibility

Prose styles authored document content. It does not repair incorrect heading levels, missing image alternatives, malformed lists or inaccessible embedded components. The markup you place inside remains the semantic source of truth.

Take the Next Useful Step

You have the pieces. Put them into one real interaction, keep its state in one place, and check the result with the content your application will actually show.

Connect the Foundation

Return to Choose and Compose Components to connect this reference to a working screen. Keep global CSS in one entrypoint and import only the components that screen needs.

Build the Surrounding Screen

Find a neighboring interaction in the Component Library, or start with a complete Block. Replace sample content and destinations before refining the layout; a local class change can stay with the composition.

Make the Result Hold Up

Use shared theme roles for changes that belong everywhere. Then review the whole journey: keyboard focus, long labels, narrow screens and a clear way to recover when something fails.

Keep a link to the source and note your intentional changes. Your next edit should begin with a clear decision, not another search.