Search field
v0.0.10
v0.0.10StableComponentStatelessApache-2.0
Installation
mix mishka.ui.gen.component search_field
Source
View Source
Search component
Search component
The search_field component renders an <input type="search">, made for search queries. Browsers add features to this input type, such as a clear button that resets the search term.
Search component
heex
<.search_field
name=""
value=""
label="Search"
placeholder="What do you have in mind"
/>Attributes
| Name | Type | Default | Values | Required | Description |
|---|---|---|---|---|---|
id
|
string
| — | — | No | A unique identifier is used to manage state and interaction |
class
|
any
| — | — | No | Custom CSS class for additional styling |
color
|
string
|
natural
|
basenaturalwhiteprimarysecondarydarksuccesswarningdangerinfomiscdawnsilver
| No | Determines color theme |
border
|
string
|
extra_small
| — | No | Determines border style |
rounded
|
string
|
small
|
extra_smallsmallmediumlargeextra_largefullnone
| No | Determines the border radius |
variant
|
string
|
base
|
outlinedefaultshadowborderedtransparentbase
| No | Determines the style |
description
|
string
| — | — | No | Determines a short description |
space
|
string
|
medium
|
extra_smallsmallmediumlargeextra_largenone
| No | Space between items |
placeholder
|
string
| — | — | No | Specifies text for placeholder |
description_class
|
string
|
text-[12px]
| — | No | Custom classes for description |
label_class
|
string
| — | — | No | Custom CSS class for the label styling |
field_wrapper_class
|
string
| — | — | No | Custom CSS class field wrapper |
input_class
|
string
| — | — | No | Custom CSS class for the input |
search_button_class
|
string
| — | — | No | Custom CSS class for the show password |
floating_label_class
|
string
| — | — | No | Custom CSS class for the floating label |
description_wrapper_class
|
string
| — | — | No | Custom classes for description wrapper |
size
|
string
|
extra_large
|
extra_smallsmallmediumlargeextra_large
| No | Determines the overall size of the elements, including padding, font size, and other items |
ring
|
boolean
|
true
| — | No | Determines a ring border on focused input, utilities for creating outline rings with box-shadows. |
search_button
|
boolean
|
false
| — | No | Specifies search button |
floating
|
string
|
none
| — | No | none, inner, outer |
error_icon
|
string
| — | — | No | Icon to be displayed alongside error messages |
label
|
string
| — | — | No | Specifies text for the label |
errors
|
list
|
[]
| — | No | List of error messages to be displayed |
name
|
any
| — | — | No | Name of input |
value
|
any
| — | — | No | Value of input |
field
|
Phoenix.HTML.FormField
| — | — | No | a form field struct retrieved from the form |
rest
|
global
| — | — | No | Global attributes can define defaults which are merged with attributes provided by the caller |
Slots
| Name | Required | Description |
|---|---|---|
start_section
| No | Renders heex content in start of an element |
end_section
| No | Renders heex content in end of an element |
Attributes of the start_section slot
| Name | Type | Default | Values | Required | Description |
|---|---|---|---|---|---|
class
|
any
| — | — | No | Custom CSS class for additional styling |
icon
|
string
| — | — | No | Icon displayed alongside of an item |
Attributes of the end_section slot
| Name | Type | Default | Values | Required | Description |
|---|---|---|---|---|---|
class
|
any
| — | — | No | Custom CSS class for additional styling |
icon
|
string
| — | — | No | Icon displayed alongside of an item |
Options
Each option takes one or more of its values, separated by commas.
| Option | Values |
|---|---|
--variant
|
outlinedefaultshadowborderedtransparentbase
|
--color
|
basenaturalwhiteprimarysecondarydarksuccesswarningdangerinfomiscdawnsilver
|
--size
|
extra_smallsmallmediumlargeextra_large
|
--rounded
|
extra_smallsmallmediumlargeextra_largefullnone
|
--space
|
extra_smallsmallmediumlargeextra_largenone
|
--module
| A module name of your own |
What it generates
Functions
search_field
Helpers
None
Generated with it
icon
Command
mix mishka.ui.gen.component search_field