Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version 1.11.1 #366

Merged
merged 24 commits into from
Feb 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
aec6f25
Version 1.7.1 (#287)
GroovinChip Jul 27, 2022
fd8d3ed
Version 1.7.3 (#293)
GroovinChip Aug 17, 2022
de69606
Version 1.7.4 (#295)
GroovinChip Aug 20, 2022
c177f19
Version 1.7.5 (#299)
GroovinChip Sep 5, 2022
ae5dc52
Version 1.7.6 (#327)
GroovinChip Jan 14, 2023
b55c500
Version 1.9.0 (#339)
GroovinChip Feb 3, 2023
02cd183
Version 1.9.1 (#341)
GroovinChip Feb 3, 2023
17982c8
Merge branch 'stable' into dev
GroovinChip Feb 13, 2023
99d8196
chore: update gitignore
GroovinChip Feb 15, 2023
afe615b
chore: update pr template
GroovinChip Feb 16, 2023
dbc4770
chore: update contributing.md & remove scripts
GroovinChip Feb 16, 2023
427c773
feat: update `flutter_analysis` workflow (#356)
GroovinChip Feb 16, 2023
6d57a89
docs: update README
GroovinChip Feb 16, 2023
10dda17
docs(ToolBar): update dartdocs
GroovinChip Feb 16, 2023
b631898
Bottom resizable pane (#349)
stMerlHin Feb 20, 2023
ab13cdc
docs: add usage note regarding Flutter channel
GroovinChip Feb 20, 2023
5f93e14
chore(actions): update `flutter_analysis.yaml`
GroovinChip Feb 20, 2023
caf6598
fix: SearchField overlay actions are not performed (#357)
FelixMethe Feb 20, 2023
1e2bd14
Merge branch 'customer_testing' into 1.11.1-customer-testing
GroovinChip Feb 20, 2023
bd170da
address lints
GroovinChip Feb 20, 2023
bc8ac9a
chore(actions): use master channel
GroovinChip Feb 20, 2023
f198d50
disable pana check on customer_testing branch
GroovinChip Feb 20, 2023
53a7417
chore(actions): job-level "if"
GroovinChip Feb 21, 2023
51dee27
chore(actions): do not run pana action for customer_testing branch
GroovinChip Feb 21, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
18 changes: 16 additions & 2 deletions .github/workflows/flutter_analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,27 @@ jobs:
- name: Install Flutter
uses: subosito/flutter-action@v2
with:
channel: stable
channel: master

- 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 .
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/pana_analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 2 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,12 @@ This repository uses [conventional commits](https://www.conventionalcommits.org/
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:
* 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.

### Versioning
Expand Down
66 changes: 60 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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".
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions example/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,4 @@ app.*.map.json
/android/app/release

/windows/
linux/
Loading