◎コピペで使うテンプレート
・情報が古いことがあります。内容を理解した上で使用してください。
・画面遷移、多言語対応、Theme変更対応のテンプレートです。
◎main.dart
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:flutter_gen/gen_l10n/app_localizations.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:作業ディレクトリ/state/thememode_controller.dart';
import 'package:作業ディレクトリ/state/page_controller.dart';
import 'package:作業ディレクトリ/setting_page.dart';
import 'package:作業ディレクトリ/myhome_page.dart';
void main() async{
WidgetsFlutterBinding.ensureInitialized(); // Flutterが初期化されたかを確認
// 初期化
// themeMode
final _isToggleTheme = await ThemeModeNotifier().LoadToggleTheme();
final _themeColorsName = await ThemeModeNotifier().LoadMaterialColor();
//setting
//初回起動時をチェックする。
//final _isFirstLoad = await SettingNotifier().LoadIsFirstStart();
//初回起動時をチェックする場合
// 初期ページの設定
// 初回起動時かチェックし、最初のページを振り分ける
//var _firstpage = Pages.MainListPage;
//if(_isFirstLoad == true){
// _firstpage = Pages.IntroductionPage;
//}
// windowsで実行すると、例外が発生する
//if (Platform.isAndroid){
// MobileAds.instance.initialize(); // 広告表示のため、mobileadsを初期化
//}
runApp(
ProviderScope(
child:MyApp(),
overrides: [
// Theme Mode
gThemeModeProvider.overrideWith((ref) => ThemeModeNotifier.initialThemeMode(_isToggleTheme, _themeColorsName)),
// page
gPageControlProvider.overrideWith((ref) => PageNotifier.initialPage(_firstpage)),
],
),
);
}
class MyApp extends ConsumerStatefulWidget {
const MyApp({Key? key}) : super(key: key);
@override
_MyAppState createState() => _MyAppState();
}
class _MyAppState extends ConsumerState<MyApp> {
// ここに変数を書く
// ここに関数を書く
// 初期化関数
// 設定読み出しなど
void _initialize() async {
}
@override
void initState() {
super.initState();
// 一度だけ何かを実行したいときはこちらに書く
_initialize();
}
// ここにUIを書く
// // context を呼び出すと例外が発生するので注意
// This widget is the root of your application.
@override
Widget build(BuildContext context) {
final _pageProvider = ref.watch(gPageControlProvider);
final _themeModeProvider = ref.watch(gThemeModeProvider);
//ref.read(gThemeModeProvider.notifier).SetToggleThemeMode(_isToggle); //先に読み込むおまじない
return MaterialApp(
// 多言語対応
localizationsDelegates: [
AppLocalizations.delegate,
GlobalMaterialLocalizations.delegate,
GlobalWidgetsLocalizations.delegate,
GlobalCupertinoLocalizations.delegate,
],
supportedLocales: [
const Locale('en', ''),
const Locale('ja', ''),
// ... 他のlocaleを追加
],
title: 'Flutter Demo',
theme: !ref.read(gThemeModeProvider.notifier).GetToggleThemeMode() ? ThemeData(
colorScheme: ColorScheme.fromSeed(seedColor: ref.read(gThemeModeProvider.notifier).GetMaterialColor()),useMaterial3: true,
) : ThemeData.dark(),
darkTheme: !ref.read(gThemeModeProvider.notifier).GetToggleThemeMode() ? ThemeData.dark() : ThemeData(
colorScheme: ColorScheme.fromSeed(seedColor: ref.read(gThemeModeProvider.notifier).GetMaterialColor()),useMaterial3: true,
) ,
home:
Router(
routerDelegate: AppRouterDelegate(ref),
),
);
}
}
class Empty {}
// 画面遷移 RouterDelegate
class AppRouterDelegate extends RouterDelegate<Empty>
with ChangeNotifier, PopNavigatorRouterDelegateMixin<Empty> {
AppRouterDelegate(this.ref);
final WidgetRef ref;
@override
final GlobalKey<NavigatorState>? navigatorKey = gNavigatorKey;
@override
Widget build(BuildContext context) {
final _pageProvider = ref.watch(gPageControlProvider);
return Navigator(
key: navigatorKey,
pages: [
// ここにページを置く
// サブページを重ねる場合はページの並べ方を工夫すること
const MaterialPage(child: TopDummyPage()), // rootのダミーページ
// 以下、サブページ。ページを増やすときはここに追加する
if (ref.read(gPageControlProvider.notifier).page == Pages.MyHomePage) const MaterialPage(child: MyHomePage()) ,
if (ref.read(gPageControlProvider.notifier).page == Pages.SettingPage) const MaterialPage(child: SettingPage()),
//サブページを重ねる場合の例
//if (_pageProvider.page == Pages.SettingPageSub) const MaterialPage(child: SettingPage()),
//if (_pageProvider.page == Pages.SettingPageSub) const MaterialPage(child: SettingPageSub()),
],
onPopPage: (route, result) {
if(route.didPop(result) == false) return false; // 失敗
// 成功時
// 戻るボタンを押したとき、強制的に最初の画面へ
// サブページを重ねる場合は、一工夫必要。
ref.read(gPageControlProvider.notifier).ChangePage(Pages.MyHomePage);
return true;
},
);
}
@override
Future<void> setNewRoutePath(Empty configuration) async {}
}
// CircluarProgress を表示するrootのdummyページ
class TopDummyPage extends StatelessWidget {
const TopDummyPage({Key? key}) : super(key: key);
@override
Widget build(BuildContext context){
return Scaffold(
body: Center(
child: Column(
mainAxisSize: MainAxisSize.min,
children:[
CircularProgressIndicator(),//
]
),
)
);
}
}
◎/state/page_controller.dart
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
// 画面遷移用
final gNavigatorKey = GlobalKey<NavigatorState>();
final gPageControlProvider = StateNotifierProvider(
(ref) => PageNotifier(),
);
// ページを増やす時は追加する
enum Pages{
TopDummyPage,
MyHomePage,
SettingPage,
}
class PageNotifier extends StateNotifier<Pages>{
PageNotifier() : super (Pages.MyHomePage);
// 名前付きコンストラクタ
PageNotifier.initialPage(Pages inPage) :super (inPage);
Pages get page => state;
void ChangePage(Pages inPage){
state = inPage;
}
}
◎thememodestate.dart
・freezed を使用しています。
import 'package:freezed_annotation/freezed_annotation.dart';
part 'thememodestate.freezed.dart';
// Collors を追加するとき、
// ThemeModeNotifier.GetMaterialColor(), ColorsName, _colorsString の3箇所を追加する
// ColorsName, _colorsStringの色の並び順はそろえること
// ColorsName.Blue.index 等により、各indexは得られる
// enum の配列はColorsName.valuesで得られる
enum ColorsName {
Blue,
Red,
Green,
Yellow,
}
@freezed
class ThemeModeState with _$ThemeModeState {
const factory ThemeModeState({
required bool isToggleTheme,
required ColorsName themeColorsName,
}) = _ThemeModeState;
}
◎thememode_controller.dart
・Theme切り替え用
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_gen/gen_l10n/app_localizations.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:shared_preferences/shared_preferences.dart';
import 'package:編集ディレクトリ/state/thememodestate.dart';
const _IsToggleThemeModeKey = 'IsToggleThemeMode';
const _ColorsNameIntKey = 'ColorsNameInt';
final gThemeModeProvider = StateNotifierProvider<ThemeModeNotifier,ThemeModeState>(
(ref) => ThemeModeNotifier(),
);
// StateNotifier
class ThemeModeNotifier extends StateNotifier<ThemeModeState>{
ThemeModeNotifier() : super(ThemeModeState(isToggleTheme: false, themeColorsName: ColorsName.Blue)){
}
// 名前付きコンストラクタ
ThemeModeNotifier.initialThemeMode( bool inToggleTheme, ColorsName inColor) : super(ThemeModeState(isToggleTheme: inToggleTheme, themeColorsName: inColor));
// 色を足すときには追加する
static const _colorsString = [
'Blue',
'Red',
'Green',
'Yellow',
];
void SetToggleThemeMode(bool inBool){
state = state.copyWith(isToggleTheme: inBool);
_saveTogggleThemeBool(inBool);
}
bool GetToggleThemeMode(){
return state.isToggleTheme;
}
void _saveTogggleThemeBool(bool inBool) async {
final _pref = await SharedPreferences.getInstance();
await _pref.setBool(_IsToggleThemeModeKey, inBool);
}
// main 関数で読み込むようにした
Future<bool> LoadToggleTheme() async {
final _pref = await SharedPreferences.getInstance();
// キーが得られなければデフォルト値を返す
return _pref.getBool(_IsToggleThemeModeKey) ?? false; // 入れ替えない
}
// Colors
// 色を足すときには追加する
MaterialColor GetMaterialColor(){
switch(state.themeColorsName){
case ColorsName.Blue:
return Colors.blue;
case ColorsName.Red:
return Colors.red;
case ColorsName.Green:
return Colors.green;
case ColorsName.Yellow:
return Colors.yellow;
default:
return Colors.blue;
}
}
String GetMaterialColorString(){
return _colorsString[state.themeColorsName.index];
}
ColorsName GetColorsName(){
return state.themeColorsName;
}
void SetMaterialColor(ColorsName inColor){
state = state.copyWith(themeColorsName: inColor);
_saveMaterialColor();
}
// 次のColorを設定する（enumの並び順）
void SetNextColor(){
int _index = state.themeColorsName.index;
int _maxIndex = _colorsString.length-1; // 色のindexの最大値を得る
_index++; // 次の色へ
if ((_maxIndex) < _index) _index = 0;
SetMaterialColor(ColorsName.values[_index]);
}
void SetPrevColor(){
int _index = state.themeColorsName.index;
int _maxIndex = _colorsString.length-1; // 色のindexの最大値を得る
_index--; // 前の色へ
if(_index < 0) _index = _maxIndex;
SetMaterialColor(ColorsName.values[_index]);
}
void _saveMaterialColor() async {
final _pref = await SharedPreferences.getInstance();
await _pref.setInt(_ColorsNameIntKey, state.themeColorsName.index);
}
// main 関数で読み込むようにした
Future<ColorsName> LoadMaterialColor() async {
final _pref = await SharedPreferences.getInstance();
final _index = _pref.getInt(_ColorsNameIntKey) ?? 0; // 初期値は0 つまりBlue
return ColorsName.values[_index]; //
}
}
◎myhome_page.dart
・デフォルトのページを加工してみた
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:flutter_gen/gen_l10n/app_localizations.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:編集ディレクトリ/state/thememode_controller.dart';
import 'package:編集ディレクトリ/state/page_controller.dart';
import 'package:編集ディレクトリ/setting_page.dart';
class MyHomePage extends ConsumerStatefulWidget {
const MyHomePage({Key? key}) : super(key: key);
// This widget is the home page of your application. It is stateful, meaning
// that it has a State object (defined below) that contains fields that affect
// how it looks.
// This class is the configuration for the state. It holds the values (in this
// case the title) provided by the parent (in this case the App widget) and
// used by the build method of the State. Fields in a Widget subclass are
// always marked "final".
//final String title;
@override
_MyHomePageState createState() => _MyHomePageState();
}
class _MyHomePageState extends ConsumerState<MyHomePage> {
int _counter = 0;
void _incrementCounter() {
setState(() {
// This call to setState tells the Flutter framework that something has
// changed in this State, which causes it to rerun the build method below
// so that the display can reflect the updated values. If we changed
// _counter without calling setState(), then the build method would not be
// called again, and so nothing would appear to happen.
_counter++;
});
}
@override
Widget build(BuildContext context) {
final _pageProvider = ref.watch(gPageControlProvider);
final _ThemeModeProvider = ref.watch(gThemeModeProvider);
// This method is rerun every time setState is called, for instance as done
// by the _incrementCounter method above.
//
// The Flutter framework has been optimized to make rerunning build methods
// fast, so that you can just rebuild anything that needs updating rather
// than having to individually change instances of widgets.
return Scaffold(
appBar: AppBar(
//automaticallyImplyLeading: false,
// Here we take the value from the MyHomePage object that was created by
// the App.build method, and use it to set our appbar title.
title: Text('widget.title'),
),
body: Center(
// Center is a layout widget. It takes a single child and positions it
// in the middle of the parent.
child: Column(
// Column is also a layout widget. It takes a list of children and
// arranges them vertically. By default, it sizes itself to fit its
// children horizontally, and tries to be as tall as its parent.
//
// Invoke "debug painting" (press "p" in the console, choose the
// "Toggle Debug Paint" action from the Flutter Inspector in Android
// Studio, or the "Toggle Debug Paint" command in Visual Studio Code)
// to see the wireframe for each widget.
//
// Column has various properties to control how it sizes itself and
// how it positions its children. Here we use mainAxisAlignment to
// center the children vertically; the main axis here is the vertical
// axis because Columns are vertical (the cross axis would be
// horizontal).
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
const Text(
'You have pushed the button this many times:',
),
Text(
'$_counter',
style: Theme.of(context).textTheme.headline4,
),
ElevatedButton(
onPressed: (){
ref.read(gPageControlProvider.notifier).ChangePage(Pages.SettingPage);
},
child: Text('Setting Page'),
),
SizedBox(height: 5,),
ElevatedButton(
child: Text('Color Change'),
onPressed: (){
ref.read(gThemeModeProvider.notifier).SetMaterialColor(ColorsName.Red);
},
)
],
),
),
floatingActionButton: FloatingActionButton(
onPressed: _incrementCounter,
tooltip: 'Increment',
child: const Icon(Icons.add),
), // This trailing comma makes auto-formatting nicer for build methods.
);
}
}
◎setting_page.dart
・設定ページ
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:flutter_gen/gen_l10n/app_localizations.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:編集ディレクトリ/state/page_controller.dart';
import 'package:編集ディレクトリ/state/thememode_controller.dart';
class SettingPage extends HookConsumerWidget{
const SettingPage ({Key? key}) : super(key: key);
@override
Widget build(BuildContext context, WidgetRef ref){
// 各Provider をwatchすることにより、変更時に再描写されるよ。
// watchするproviderをどのConsumerWidgetで扱うかを考慮すると、
// 再描写にかかるタスクを減らせるよ。
final _pageProvider = ref.watch(gPageControlProvider);
final _themeModeProvider = ref.watch(gThemeModeProvider);
//final _themeModeNotifier = ref.watch(gThemeModeProvider.notifier); //この使い方は間違い
PreferredSizeWidget _makeConfigAppbar(){
return AppBar(
title: Text('設定画面'),
actions: [
],
);
}
Widget _makeToggleThemeSwitch() {
return
Card(
child:
Row(
children: [
Text('Theme mode を変更する'),
Expanded(child: SizedBox()),
Switch(
value: ref.read(gThemeModeProvider.notifier).GetToggleThemeMode(),
onChanged: (bool? inBool)async{
if(inBool != null){
ref.read(gThemeModeProvider.notifier).SetToggleThemeMode(inBool);
}
}
)
],
),
);
}
Widget _makeColorChanger(){
return Card(
child: Row(
children: [
Text('画面の色変更'),
Expanded(child: SizedBox()),
IconButton(
icon: Icon(Icons.arrow_left),
onPressed:() {
ref.read(gThemeModeProvider.notifier).SetPrevColor();
},
),
SizedBox(
width: 80,
child: Text(
textAlign: TextAlign.center,
ref.read(gThemeModeProvider.notifier).GetMaterialColorString(), // Colors String
),
),
IconButton(
icon: Icon(Icons.arrow_right),
onPressed:() {
ref.read(gThemeModeProvider.notifier).SetNextColor();
},
),
],
),
);
}
return Scaffold(
appBar: _makeConfigAppbar(),
body: SingleChildScrollView(
child:
Column(
children: [
_makeToggleThemeSwitch(),
_makeColorChanger(),
],
)
),
);
}
}