Skip to content

Commit

Permalink
Update readme to address #325
Browse files Browse the repository at this point in the history
  • Loading branch information
GroovinChip committed Jan 27, 2023
1 parent 6436146 commit d93136c
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Expand Up @@ -17,13 +17,23 @@ Guides, codelabs, and other documentation can be found at https://macosui.dev
<img src="https://imgur.com/5mFQKBU.png" width="75%"/>

## 🚨 Usage notes
pub.dev shows that `macos_ui` only supports macOS. This is because `macos_ui` calls some native code, and therefore
specifies macOS as a plugin platform in the `pubspec.yaml` file. `macos_ui` _will_ work on any platform that
Flutter supports, **but you will get best results on macOS**.

The features of `macos_ui` that will _not_ work on platforms other than macOS due to calling native code are:
* The `MacosColors.controlAccentColor()` function
* The `MacosColorWell` widget
> **Note:** Platform Compatibility
>
> pub.dev shows that `macos_ui` only supports macOS. This is because `macos_ui` calls some native code, and therefore
> specifies macOS as a plugin platform in the `pubspec.yaml` file. `macos_ui` _will_ work on any platform that
> Flutter supports, **but you will get best results on macOS**.
>
> The features of `macos_ui` that will _not_ work on platforms other than macOS due to calling native code are:
> * The `MacosColors.controlAccentColor()` function
> * The `MacosColorWell` widget
> **Warning:** Popups & window resizing
>
> Since at this time Flutter does not allow UI elements to overflow the bounds of the window, popups are constrained to
> the available space.
>
> Therefore, if you are using widgets that create popups in your toolbar, like `ToolBarPopupButton`, you
> should avoid allowing your application window to be resized below the height of your tallest popup.
## Contents

Expand Down

0 comments on commit d93136c

Please sign in to comment.