Skip to content

Commit

Permalink
DST-628: start revising
Browse files Browse the repository at this point in the history
  • Loading branch information
aromko committed Dec 20, 2024
1 parent d52e52f commit f6bbaa7
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions docs/content/components/form/search-field/search-field.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,43 @@
---
title: SearchField
caption: Component which allows user to enter and clear a search query.
badge: updated
---

The `<SearchField>` component is a versatile UI element that enables users to search for specific information within a given context or data set. It offers a user-friendly input field specifically designed for search queries, often accompanied by a search icon or button to initiate the search action.

`<SearchField>` consists of an input element, a label, and an optional clear button. `<SearchField>` automatically manages the labeling and relationships between the elements, and handles keyboard events. Users can press the Escape key to clear the `<SearchField>`, or the Enter key to trigger the `onSubmit` event.

## Import
## Anatomy

```tsx
import { SearchField } from '@marigold/components';
```
A table is composed of a container element that organizes data into rows and columns. Each cell within the table can hold either plain text or focusable elements. If the table allows multiple row selection, the first column of each row include a checkbox for selecting that row and the first column header will contain a "select all" checkbox.

<Image
src="/table/table-anatomy.jpg"
alt="Anatomy of table"
width={800}
height={550}
className="mx-auto block"
/>

## Appearance

<AppearanceDemo component={title} />

<AppearanceTable component={title} />

## Usage

## Props

<StorybookHintMessage component={title} />

<PropsTable component={title} />

## Alternative components

## Related

## Examples

### Simple Search Field
Expand Down

0 comments on commit f6bbaa7

Please sign in to comment.