Merge pull request #367 from macosui/dev

release: Version `1.11.1`

Author: GroovinChip

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,9 +7,7 @@
 
 ## Pre-launch Checklist
 
-- [ ] I have run `dartfmt` on all changed files <!-- THIS IS REQUIRED -->
 - [ ] I have incremented the package version as appropriate and updated `CHANGELOG.md` with my changes <!-- THIS IS REQUIRED -->
 - [ ] I have added/updated relevant documentation <!-- If relevant -->
 - [ ] I have run "optimize/organize imports" on all changed files
-- [ ] I have addressed all analyzer warnings as best I could
-<!-- - [ ] I have run `flutter pub publish --dry-run` and addressed any warnings --> <!-- MAINTAINER ONLY -->
+- [ ] I have addressed all analyzer warnings as best I could

.github/workflows/flutter_analysis.yml

@@ -15,8 +15,22 @@ jobs:
       - name: Install dependencies
         run: flutter pub get
 
+      - uses: actions/checkout@v3
+      - name: Set up git
+        run: |
+          git config user.name "GitHub Actions Bot"
+          git config user.email "<>"
+
       - name: Format code
-        run: dart format --set-exit-if-changed .
+        run: |
+          dart format .
+          if [ $? -eq 1 ]; then
+            git add .
+            git commit -m "chore: formatting corrections"
+            git push
+            echo "Code has been formatted and changes have been committed and pushed."
+          fi
+          echo "All code is properly formatted!"
 
       - name: Analyze code
         run: flutter analyze --fatal-infos .

.github/workflows/pana_analysis.yml

@@ -4,6 +4,7 @@ on: [pull_request, workflow_dispatch]
 jobs:
   package-analysis:
     runs-on: ubuntu-latest
+    if: github.base_ref != 'customer_testing'
 
     steps:
       - uses: actions/checkout@v3

.gitignore

@@ -15,7 +15,7 @@
 *.iws
 .idea/
 
-.vscode/launch.json
+.vscode
 
 # The .vscode folder contains launch configuration and tasks you configure in
 # VS Code which you may wish to be included in version control, so this line

CHANGELOG.md

@@ -1,3 +1,13 @@
+## [1.11.1]
+* Fixed an issue where the `MacosSearchField` would not perform an action when an item was selected.
+
+## [1.11.0]
+* 🚨 Breaking Changes 🚨
+* `ResizablePane` can now be vertically resized
+  * `ResizablePane.startWidth` has been changed to `ResizablePane.startSize`
+  * `ResizablePane.minWidth` has been changed to `ResizablePane.minSize`
+  * `ResizablePane.maxWidth` has been changed to `ResizablePane.maxSize`
+
 ## [1.10.0]
 🚨 Breaking Changes 🚨
 * `MacosScrollbar` has been completely overhauled and now resembles the native macOS scrollbar in appearance and

CONTRIBUTING.md

@@ -3,32 +3,38 @@
 Thanks for checking out `macos_ui`! We appreciate your interest in contributing! Here are some 
 basic things you'll need to know to get started.
 
-### Branch structure
+## Branch structure
 
 The default branch for this project is `dev`. Your work should take place in a branch checked out
 from here. `stable` is reserved for releases to pub.dev. All pull requests should therefore
 target `dev`.
 
-`dev` and `stable` are protected branches.
+`dev`, `stable`, and `customer_testing` are protected branches.
 
-### Commit style
+### The `stable` Branch
+This branch is solely for pub releases. Only authorized maintainers may make pull requests to this branch.
+
+### The `customer_testing` branch
+This branch is the ***only*** branch in this repository based on Flutter's `master` channel; every other branch is based on Flutter's `stable` channel. This is so that `macos_ui` can be included in Flutter's [tests](https://github.com/flutter/tests) repo. It is beneficial for `macos_ui` to be included there so that if any changes are introduced to Flutter that break `macos_ui`, we will be informed and can make the appropriate changes.
+
+Only authorized maintainers may make pull requests to this branch.
+
+## Commit style
 This repository uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). Please ensure that you use them!
 
-### Pull Requests
+## Pull Requests
 As mentioned above, all pull requests should target `dev`.
 
-#### Pre-launch script
-Before opening your pull request, run the `pr_prelaunch_tasks.sh` script to ensure that your changes meet the 
-following requirements:
+Before opening your pull request, please ensure that the following
+following requirements are met:
+* You have run `flutter pub get` at the package level
+* You have incremented the version number in `pubspec.yaml` properly
+* You have updated the `CHANGELOG.md` file accordingly
 * All code is properly formatted
 * There are no Dart analysis warnings
 * All tests pass
 
-If the format step of the script results in changes, the script will make those change, commit them, and prompt you to push the commit.
-
-If the `dart fix` step results in changes, the script will make those changes, commit them, and prompt you to push the commit.
-
-Pull requests should **always** be merged via GitHub and not via command-line.
+A note for authorized maintainers: Pull requests should **always** be merged via GitHub and not via command-line.
 
 ### Versioning
 

README.md

@@ -16,7 +16,10 @@ Guides, codelabs, and other documentation can be found at https://macosui.dev
 
 <img src="https://imgur.com/5mFQKBU.png" width="75%"/>
 
-## 🚨 Usage notes  
+## 🚨 Usage notes
+### <img src="https://storage.googleapis.com/cms-storage-bucket/0dbfcc7a59cd1cf16282.png" height="14"/> Flutter channel
+`macos_ui` is developed against Flutter's `stable` channel. To ensure a smooth development experience with `macos_ui`, you should build your application on Flutter's `stable` channel.
+
 ### <img src="https://storage.googleapis.com/cms-storage-bucket/0dbfcc7a59cd1cf16282.png" height="14"/> Platform Compatibility
 
 pub.dev shows that `macos_ui` only supports macOS. This is because `macos_ui` calls some native code, and therefore 
@@ -50,6 +53,7 @@ should avoid allowing your application window to be resized below the height of
 
 - [Layout](#layout)
   - [MacosWindow](#macoswindow)
+  - [Sidebar](#sidebar)
   - [MacosScaffold](#macosscaffold)
   - [Modern Window Look](#modern-window-look)
   - [ToolBar](#toolbar)
@@ -148,6 +152,56 @@ your `MacosScaffold` in a `Builder` widget in order for this to work properly.
 
 <img src="https://imgur.com/IBbp5rN.gif" width="75%">
 
+## Sidebar
+A sidebar enables app navigation and provides quick access to top-level collections of content in your app.
+
+Sidebars may be placed at the left or right of your app. To place a sidebar on the left, use the `MacosWindow.sidebar` property. To place a sidebar on the right, use the `MacosWindow.endSidebar` property.
+
+<img src="https://imgur.com/sz4VPNR.png" width="75%"/>
+
+Example usage:
+
+```dart
+int pageIndex = 0;
+
+...
+
+MacosWindow(
+  sidebar: Sidebar(
+    minWidth: 200,
+    builder: (context, scrollController) {
+      return SidebarItems(
+        currentIndex: pageIndex,
+        scrollController: scrollController,
+        itemSize: SidebarItemSize.large,
+        onChanged: (i) {
+          setState(() => pageIndex = i);
+        },
+        items: const [
+          SidebarItem(
+            label: Text('Page One'),
+          ),
+          SidebarItem(
+            label: Text('Page Two'),
+          ),
+        ],
+      );
+    },
+  ),
+  endSidebar: Sidebar(
+    startWidth: 200,
+    minWidth: 200,
+    maxWidth: 300,
+    shownByDefault: false,
+    builder: (context, _) {
+      return const Center(
+        child: Text('End Sidebar'),
+      );
+    },
+  ),
+),
+```
+
 ## MacosScaffold
 
 The `MacosScaffold` is what you might call a "page".
@@ -355,7 +409,7 @@ CustomToolbarItem(
 
 ## MacosListTile
 
-A widget that aims to approximate the [ListTile] widget found in
+A widget that aims to approximate the [`ListTile`](https://api.flutter.dev/flutter/material/ListTile-class.html) widget found in
 Flutter's material library.
 
 ![MacosListTile](https://imgur.com/pQB99M2.png)
@@ -862,10 +916,10 @@ You can set `discrete` to `true` to make it a discrete capacity indicator.
 
 A slider is a control that lets people select a value from a continuous or discrete range of values by moving the slider thumb.
 
- Continuous                                                                                                                                                         | Discrete                                                                                                                                                                                                         |
-|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| ![Continuous Slider Example](https://i.imgur.com/dc4YjoX.png) | ![Discrete Slider Example](https://i.imgur.com/KckOTUf.png)                                                                                   |
-| A horizontal slider where any value continuous value between a min and max can be selected | A horizontal slider where only discrete values between a min and max can be selected. Tick marks are often displayed to provide context. |
+ | Continuous                                                                                 | Discrete                                                                                                                                 |
+ | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
+ | ![Continuous Slider Example](https://i.imgur.com/dc4YjoX.png)                              | ![Discrete Slider Example](https://i.imgur.com/KckOTUf.png)                                                                              |
+ | A horizontal slider where any value continuous value between a min and max can be selected | A horizontal slider where only discrete values between a min and max can be selected. Tick marks are often displayed to provide context. |
 
 
 Here's an example of how to create an interactive continuous slider:

example/.gitignore

@@ -47,3 +47,4 @@ app.*.map.json
 /android/app/release
 
 /windows/
+linux/