Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Web docs
Forms

SearchField

Captures search queries with native search semantics.

FrameworksAstro · React · Elements

Registry commandlumen add SearchField

InteractionNative markup

01

See it and copy it

Framework example

Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.

AstroSame visual contract, native framework API
CmdK

Framework usage

Switch targets to compare the adapter code. The preview stays visually stable because all three packages share the same tokens and ui-* class contract.
astro
---
import { Icon, InputGroup, Kbd, SearchField } from '@santi020k/lumen-astro'
---

<InputGroup>
  <Icon name="search" decorative />
  <SearchField name="q" placeholder="Search docs" />
  <div class="pointer-events-none flex items-center gap-1 px-2 opacity-50">
    <Kbd>Cmd</Kbd>
    <Kbd>K</Kbd>
  </div>
</InputGroup>
Edit SearchField in browser
02

Choose your target

Add this component

Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.

bash@santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
bashAstro wrapper
lumen add SearchField
lumen add SearchField

API reference

Lumen-specific props and runtime attributes for the Astro primitive. React props follow the same names; Elements use equivalent kebab-case attributes where custom elements expose them.

AttributeValuesDefaultDescription
typeHTML input type"search"Sets the native input type.
class, classNamestring""Merges custom classes with the generated ui-* root classes.
...native attributesHTML attributes-Forwards standard attributes to the root element unless the component consumes them.

Web docsFull catalog