outline_search_bar 1.0.0 outline_search_bar: ^1.0.0 copied to clipboard
This package allows you to create an outlined Material design search bar.
This package allows you to create an outlined Material design search bar.
Getting started #
To use this package, add outline_search_bar
as a dependency in your pubspec.yaml file. For example:
dependencies:
outline_search_bar: ^1.0.0
OutlineSearchBar #
Parameter | Description |
---|---|
textEditingController |
The keyword of OutlineSearchBar can be controlled with a TextEditingController . |
backgroundColor |
Set the color of OutlineSearchBar . Default value is Color(0xFFFEFEFE) |
borderColor |
Set the border color of OutlineSearchBar . If value is null and theme brightness is light, use primaryColor, if dark, use accentColor. |
borderWidth |
Set the border thickness of OutlineSearchBar . Default value is 1.0 |
borderRadius |
Set the border radius of OutlineSearchBar . Default value is BorderRadius.all(Radius.circular(4.0)) |
margin |
Set the margin value of OutlineSearchBar . Default value is EdgeInsets.only() |
padding |
Set the padding value of OutlineSearchBar . Default value is EdgeInsets.only(left: 10.0, right: 4.0) |
elevation |
Set the elevation of OutlineSearchBar . Default value is 0.0 |
initText |
Set the keyword to be initially entered. If initial text is set in textEditingController , this value is ignored. |
hintText |
Set the text to be displayed when the keyword is empty. |
textStyle |
Set the input text style. |
hintStyle |
Set the style of hintText . |
maxLength |
Set the maximum length of text to be entered. |
cursorColor |
Set the color of cursor. |
cursorWidth |
Set the width of cursor. Default value is 2.0 |
cursorHeight |
Set the height of cursor. |
cursorRadius |
Set the radius of cursor. |
clearButtonColor |
Set the background color of the clear button. Default value is Color(0xFFDDDDDD) |
clearButtonIconColor |
Set the icon color inside the clear button. Default value is Color(0xFFFEFEFE) |
searchButtonSplashColor |
Set the splash color that appears when the search button is pressed. |
searchButtonIconColor |
Set the icon color inside the search button. If value is null and theme brightness is light, use primaryColor, if dark, use accentColor. |
autoCorrect |
Whether to use autoCorrect option. Default value is false |
hideSearchButton |
Whether to hide the search button. Default value is false |
ignoreWhiteSpace |
Whether to ignore input of white space. Default value is false |
ignoreSpecialChar |
Whether to ignore input of special characters. Default value is false |
onKeywordChanged |
Called whenever a keyword is entered. |
onSearchButtonPressed |
When you press the search button, it is called with the entered keyword. |