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

appearance のカバー
パッケージ詳細v0.0.1

appearance

ライト、ダーク、システムテーマモードを実装し、アプリの再起動時に設定を保持するためのFlutterパッケージ。

AndroidiOSWeb
30日間ダウンロード
83
いいね数
5
Pub ポイント
150

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

flutter pub add appearance

パッケージ概要

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

外観パッケージは、Flutterアプリケーションでライトモード、ダークモード、システムテーマモードを実装することを簡素化します。テーマ間の切り替えをスムーズに行い、アプリの再起動後も選択されたモードを保持できます。統合のしやすさを重視して開発されており、テーマの状態管理を処理し、Android、iOS、Webプラットフォーム間で一貫したユーザー体験を確保します。このパッケージは動的なテーマ切り替えをサポートしており、システムレベルのテーマ設定に自動的に適応します。

用途

  • モバイルおよびWebアプリでのテーマ切り替えの実装
  • アプリの再起動後にユーザーのテーマ設定を保持する
  • システムテーマの認識をサポート
  • ライトモードとダークモードを備えたアクセシブルなUIの作成
  • スムーズなテーマの遷移を有効にする

主な機能

  • ライト、ダーク、およびシステムテーマのサポート
  • 永続的なテーマ状態のストレージ
  • 自動システムテーマ検出
  • クロスプラットフォーム互換性(Android、iOS、Web)
  • テーマ切り替えのためのシンプルな API

適している対象

  • クロスプラットフォームアプリを構築するFlutter開発者
  • ユーザーがカスタマイズ可能なテーマを必要とするアプリ
  • アクセシビリティとUXに焦点を当てたプロジェクト
  • テーマ化に最小限のボイラープレートを望む開発者
  • モバイルおよびウェブの両方をターゲットとしたアプリケーション

注意事項

  • テーマ固有のウィジェットスタイルの手動処理が必要です
  • 組み込みテーマデザインコンポーネントを含まない
  • テーマモードの永続性に限定され、完全なテーマカスタマイズは不可
  • 複雑なテーマロジックのための追加のセットアップが必要になる場合があります
  • 基本機能を超えて使用する場合、外部の状態管理に依存します

元の README

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

appearance

Appearance

Flutter package that easily implement Light, Dark and System theme mode in your application and persists the theme mode on restart of the application.

🚀 Demo: Appearance

📱 Screenshots

Appearance Demo 1 Appearance Demo 2

🛠 Installation

  1. Add dependency to pubspec.yaml file:
    Get the latest version from the 'Installing' tab on pub.dev
dependencies:
  appearance: ^latest_version
  1. Import the package
import 'package:appearance/appearance.dart';

📘 How to use

  1. Initialize SharedPreferencesManager singleton for SharedPreference and add it before runApp() method.
void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await SharedPreferencesManager.instance.init();
  runApp(const MyApp());
}
  1. extend your root class with AppearanceState using keyword with.
class _MyAppState extends State<MyApp> with AppearanceState { }
  1. Wrap your MaterialApp or CupertinoApp with BuildWithAppearance
BuildWithAppearance(
    initial: ThemeMode.light, // optional : default value is [ThemeMode.system]
    builder: (context) => MaterialApp()
);
Using MaterialApp
BuildWithAppearance(
    initial: ThemeMode.light, // optional : default value is [ThemeMode.system]
    builder: (context) => MaterialApp(
        title: 'Appearance (Material Example)',
        themeMode: Appearance.of(context)?.mode,
        theme: ThemeData(
            brightness: Brightness.light,
        ),
        darkTheme: ThemeData(
            brightness: Brightness.dark,
        ),
        home: const HomeMaterialPage(),
    ),
);
Using CupertinoApp
BuildWithAppearance(
    initial: ThemeMode.light, // optional : default value is [ThemeMode.system]
    builder: (context) {
        return CupertinoApp(
            title: 'Appearance (Cupertino Example)',
            theme: CupertinoThemeData(
                brightness: Appearance.of(context)?.cupertinoBrightness!,
            ),
            localizationsDelegates: const [
                DefaultMaterialLocalizations.delegate,
                DefaultCupertinoLocalizations.delegate,
                DefaultWidgetsLocalizations.delegate,
            ],
            home: HomeCupertinoPage(),
        );
    },
);

🌟 Features

  • Light, Dark and System mode options to change theme of app.

  • Theme persistance: Saved theme is persisted using SharedPreferences on restart.

  • Auto Listen Theme Mode changes, without adding extra listener.

  • Material and Cupertino, both apps are supported.

🧰 Parameters

  • initial: [optional]
    Set the initial ThemeMode of the app, by default its value is ThemeMode.system

Change Theme Mode

You can use the setMode method to change the theme mode of the app.

 // sets theme mode to System
 Appearance.of(context)?.setMode(ThemeMode.system),

 // sets theme mode to Light
 Appearance.of(context)?.setMode(ThemeMode.light),

 // sets theme mode to Dark
 Appearance.of(context)?.setMode(ThemeMode.dark),

Get Theme Mode

 // get active theme mode
 Appearance.of(context)?.mode

Get Cupertino Theme brightness

 // get active cupertino theme brightness
 Appearance.of(context)?.cupertinoBrightness!,

💻 Example

Check out the example app in the example directory for both Material and Cupertino.

📝Contribution

Feel free to contribute to this project.

  • If you found a bug or have a feature request, open an issue.

  • If you want to contribute, submit a pull request.

💳 License

This project is LICENSED under the MIT License. Use it freely, but let's play nice and give credit where it's due!

🎉 Conclusion

I will be happy to answer any questions that you may have on this approach,
If you liked this package, don't forget to show some ❤️ by smashing the ⭐.

カテゴリー

依存関係

依存関係一覧 1 件

ソースリポジトリ

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

データはまだありません。