[GetX] スナックバー

概要

今回のブログポストではGetXを使ってスナックバー(Snackbar)を使う方法について説明します。このブログポストで紹介するソースコードは下記のリンクで確認できます。

GitHub: https://github.com/dev-yakuza/study-flutter/tree/main/getx/snackbar

ブログシリーズ

このブログポストはFlutterでGetXを使う方法についてシリーズとしてまとめています。GetXの他の使い方については下記のリンクを参考してください。

GetXのインストール

FlutterでGetXの使い方を確認するため次のコマンドを使ってFlutterの新しいプロジェクトを生成します。

flutter create snackbar

その後、次のコマンドを実行してGetXのパッケージをインストールします。

flutter pub add get

このようにインストールしたGetXを使ってスナックバーを使う方法について説明します。

Snackbarを表示

GetXを使ってSnackbarを使うためには下記のようにGet.snackbar関数を使います。

Get.snackbar(
  title,
  message,
);

これを確認するため、lib/main.dartを次のように修正します。

import 'package:flutter/material.dart';
import 'package:get/get.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return GetMaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  const MyHomePage({Key? key}) : super(key: key);

  void openSnackbar() {
    Get.snackbar(
      'Snackbar',
      'This is a snackbar',
      snackPosition: SnackPosition.BOTTOM,
      forwardAnimationCurve: Curves.elasticInOut,
      reverseAnimationCurve: Curves.easeOut,
    );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text("Snackbar"),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text('Snackbar example'),
            OutlinedButton(
              onPressed: openSnackbar,
              child: const Text('Open'),
            )
          ],
        ),
      ),
    );
  }
}

これを実行すると次のような画面が表示されます。

画面で表示されてるOpenボタンを押すと次のようにGet.snackbarが呼ばれます。

void openSnackbar() {
  Get.snackbar(
    'Snackbar',
    'This is a snackbar',
    snackPosition: SnackPosition.BOTTOM,
    forwardAnimationCurve: Curves.elasticInOut,
    reverseAnimationCurve: Curves.easeOut,
  );
}

そして次のようにsnackbarが表示されることが確認できます。

snackPosition: スナックバーの表示位置
forwardAnimationCurve: 画面に表示される時のアニメーションのCurve
reverseAnimationCurve: 画面から消える時のアニメーションのCurve

Snackbarの確認

GetXでは次のようにSnackbarが開いてるかどうかを確認することができます。

Get.isSnackbarOpen

これを確認するためopenSnackbar()関数を次のように修正します。

void openSnackbar() {
  Future.delayed(const Duration(seconds: 1), () {
    // ignore: avoid_print
    print(Get.isSnackbarOpen);
  });

  Get.snackbar(
    ...
  );
}