パッケージ、リポジトリ、アプリカテゴリを検索

app_bar_with_search_switch のカバー
パッケージ詳細v1.8.6

app_bar_with_search_switch

AppBar を検索フィールドに切り替えるための拡張機能。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
598
いいね数
59
Pub ポイント
150

パッケージをインストール

flutter pub add app_bar_with_search_switch

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Flutterパッケージで、標準のアプリバーと検索フィールドの間をスムーズに切り替えるためのAppBar機能を拡張します。アプリバー内でナビゲーションモードと検索モードを切り替えるためのクリーンでインタラクティブな方法を提供し、頻繁に検索を行うアプリにおけるユーザー体験を向上させます。このパッケージは軽量で、既存のUIに簡単に統合できます。Android、iOS、Web、macOS、Windows、Linuxを含むすべての主要プラットフォームをサポートしています。

用途

  • モバイルおよびウェブアプリケーションでの動的検索バーの実装
  • オンデマンド検索による直感的なナビゲーションの作成
  • コンテンツが豊富なアプリケーションにおけるユーザー体験の向上
  • 最小限のUI変更で応答性のあるインターフェースを構築する
  • トップアプリバーから検索に素早くアクセスできるようにする

主な機能

  • アプリバーと検索モードの間をワンクリックで切り替え
  • カスタマイズ可能な検索フィールドの外観
  • プラットフォーム固有の動作をサポートします
  • 軽量で統合が簡単
  • スムーズな遷移のための組み込みアニメーション

適している対象

  • 頻繁な検索ニーズを持つアプリを開発する開発者
  • 洗練された検索統合を求めるUIデザイナー
  • 複数のオペレーティングシステムをターゲットにするクロスプラットフォームアプリ開発者
  • 最小限でありながら機能的な検索インターフェースを必要とするアプリ

注意事項

  • パッケージ外で検索ロジックを手動で処理する必要があります
  • カスタムテーマ用に追加のスタイルが必要になる場合があります
  • アプリバーレベルの検索機能に限定
  • 複雑な検索ワークフローには適していません
  • 完全な互換性のために、Flutter の Material または Cupertino ウィジェットに依存しています

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

AppBar with search switch

Content

Intro

An AppBar that can switch into search field.

The AppBarWithSearchSwitch is a replacement class for AppBar, essentially, it returns two different app bars based on whether search is active.

Note: version 1.5+ is lightweight version of this package, version 2.0+ uses SpeechToText package for speech recognition.

This is complete rewrite of flutter_search_bar with support of these features:

Features

Quick overview

Use appBarBuilder parameter to build default AppBar with:

The appBarBuilder is the only required parameter, all other parameters are optional!

Use one of these callbacks to get text from TextField:

Also, there are callbacks for:

This widget support almost all properties of AppBar, but:

  • leading and title properties are now expect - Widget Function(context)?:

    • this is made in order to access AppBarWithSearchSwitch.of(context) methods in them,
    • don't change them unless it necessary and use templates if you need to change these properties.
  • preferredSize here is a method, you should set it via toolbarWidth and toolbarHeight.

Here is a list of all other new properties(without mentioned above) with their default values:

Examples

Online example here: https://alexqwesa.github.io/app_bar_with_search_switch/.

Full example of Stateful widget is here: https://pub.dev/packages/app_bar_with_search_switch/example.

Full example of Stateless widget is here: (github).

Full example of Stateless widget with 10000 elements searched in place and with search button outside of app bar is here: (github).

Full example of Stateless widget there android back button will close search is here: (github).

And the fragment of example code is here:

  //...
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      //
      // *** The Widget AppBarWithSearchSwitch
      //
      appBar: AppBarWithSearchSwitch(
        onChanged: (text) {
          // update you provider here
          // searchText.value = text;
        }, // onSubmitted: (text) => searchText.value = text,
        appBarBuilder: (context) {
          return AppBar(
            title: Text('Example '),
            actions: [
              AppBarSearchButton(),
              // or
              // IconButton(onPressed: AppBarWithSearchSwitch.of(context)?startSearch, icon: Icon(Icons.search)),
            ],
          );
        },
      ),
      // search in body by any way you want, example:
      body: AppBarOnEditListener(builder: (context) { return /* your code here */ ;} ),
    );
  }

Screenshots

TODO

  • [x] Add speech to text support - done in version 2.0+,
  • [x] Animation for Search app bar activation - done in versions 1.5+
  • [ ] don't use shared default ValueNotifier and TextEditingController ?

FAQ

How to activate search field (isSearchMode=true) of AppBarWithSearchSwitch from somewhere far away?

  • If it is inside the same Scaffold or its children, then:

    1. use AppBarWithSearchFinder,
    2. call AppBarWithSearchFinder.of(context)?.triggerSearch() inside.
  • If it is outside of Scaffold, use customIsSearchModeNotifier,

    1. Initialise variable of type ValueNotifier somewhere up in the widget tree,
    2. Set customIsSearchModeNotifier property of AppBarWithSearchSwitch with this variable,
    3. Set value of this ValueNotifier to true to show Search AppBar,
    4. (Note: currently, if you stop search via this variable(by setting it false), clearOnClose will not work, and callBack onClose will not be called), so use GlobalKey if you need them.

How to make android back button close search? (instead of going to previous screen or exit app)

  1. Initialise variable searchText and isSearchMode of type ValueNotifier somewhere up in the widget tree,
  2. Assign these variables to customIsSearchModeNotifier, customTextNotifier,
  3. Wrap WillPopScope widget over Scaffold, and define parameter onWillPop as in example below:
... // inside a widget
  final isSearchMode = ValueNotifier<bool>(false);
  final searchText = ValueNotifier<String>(''); 

  @override
  Widget build(BuildContext context) {

    return WillPopScope(
      onWillPop: () async { // android back button handler
        if (searchText.value != '') {
          isSearchMode.value = false;
          searchText.value = ''; 
          return false;
        }
        return true;
      },
      child: Scaffold(
        //
        // *** The Widget AppBarWithSearchSwitch
        //
        appBar: AppBarWithSearchSwitch(
          customIsSearchModeNotifier: isSearchMode,
          customTextNotifier: searchText,
          appBarBuilder: (context) {
            return AppBar(
... // you code here

How to add autocompletion to search field?

... // inside a widget
  @override
  Widget build(BuildContext context) {

    return Scaffold(
        appBar: AppBarWithSearchSwitch(
          title:  (context) {
                return Autocomplete<String>(
                  optionsBuilder: (TextEditingValue textEditingValue) {
                    // your code here
                  },
                ); 
          }
          appBarBuilder: (context) {
            return AppBar(
... // you code here

Can it be used with old flutter sdk versions?

The release 1.3.5 is a special release with support of old flutter sdk, it tested with flutter 2.10.0

Known issues

カテゴリー

ソースリポジトリ

このパッケージを使用しているプロジェクト