macosui_starter

A starter Flutter application for macOS that uses macos_ui.

🚧 Prerequisites

• Your Flutter version should be at least 3.0
• You should have mason_cli installed

Usage 🚀

mason make macosui_starter

You'll be prompted for the following information:

• The name of your app
• Your app's description
• The name of your organization
• Whether to show the debug label by default
• Whether to add a basic custom system menu bar
• Whether to initialize a git repository
• Whether to add basic multi-window support (temporarily disabled)

Variables ✨

Setting custom_system_menu_bar to true will add a basic custom system menu bar to your application, which looks like this:

🚨 A Note About multi-window Support

The add_multi_window option worked by using a third-party plugin called desktop_multi_window, which creates new windows by creating a new instance of the Flutter engine for each window. Unfortunately, this approach means that any plugins used by the primary instance are not passed to the new instances. There are workarounds for multiwindow applications using plugins that would require data passed between them; As of version 2.0, macos_ui uses the macos_window_utils plugin under the hood, the nature of which won't work with the workarounds.

Therefore, add_multi_window is disabled until multi-window is officially released in the Flutter framework itself.

Output 📦

A Flutter application that:

• Targets macOS (support for other platforms can be added manually)
• Has macos_ui pre-installed
• Builds basic UI based on the latest version of macos_ui

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add macosui_starter

# Install globally
mason add -g macosui_starter

Usage 🚀

mason make macosui_starter

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev <0.1.0"

2.0.0

• Use macos_ui: ^2.0.0
• Target Dart SDK ">=2.19.2 <4.0.0"
• Added option to initialize git
• Ensure proper casing of app_name in README.md and AppInfo.xcconfig
• Use the newer app icon from the Flutter framework
• Removed use_translucency option
• Removed hide_native_title_bar option
• Removed add_multi_window option

1.5.0

• Use macos_ui: ^1.12.1+1
• Target Dart SDK Version 2.19.0

1.4.2

• Update usage of PlatformMenuBar to use child instead of the deprecated body

1.4.1

• Use macos_ui: ^1.11.1

1.4.0

• Use macos_ui: ^1.10.0
• Ensures window transparency compatible with Flutter versions >= 3.7.0

1.3.0

• Fixed a bug where the post_gen hook would crash
• Added a success message upon successful completion of project generation
• Use macos_ui: ^1.7.5
• Use desktop_multi_window: ^0.2.0

1.2.1+2

• Use macos_ui: ^1.5.1

1.2.1+1

• Minor fixes

1.2.1

• Ensures that generated applications will always end up in a subdirectory of the specified output directory, or if none is specified, a subfolder of the current directory.
  • Ensures that flutter pub get will always be run in the directory of the generated application.

1.2.0

• 🖥 Added multi-window support via the add_multi_window option.
• Upgraded the pre_gen hook to appropriately handle configuration cases where the user enables multi-window but does not enable system menus.
• Upgraded the post_gen hook to run flutter format . after generating the project to ensure the generated code is always formatted correctly.

1.1.0

• Added the debug_label_on option so developers can choose to turn on/off the debug label via configuration.
• Added support for Flutter's new PlatformMenuBar system menus via the custom_system_menu_bar option.
• Removed an unused import from main.dart.

1.0.0

• Initial release 🎉
  • Generate a new Flutter application that uses macos_ui
  • Optionally use window translucency
  • Optionally hide the native titlebar

MIT License

Copyright (c) [2021] [Reuben Turner]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.