Skip to content

CHANGELOG.md

Latest commit

 

History

History
464 lines (325 loc) · 18.2 KB

CHANGELOG.md

File metadata and controls

464 lines (325 loc) · 18.2 KB

Changelog

2.7.3

Fixed

  • Fixed charAt(index) to return null when index == length instead of throwing a RangeError.
  • Fixed controller.selectAllItems() so it respects maxSelectedItems.
  • Fixed ownership and disposal of TextEditingController, FocusNode, and ScrollController so externally provided instances are not disposed by the widget.
  • Fixed the overlay FocusNode listener lifecycle to avoid stale listeners when focus nodes change or outlive the widget.
  • Fixed selectable bulk actions so selectAllItems() and clearAllPickedItems() no longer remove, re-add, or duplicate visible items in selectable mode.
  • Fixed overlay creatable validation so the overlay constructor now applies CreateOptions.validator, matching the standard creatable path.
  • Fixed creatable flows so onCreated fires and showedItems is refreshed even when pickCreated == false.
  • Fixed ShowedItemsVisibility.alwaysOn so the showed-items panel stays visible after selectAllItems().
  • Fixed parent-driven rebuild handling by syncing updates to items, initialPickedItems, controller, searchField.controller, searchField.focusNode, showedItemsScrollController, pickedItemsScrollController, overlayOptions, and isOverlay.
  • Fixed active search-state preservation so filtering is reapplied when the parent updates items or swaps the search controller.
  • Fixed runtime overlay transitions so switching between overlay and non-overlay variants no longer risks LateInitializationError or stale overlay callbacks.

Changed

  • Replaced charAt string splitting with direct indexing to avoid unnecessary list allocation.
  • Removed unreachable Navigator.pop(context) logic from _onAddItem.
  • getAllItems() and getPickedItems() now return unmodifiable lists instead of exposing mutable internal state.
  • hintText is now used as a fallback InputDecoration hint when the provided search field has no decoration.
  • showedItemContainerHeight and showedItemContainerPadding are now applied to showed-item rows.
  • Default picked-items scroll controller creation moved from the public constructors into State, so internally created controllers are owned and disposed correctly.
  • Removed the implicit ValueKey(items.hashCode) default key so state is preserved across normal parent rebuilds unless the caller explicitly provides a key.

Tests

  • Added charAt unit coverage for boundary conditions, negative indices, null input, empty strings, and the previous off-by-one crash case.
  • Added widget regression tests for search-state syncing, controller rebinding, selectable bulk actions, creatable validation, overlay callback rebinding, overlay transitions, and disposal of externally owned controllers/focus nodes.

Internal

  • Moved lint from dependencies to dev_dependencies.

2.7.2 ♻️ Refactor code

  • Replace deprecated scribbleEnabled with stylusHandwritingEnabled

2.7.1 🗑️ Clean up deprecated code

  • Refactors withOpacity to withValues

2.7.0 ✨🔥 Breaking Changes & New Features

  • All examples are updated to reflect the breaking changes
    • A new example added for the selectable style
  • Adds library's topics

Features

  • Adds isSelectable parameter on MultipleSearchController (defaults to false if not provided). This will slightly adjust the behaviour of the showed items. The items are not removed from the list when selected.

Breaking changes

  • A third parameter, isPicked is added on itemBuilder. This way you can change the looks of the item when it is already picked (e.g checkbox) :

versions <2.7.0

itemBuilder: (country, index) {
  return Padding(
    padding: const EdgeInsets.all(6.0),
    child: Container(
      decoration: BoxDecoration(
        borderRadius: BorderRadius.circular(6),
        color: Colors.white,
      ),
      child: Padding(
        padding: const EdgeInsets.symmetric(
          vertical: 20.0,
          horizontal: 12,
        ),
        child: Text(country.name),
      ),
    ),
  );
},

versions >=2.7.0

itemBuilder: (country, index, isPicked) {
  return Padding(
    padding: const EdgeInsets.all(6.0),
    child: Container(
      decoration: BoxDecoration(
        borderRadius: BorderRadius.circular(6),
        color: Colors.white,
      ),
      child: Padding(
        padding: const EdgeInsets.symmetric(
          vertical: 20.0,
          horizontal: 12,
        ),
        child: Text(country.name),
      ),
    ),
  );
},

2.6.5 ✨ New parameters

  • Adds allowDuplicateSelection parameter on MultipleSearchController. Defaults to true, whether you want duplicate items (if present on list) to be picked.
  • Adds validator parameter on CreateOptions. Defaults to true, a bool Function(T) to validate the item before creating it.

2.6.4 ✨ New parameter

  • Added the minCharsToShowItems parameter to MultipleSearchController to delay the search operation until the user has typed a minimum number of characters.

2.6.3 ⬆️ Bumps Flutter version

  • Due to the integration of the OverlayPortal feature, introduced in Flutter 3.10.0, the version constraints have been updated from ">=1.17.0" to ">=3.10.0". This adjustment ensures compatibility with newer functionalities. Projects using versions of Flutter older than 3.10.0 and updating the library from versions 2.6.0 to 2.6.2 may encounter an 'OverlayPortalController' not found error. It is recommended to update the Flutter environment to at least version 3.10.0 before applying this library update.

2.6.2 🐛 Bug fixes

  • Removes initialItems from the allItems to avoid double records
  • Refactors MultipleSearchController avoiding LateInitializationErrors

2.6.1 📝 Improves documentation

  • Updates README to reflect recent changes
  • Improves internal documentation

2.6.0 ✨🔥 Breaking Changes & New Features

New features

  • Introduces a new constructor MultipleSearchSelection.overlay in which the showed items, act as an overlay instead of pushing bottom widgets. You can customise overlay's behaviour through OverlayOptions.
Overlay Default
Overlay Default

Breaking changes

The implementation of searchField has been updated for enhanced customization. You can now use the searchField parameter to pass a fully customizable TextField. This change offers greater flexibility in tailoring the search field to your specific needs. Please note that the onChanged event is managed internally. For capturing changes in the search field, use onSearchChanged instead of onChanged.

Below already exposed parameters are removed :

  • searchFieldInputDecoration
  • searchFieldTextStyle
  • showClearSearchFieldButton
  • searchFieldInputDecoration
  • autoCorrect
  • enableSuggestions
  • searchFieldBoxDecoration
  • searchFieldTextEditingController
  • searchFieldFocus

Parameters renamed to better reflect their purpose :

  • At CreateOptions class:
    • createItem to create
    • createItemBuilder to createBuilder
    • pickCreateItem to pickCreated
    • onItemCreated to onCreated
    • onDublicateItem to onDuplicate

2.5.6 ✨ New features

  • Introduces a new parameter, MultipleSearchController, which serves as a controller for accessing both displayed and selected items. The only limitation is that it must be utilized after the widget has been constructed.
controller.getAllItems();
controller.getPickedItems();
  • Introduces additional options in CreateOptions for the creatable widget:
    • allowDuplicates: This option is set to true by default. When set to false, it prohibits the selection of any new T item that already exists. It's important to note that T must implement the == method for the library to accurately determine whether the T item already exists among displayed or picked items.
    • onDuplicateItem(T): This callback function is triggered when an attempt is made to add a duplicate item.

2.5.5 ✨ New features

  • Adds a new flag placePickedItemContainerBelow which defaults to false. Picked items will be displayed at the bottom instead of top

2.5.4 ✨🔥 New features & Breaking changes

  • Renames textFieldFocus to searchFieldFocus
  • Adds autoCorrect flag, to check if the search field should auto correct the input text
  • Adds enableSuggestions flag, to check if the search field should provide suggestions

2.5.3 ✨ Adds screenshots & Allows higher than 3.0.0 version SDK

2.5.2 🐛 Bug fixes

  • Resolves the inconsistency where ShowedItemsVisibility.onType was showing all items after selecting one from the list.

2.5.1 🐛 Bug fixes

  • Fixes range exception issue when selecting all items

2.5.0 ✨🔥 New features & Breaking changes

Breaking changes

  • Removes deprecated parameters

Features

  • Adds maxSelectedItems parameter to specify the maximum amount of items the user can select from the items' list. If the maximum number is picked:
    • The search TextField is disabled and the items' list is hidden.
    • The select all button is hidden.
    • The show items button is hidden, if the item visibility is Toggle.
    • The dialog of the items is popped, if the item visibility is Toggle.

2.4.5 🐛✨ Bug fixes & New features

Fixes

  • Resolves an issue with showedItems not dissapearing when itemsVisibility == ShowedItemsVisibility.onType & clearSearchFieldOnSelect == true

Features

  • Adds showedItemsExtent flag. When we have very large lists with dynamic content, unfortunately there is an open issue in Flutter that causes the list to be very slow when scrolled with the srollbar. In that case you can set this to use a fixed height for each item resolving the jankiness. The downside obviously would be that you can't have dynamic height items.

2.4.4 🐛 Bug fixes

  • Resolves an issue when the clear textfield button was not resetting showed items.

2.4.3 ✨ New features

  • Renames outerContainer to searchField to properly reflect its purpose.

  • Adds a new parameter called searchFieldBoxDecoration, which allows you to specify the decoration of the top portion of the dialog box when the ShowedItemsVisibility is set to toggle.

  • Adds deprecated flags to exposed Decoration parameters from pickedItemsBoxDecoration, searchFieldBoxDecoration & showedItemsBoxDecoration. Will be removed on next version.

  • Fixes discrepancies of the decoration parameters.

2.4.2 🐛 Bug fixes

  • Fixes short circuiting issue

2.4.1 🐛 Bug fixes

  • Resolved issue of displayed items failing to wrap when there were fewer items to display in the container.

2.4.0 ✨🔥 New features & Breaking changes

  • Refactored the displayed items to use lazy loading, resulting in a significant improvement in performance for large lists. Additionally, the index is now accessible for further customization.
itemBuilder: (country, index) {
    if (index==0) return Text('Hello World');
    return Padding(
    padding: const EdgeInsets.all(6.0),
    child: Container(
        decoration: BoxDecoration(
        borderRadius: BorderRadius.circular(6),
        color: Colors.white,
         ),
        child: Padding(
         padding: const EdgeInsets.symmetric(
            vertical: 20.0,
            horizontal: 12,
         ),
         child: Text(country.name),
      ),
    ),
  );
},
  • Exposes some more InputDecoration parameters :
    • Adds showClearSearchFieldButton which adds a suffix icon to clear searchfield
    • Adds hintText
    • Adds textFieldFocus
    • Adds textEdittingController
  • If pickedItemsContainerBuilder is provided it will build even if no items are picked

2.3.7 ✨ New features

  • Adds pickedItemsContainerBuilder. You can now provide your own custom Widget for the picked items. pickedItems (List<Widget>) are created from the pickedItemBuilder. So having those items you can customise the layout at your needs.
pickedItemsContainerBuilder: (pickedItems) => Center(
    child: Container(
    height: 150,
    width: 150,
    decoration: BoxDecoration(
        border: Border.all(color: Colors.grey[400]!),
      ),
    child: ListView(
        children: pickedItems,
    ),
  ),
),
pickedItemBuilder: (country) {
    return Padding(
    padding: const EdgeInsets.all(8),
    child: Center(
        child: Text(
        country.name,
        style: const TextStyle(
            color: Colors.blue,
            decoration: TextDecoration.underline,
        ),
      ),
    ),
  );
},

2.3.6 🎨 ♻️ Improves structure & Refactors code

  • Removes redundant code & refactors methods.
  • Fixes onItemRemoved being called twice. Thanks to anqit

2.3.5 🐛 Bug fixes

  • Fixes issue were fuzzy search was not always working

2.3.4 🎨 Updates CHANGELOG

2.3.3 🐛✨ Bug fixes & New features

  • Adds missed [onItemCreated] parameter to [createOptions]
  • Adds caseSensitiveSearch so you can search with case sensitive. Thanks to anqit

2.3.2 ✨ New features

New constructor added MultipleSearchSelection<T>.creatable which can now create new item when search result does not return any results. It takes a new required parameter, createOptions e.g :

// [T] here is [Country]
createOptions: CreateOptions<Country>(
    // You need to create and return the item you want to add since [T] is not always [String].
    createItem: (text) {
        return Country(name: text, iso: text);
    },
    // Create item Widget that appears instead of no results.
    createItemBuilder: (text) => Align(
        alignment: Alignment.centerLeft,
            child: Padding(
                padding: const EdgeInsets.all(8.0),
                child: Text('Create "$text"'),
            ),
        ),
    // Whether you want to pick the newly created item or just add it to your list. Defaults to false.
    pickCreatedItem: true,
),

2.3.1 ✨ New features

  • [clearSearchFieldOnSelect]. Whether to clear the searchfield and reset the showed items when you pick an item. Defaults to [false].

2.3.0 ♻️ 🔥 🐛 Code refactoring, Breaking changes & Bug fixes

🔥 Breaking changes:

  • Minimum Dart SDK updated to 2.17.0

🐛 Bug fixes:

  • Dropdown was not correctly rebuilding after changing the initial items list.

♻️ Fields made optional:

  • Key parameter has been added. It defaults to ValueKey(items.hasCode).
  • [maximumShowItemsHeight]. It defaults to 150.
  • [onPickedChange]. Your call if you need it.
  • [itemsVisibility]. It defaults to always on.
  • [fuzzySearch]. It defaults to none.

2.2.1 🐛 Bug fixes

  • Fixes itemsVisibility: ShowedItemsVisibility.onType not showing anything.

2.2.0 🔥 Breaking changes

Fields removed:

  • [padding] : Refactor -> You can wrap the whole widget in a [Padding] widget.
  • [titlePadding] : Refactor -> You can wrap the title with a [Padding] widget.
  • [showedItemMouseCursor] : Refactor -> You can build your own showed item [Widget] with [itemBuilder] and use your own style.
  • [searchItemTextContentPadding] : Refactor -> You can use [searchFieldInputDecoration] to style your search textfield.

Fields renamed:

  • [searchItemTextStyle] -> [searchFieldTextStyle]

2.1.0 🔥 ⚡️ Breaking changes & performance improvements

  • Adds [showItemsButton] widget and removes all parameters associated with it previously.
  • Adds [selectAllButton] widget and removes all parameters associated with it previously.
  • Adds [clearAllButton] widget and removes all parameters associated with it previously.
  • Removes opinionated default widgets to plain [Text] reducing code size

2.0.2 🐛 Bug fixes

  • Fixes sort picked items bug

2.0.1 🐛 Bug fixes

  • Fixes bug with [showItemsText] button text showing [selectAllText] instead
  • Removes junk files reducing library size

2.0.0 🔥 Breaking changes

[items] & [initialItems] are now of type [T] for more flexibility when working with different types of [Object] in [List].

New required parameters added :

  • [itemBuilder(T)] build and return the showed item widget
  • [pickedItemBuilder(T)] build and return the picked item widget
  • [fieldToCheck(T)] return the [String] field from the [T] of which you will search & sort against

Removed all parameters connected to showed & picked items since we now have builder methods. Please check the example for the implementation.

1.1.0 ✨ New features

  • Adds [itemsVisibility] enum which activates different display options on showed items.
ShowedItemsVisibility.alwaysOn // The items are always displayed
ShowedItemsVisibility.onType // Items are displayed when user types on search field
ShowedItemsVisibility.toggle // Items are displayed when tapped on show items toggle button

1.0.5 ♻️ Refactors code

  • Replaces deprecated isAlwaysShown with thumbVisibility for RawScrollBar

1.0.4 ✨ 📝 New features & documentation improvement

  • Adds initialy picked items parameter, List<String>. initialPickedItems
  • Edits library description
  • Edits example code

1.0.3 ✨ New features

  • Adds [MouseCursor] for showed & picked items. showedItemMouseCursor & pickedItemMouseCursor
  • Adds [BoxDecoration] for showed & picked items container. pickedItemsBoxDecoration & showedItemsBoxDecoration

1.0.2 ✨ New features

  • Adds fuzzy search functionality. New enum FuzzySearch added to choose from available fuzzy algorithms (Jaro & Levenshtein). Defaults to [FuzzySearch.none].

1.0.1 ✨ New features

  • Adds [ScrollController] for showed & picked items.
  • Adds [ScrollPhysics] for showed & picked items.
  • Adds a choice whether to sort showed & picked items.
  • Adds picked item remove icon parameter.
  • Exposes picked item's [BoxDecoration].
  • Exposes clear all & select all buttons' animation curves.

1.0.0 🎉 Initial release

  • Initial release.