WSelect

WSelect<String>(
  value: _selected,
  options: [
    SelectOption(value: 'dart', label: 'Dart'),
    SelectOption(value: 'flutter', label: 'Flutter'),
  ],
  onChange: (value) => setState(() => _selected = value),
  className: 'w-64 bg-white border border-gray-300 rounded-lg',
)

Basic Usage#

The WSelect widget replaces the standard Material Dropdown with a utility-first approach. It manages its own open state while providing a controlled interface for selection.

WSelect<int>(
  placeholder: 'Choose a number',
  options: List.generate(5, (i) => SelectOption(value: i, label: 'Option $i')),
  onChange: (val) => print('Selected: $val'),
  className: 'bg-white border p-3 rounded-md',
)

Constructor#

const WSelect({
  Key? key,
  T? value,
  ValueChanged<T>? onChange,
  bool isMulti = false,
  List<T>? values,
  ValueChanged<List<T>>? onMultiChange,
  SelectedChipBuilder<T>? selectedChipBuilder,
  required List<SelectOption<T>> options,
  bool searchable = false,
  Future<List<SelectOption<T>>> Function(String)? onSearch,
  String searchPlaceholder = 'Search...',
  Future<SelectOption<T>> Function(String)? onCreateOption,
  CreateOptionBuilder? createOptionBuilder,
  Future<List<SelectOption<T>>> Function()? onLoadMore,
  bool hasMore = false,
  VoidCallback? onOpen,
  String? className,
  String? menuClassName,
  String placeholder = 'Select an option',
  bool disabled = false,
  double? menuWidth,
  double maxMenuHeight = 300,
  Set<String>? states,
  SelectTriggerBuilder<T>? triggerBuilder,
  MultiSelectTriggerBuilder<T>? multiTriggerBuilder,
  SelectItemBuilder<T>? itemBuilder,
  EmptyStateBuilder? emptyBuilder,
  LoadingBuilder? loadingBuilder,
})

Props#

Layout Modes#

Single Select#

The default mode for selecting a single item. It displays the label of the selected option in the trigger.

WSelect<String>(
  value: 'apple',
  options: [
    SelectOption(value: 'apple', label: 'Apple'),
    SelectOption(value: 'banana', label: 'Banana'),
  ],
  onChange: (v) => print(v),
)

Multi Select#

Enable isMulti: true to allow multiple selections. By default, it displays selected items as chips.

WSelect<String>(
  isMulti: true,
  values: ['red', 'blue'],
  options: [
    SelectOption(value: 'red', label: 'Red'),
    SelectOption(value: 'blue', label: 'Blue'),
    SelectOption(value: 'green', label: 'Green'),
  ],
  onMultiChange: (list) => print(list),
)

Event Handling#

WSelect provides callbacks for selection changes and remote interactions.

WSelect<String>(
  options: _options,
  searchable: true,
  hasMore: true,
  onChange: (value) {
    // Handle single selection
  },
  onSearch: (query) async {
    // Return list of options based on search query
    return fetchRemoteOptions(query);
  },
  onLoadMore: () async {
    // Load next page of options
    return fetchNextPage();
  },
  onOpen: resetCursorToPageOne,
)

Pagination and reopening#

Opening the menu resets this widget's own view of the list: the search is cleared and the visible options go back to options. Rows that arrived through onLoadMore were appended to the visible list only, so they are gone.

A caller holding a page cursor keeps it across that reset unless onOpen tells it, and the next scroll to the bottom then asks for the page AFTER the one the reader can see. Measured on a searchable select over a paged endpoint: open, scroll once to pull page two, close, reopen, and page two's rows were unreachable without searching for them.

The reset advice assumes options goes back to page one along with the visible list, which is the ordinary shape: return rows from onLoadMore and leave options alone. A caller that instead MIRRORS fetched pages into options already has all of them on reopen, so resetting its cursor there would re-fetch page two and append duplicates. Reset the cursor only if options resets too.

Accessibility#

The closed trigger is one button whose accessible name is its visible text: the selected option's label (labels joined with , in multi-select), and the placeholder only while nothing is selected. A test or tapir script that finds a select with a value by its placeholder text must look for the selected label instead. The default placeholder is English and wind has no localisation layer, so pass a translated placeholder in a localised app.

The closed trigger publishes exactly one semantics node: it carries the button role, the enabled state, the name, the tap action that opens or closes the menu (absent when disabled) and the keyboard focus state. The trigger's own content, including multi-select chips and the output of triggerBuilder / multiTriggerBuilder, is excluded from semantics so it is not announced a second time. The search field of an open menu keeps its own semantics.

State Variants#

WSelect automatically manages several states that you can style using prefixes in className:

• hover: - When the mouse is over the trigger.
• focus: - When the dropdown is open, or when the trigger has keyboard focus (Tab). Never while disabled; a disabled select is skipped by Tab.
• disabled: - When the widget is disabled.
• selected: - When a value is selected.

WSelect<String>(
  options: _options,
  className: 'border-gray-300 hover:border-blue-500 focus:ring-2 focus:ring-blue-200',
)

Styling Examples#

Searchable Select#

Combine searchable: true with custom menu styling for a robust selection experience.

WSelect<String>(
  searchable: true,
  searchPlaceholder: 'Search countries...',
  menuClassName: 'bg-white shadow-xl rounded-xl border border-gray-100',
  options: countries,
  onChange: (val) => _country = val,
)

Tagging (Create Option)#

Allow users to create new options if a search yields no results.

WSelect<String>(
  searchable: true,
  onCreateOption: (query) async {
    final newOpt = SelectOption(value: query.toLowerCase(), label: query);
    // Add to your local state/database
    return newOpt;
  },
  options: existingTags,
)

All Supported Classes#

Customizing Theme#

The default styling for WSelect and its chips can be influenced by the WindThemeData.

WindThemeData(
  colors: {
    'primary': Colors.indigo,
  },
)

Related Documentation#

• WFormSelect - Form-integrated version with validation
• WPopover - The underlying overlay engine
• WInput - Used for the internal search field