Skip to content

Commit 8f5d6f3

Browse files
committed
chore: updated readme
1 parent a0ca681 commit 8f5d6f3

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

elements/pf-search-input/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Search Input
2-
Add a description of the component here.
2+
A search input lets users type in words to find specific items or information. As they type, it can show matching results to help them quickly find what they are looking for.
33

44
## Usage
5-
Describe how best to use this web component along with best practices.
5+
A search input consists of a text field where users can type to find specific content or items. Unlike selects or dropdowns, which offer predefined options, a search input lets users enter their own keywords to filter or locate results. It includes a clear (×) button to easily remove the current input, allowing users to start a new search quickly.
66

77
```html
88
<pf-search-input>
9-
9+
<pf-option value="Alabama"> Alabama </pf-option>
10+
<pf-option value="New Jersey"> New Jersey </pf-option>
11+
<pf-option value="New York"> New York </pf-option>
12+
<pf-option value="New Mexico"> New Mexico </pf-option>
13+
<pf-option value="North Carolina"> North Carolina </pf-option>
1014
</pf-search-input>
1115
```

0 commit comments

Comments
 (0)