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.

Media & Presentation

Video

Video displays embedded media with browser-native controls. Give media a predictable place in the layout while keeping the surrounding content readable during loading, playback or failure. Import it from @/components/kamod-ui/video.

Source · Design reference · 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 Video from @/components/kamod-ui/video.

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

Use controls for playback affordance and provide fallback text where needed.

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

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

Component Examples & Variants

Explore Video in Different Contexts, from the starting pattern to the compositions below. Begin with Video with Source, 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.

Video with Source

Keep Playback under Understandable Controls. Supply a video source and keep native controls available when the reader should choose how to play the media. Reserve an appropriate frame and provide the surrounding title or description needed to understand what the video contains.

Test the media when loading fails and avoid depending on the video alone for essential instructions; nearby text should explain what viewers can expect to learn.

src/components/VideoExample.tsx7 lines
import { Video } from "@kamod-ch/ui";

export const Example = () => (
  <Video class="max-w-xl">
    <source src="https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4" type="video/mp4" />
  </Video>
);

Muted Preview

Use Automatic Playback Only as a Supplementary Preview. Use a muted autoplay preview for a visual gallery only when motion is supplementary to the item itself. Keep a useful static presentation available and avoid relying on the preview to communicate information that requires sound.

Consider motion preferences, offer an appropriate way to pause persistent movement and avoid downloading many large previews before users need them.

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 Video 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/video1.0 KB min · 0.5 KB gzipSignals: none

Video

VideoProps

Video documented props
Prop / typeDescription
children
ComponentChild[] | ComponentChildVideoProps

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

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

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

Default
—
controls
boolean | SignalLike<boolean | undefined>VideoProps

Configure controls for Video. Compare its accepted type with the Usage Guidance before supplying a value.

Default
true

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.

Video Props

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

Accessibility

Video renders a native video element with controls enabled by default and accepts children such as source and track. Captions and other alternatives are supplied by the application; the component does not generate them.

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.