search_field_dropdown 1.0.5%2B1

SDKflutter
Platformandroidioswindowslinuxmacos

A customizable dropdown widget for Flutter with advanced styling, search functionality, and dynamic data handling.

search_field_dropdown 🛠️

SearchFieldDropdown widget implementation in Flutter. This widget provides a customizable search field with a dropdown menu that can be populated either statically or dynamically through an API call. It includes various customization options and supports keyboard navigation.

Features

  • Display static items or fetch them dynamically via APIs.
  • Fully customizable dropdown appearance using BoxDecoration and custom item builders.
  • Support for readonly and searchable dropdowns, along with additional customization options.
  • Easy integration with TextFormField for validation and decoration.
  • Advanced cursor styling for an enhanced user interface.
  • Seamless integration of an add-button for custom functionality.
  • Flexible search and filter options, supporting both local and API-based data.

Installation

1.Add the latest version of package to your pubspec.yaml (and run flutter pub get):

dependencies:
  search_field_dropdown: latest_version

2.Import the package and use it in your Flutter App.

import 'package:search_field_dropdown/search_field_dropdown.dart';

Example usage

1.Basic SearchFieldDropdown

A GlobalKey<FormFiledDropDownState> is used to uniquely identify and manage the state of a FormFiledDropDown widget, allowing you to interact with its internal state (e.g., selecting an item or retrieving the selected value) from outside the widget.

Purpose: The GlobalKey<FormFiledDropDownState> allows you to access the state of the FormFiledDropDown widget, which is useful when you need to control the dropdown’s behavior programmatically. By associating a key with the FormFiledDropDown, you can call methods on its state, trigger a rebuild, or update its selected value from a parent widget or another part of your app.

final GlobalKey<SearchFieldDropdownState<String>> dropdownKey = GlobalKey<SearchFieldDropdownState<String>>();

class DropDownClass extends StatelessWidget {
  const DropDownClass({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: SearchFieldDropdown<String>(
        key: dropdownKey, // Attach the GlobalKey to the widget
        items: ['Option 1', 'Option 2', 'Option 3'],
        onChanged: (value) {
          print('Selected: $value');
        },
      )
    );
  }
}

2.SearchFieldDropdown with a Custom Add Button

The addButton property lets you define a custom widget to trigger additional actions, such as opening a dialog box, navigating to another screen, or performing user-defined functionality.

class DropDownClass extends StatelessWidget {
  const DropDownClass({super.key});
  @override
  Widget build(BuildContext context) {

    return Scaffold(
      body: Column(
        children: [
          SearchFieldDropdown<String>(
            item : itemList,
            controller: itemController,
            canShowButton: true,
            addButton:  InkWell(
              onTap: () {
                // add your event's
              },
              child: Container(
                height: 40,
                padding: const EdgeInsets.all(10),
                decoration:BoxDecoration(
                  color: Colors.green,
                  borderRadius: BorderRadius.circular(2),
                ),
                child: const Row(
                  children: [
                    Expanded(
                      child: Text(
                          "Add",
                          maxLines: 1,
                          textAlign:TextAlign.start,
                          overflow: TextOverflow.ellipsis,
                          style: TextStyle(color: Colors.white)
                      ),
                    ),
                    Icon(
                      Icons.add,
                      color: Colors.white,
                    )
                  ],
                ),
              ),
            ),
            textStyle: const TextStyle(
                fontSize: 12,
                fontWeight: FontWeight.w400
            ),
            menuDecoration: BoxDecoration(
                color: Colors.white,
                borderRadius: BorderRadius.circular(4),
                border: Border.all(
                    color: Colors.blueAccent
                )
            ),
            filedDecoration: const InputDecoration(),
            onChanged: (String? value) {},
            listItemBuilder: (context, item, isSelected) {
              return Text(
                item,
                style: TextStyle(
                    fontSize: 12,
                    color: isSelected ? Colors.white : Colors.black,
                    fontWeight: FontWeight.w400
                ),
              );
            },
          ),
        ],
      ),
    );
  }
}

**3 Custom dropdown with custom type model

Let's start with the type of object we are going to work with:

 class ItemModel {
  final int id;
  final String name;


  ItemModel({required this.id, required this.name});


  factory ItemModel.fromJson(Map<String, dynamic> json) => CityModel(
    id: json["id"],
    name: json["name"],
  );

  @override
  bool operator ==(Object other) =>
      identical(this, other) ||
          other is ItemModel && runtimeType == other.runtimeType && id == other.id;

  @override
  int get hashCode => id.hashCode;

  Map<String, dynamic> toJson() => {
    "id": id,
    "name": name,
  };
}

4.SearchFieldDropdown with Dynamic Search or API Integration

Advanced usage example for fetching dropdown items dynamically from an API.

class DropDownClass extends StatelessWidget {
  const DropDownClass({super.key});

  @override
  Widget build(BuildContext context) {

    return Scaffold(
      body: Column(
        children: [
          SearchFieldDropdown<String>(
            controller: itemController,
            initialItem: selectedItem,
            item : itemList,
            onTap: () async{
              // example API, or return your API list.
              return itemList;
            },
            textStyle: const TextStyle(
                fontSize: 12,
                fontWeight: FontWeight.w400
            ),
            filedDecoration: InputDecoration(),
            onChanged: (String? value) {},
            onSearch: (value) async {
              // We can call your API and search from it. Also, I can implement local search in your static list.
              return itemList.where((element) {
                return element.contains(value.toLowerCase());
              }).toList();
            },
            listItemBuilder: (context, item, isSelected) {
              return Text(
                item,
                style: TextStyle(
                    fontSize: 12,
                    color: isSelected ? Colors.white : Colors.black,
                    fontWeight: FontWeight.w400
                ),
              );
            },
          ),
        ],
      ),
    );
  }
}

Properties

PropertyTypeDescription
keyGlobalKey<SearchFieldDropdownState>()Use for maintain state.
itemList<T>?List of dropdown items to display.
fieldReadOnlyboolMakes TextFormField readonly.
readOnlyboolMakes dropdown readonly.
initialItemT?Initial value for the dropdown.
isApiLoadingboolIndicates if the API is loading.
dropdownOffsetboolChange drop-down opening offset
showCursorbool?Toggles the cursor visibility.
cursorColorColor?Changes the cursor color.
cursorHeightdouble?Sets the cursor height.
cursorWidthdouble?Sets the cursor width.
errorWidgetHeightdouble?Sets the error widget height.
cursorRadiusRadius?Sets the cursor border radius.
cursorErrorColorColor?Sets the cursor error color.
textStyleTextStyleStyles the search or selected text.
loaderWidgetWidget?Custom widget to show during API loading.
focusNodeFocusNode?Manages focus for searchable dropdowns.
errorMessageText?Custom error message when no items are found.
overlayHeightdouble?Height of the dropdown overlay.
addButtonWidget?Adds a custom button for additional functionality.
onChangedFunction(T? value)Callback triggered when an item is selected.
menuDecorationBoxDecoration?Custom decoration for the dropdown menu.
filedDecorationInputDecorationDecoration for the TextFormField.
onTapFuture<List<T>> Function()Loads items dynamically for the dropdown.
autovalidateModeAutovalidateMode?Enables validation listener when items change.
controllerOverlayPortalControllerControls dropdown visibility programmatically.
listItemBuilderListItemBuilder<T>Custom builder for dropdown items.
selectedItemBuilderSelectedItemBuilder<T?>?Custom builder for the selected item.
onSearchFuture<List<T>> Function(String)Callback for API-based search functionality.
listPaddingEdgeInsets?Sets padding for the list view.
canShowButtonboolToggles the visibility of the add button.
textAlignTextAlignAligns the text in the search field.
keyboardTypeTextInputType?Sets the input type for the TextFormField.
maxLineint?Limits the maximum number of text lines.
maxLengthint?Limits the maximum number of characters.
inputFormattersList<TextInputFormatter>?Applies input formatting rules to the TextFormField.
validatorString? Function(String?)Validates the dropdown value.
enableInteractiveSelectionbool?Enables or disables text selection in TextFormField