searchfield 0.2.0 copy "searchfield: ^0.2.0" to clipboard
searchfield: ^0.2.0 copied to clipboard

outdated

A new Flutter package project.

SearchField: ^0.2.0 #

A highly customizable simple and easy to use flutter Widget to add a searchfield to your Flutter Application.This Widget allows you to search and select from list of suggestions.

Think of this widget like a dropdownButton field with an ability

  • to Search 🔍.
  • to define height of each Suggestion Item
  • to define max number of items visible in the viewport 📱
  • to completely customize the input searchfield like a normal textfield
  • to customize the suggestions with colors and gradients

list of all the properties mentioned below

Getting Started #

Installation #

  • Add the dependency
dependencies:
  searchfield: ^0.2.0
  • Import the package
import 'package:searchfield/searchfield.dart';

Use the Widget

Example1

 SearchField(
    suggestions: [
    'United States',
    'America',
    'Washington',
    'India',
    'Paris',
    'Jakarta',
    'Australia',
    'Lorem Ipsum'
    ],
),

Example2

SearchField(
   suggestions: _suggestions,
   hint: 'SearchField Sample 2',
   searchStyle: 
          TextStyle(
             fontSize: 18, color: Colors.black.withOpacity(0.8)),
   searchInputDecoration: 
          InputDecoration(
             focusedBorder: OutlineInputBorder(
             borderSide: BorderSide(color: Colors.black.withOpacity(0.8)),
          ),
             border: OutlineInputBorder(
             borderSide: BorderSide(color: Colors.red),
         )),
   maxSuggestionsInViewPort: 6,
   itemHeight: 50,
   onTap: (x) {print(x);},
   )

Properties #

  • suggestions : list of Strings to search from.(Mandatory)
  • initialValue : The initial value to be set in searchfield when its rendered, if not specified it will be empty.
  • onTap : callback when a sugestion is tapped it also returns the tapped value.
  • hint : hint for the search Input.
  • searchStyle : textStyle for the search Input.
  • suggestionStyle : textStyle for the SuggestionItem.
  • searchInputDecoration : decoration for the search Input similar to built in textfield widget.
  • suggestionsDecoration : decoration for suggestions List with ability to add box shadow background color and much more.
  • ```suggestionItemDecoration`` : decoration for suggestionItem with ability to add color and gradient in the background.
  • itemHeight : height of each suggestion Item, (defaults to 35.0).
  • marginColor : Color for the margin between the suggestions.
  • maxSuggestionsInViewPort : The max number of suggestions that can be shown in a viewport.

Contributing #

You are welcome to contribute to this package,contribution doesnt necessarily mean sending a pull request it could be

  • pointing out bugs/issues
  • requesting a new feature
  • improving the documentation

If you feel generous and confident send a PR but make sure theres an open issue if not feel free to create one before you send a PR. This helps Identify the problem and helps everyone to stay aligned with the issue :)