Skip to content

Commit

Permalink
Release 1.4.1 pre
Browse files Browse the repository at this point in the history
  • Loading branch information
rydmike committed Jan 30, 2021
1 parent 3a31b9c commit 8aa32d1
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
15 changes: 5 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to the **FlexColorScheme** package will be documented in thi
## [1.4.1] - January 27, 2021

* Added four new built-in color schemes.
* **Barossa** - Barossa red and cardin green theme..
* **Barossa** - Barossa red and cardin green theme.
Use enum value `FlexScheme.barossa` for easy access to it.
* **Shark and orange** - Shark grey and orange ecstasy theme.
Use enum value `FlexScheme.shark` for easy access to it.
Expand All @@ -15,7 +15,7 @@ All notable changes to the **FlexColorScheme** package will be documented in thi
Use enum value `FlexScheme.damask` for easy access to it.

* Improved Semantics for the ThemeMode Widget buttons.
* Improved the widget tests, makes and checks for system mode changes. Totally 723 tests.
* Improved the widget tests, makes and checks for system mode changes. Totally 723 tests, codecov > 99.5%.
* Added GitHub actions to automate build and publish the examples on the web.
* Minor changes to the examples. Modified to not need the `late` keyword when they are converted
to null safe versions.
Expand Down Expand Up @@ -185,8 +185,7 @@ Feel free to open a [suggestion or issue](https://github.com/rydmike/flex_color_
- Version 2.0.0-nullsafety.1: Add first null safe version.
- Version 2.0.0-nullsafety.2: Add some minor new APIs and features (maybe).
- Version 2.0.0 Release official null-safe version, when nullsafety is available in Flutter stable channel.
- Version 2.0.1 Improve the tests further, after or together with the null-safe version.
- Version 2.1.0 Release more color schemes. Making schemes is fun, documenting the changes a bit less so.
- Version 2.1.0 Release even more color schemes. Making schemes is fun, documenting the changes a bit less so.
- Change the current "white" AppBarTheme implementation to new AppBarTheme when it lands in stable channel.
See https://github.com/flutter/flutter/pull/71184 and https://github.com/flutter/flutter/issues/72206. Will not impact
API or functionality, the implementation will only be changed to one that is supported directly by the SDK, so it
Expand All @@ -208,18 +207,14 @@ Feel free to open a [suggestion or issue](https://github.com/rydmike/flex_color_
- Version 1.4.0: Increased unit and widget test to 689 tests. All color definitions are now also tested to ensure
they will not be changed by any accidental edit. Test coverage is higher than 95%, certainly sufficient for this
type of package, but there are still some areas that could and will be improved.
- Version 1.4.1 Consider testing sufficient for now.
- Version 1.4.1 Added automated build and publish pipes for the Web examples!

### MAYBE
- **Companion Web App**
I started playing with a small companion app that will allow you to design `FlexColorSchemes` and copy-paste the
needed setup code into an app. If/when I finnish it, I will release it as live version with open source code as well.

- **Automate the web example builds**
Currently, the build and test pipeline are the same that include the test code coverage report. While the tests do
include a test of a minimal app, I would like to set up a separate build that can be run after a package update, but
also when there is a new Flutter release on stable and beta channels. It should build all five example apps for Web
and publishes them on GitHub Pages.

- **Branded surface customization**
Add API offering more flexibility and customization capabilities to the surface branding.

Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
color branding on surfaces. The created themes are based on the same concept as Flutter's ColorScheme based themes,
but with a few interesting twists and convenience features.

For some addtional information about **FlexColorScheme**, its background and use cases, this package companion
For some additional information about **FlexColorScheme**, its background and use cases, this package companion
[**blog post and article**](https://rydmike.com/colorscheme) is also recommended reading.

<img src="https://github.com/rydmike/flex_color_scheme/blob/master/resources/CollageSize50.png?raw=true" alt="ColorScheme Intro"/>
Expand Down Expand Up @@ -94,8 +94,8 @@ There is a helper class with a factory `FlexSchemeColor.from` that can do this f
create a computed matching dark scheme from a defined light scheme, this is done with `FlexSchemeColor.toDark`.
This works regardless of if you created a fully specified custom light scheme, or one from just a single color.
These features are presented and explained in tutorial
[example 4](#example-4-switch-between-all-built-in-color-schemes-and-three-custom-ones) and
[example 5](#example-5-full-featured-demo).
[example 4](#example-4---switch-between-built-in-color-schemes-and-custom-ones) and
[example 5](#example-5---full-featured-demo).

### What About My Own Theme Additions?

Expand Down Expand Up @@ -306,6 +306,10 @@ With them you can see the active theme's colors, and the created theme's impact

<img src="https://github.com/rydmike/flex_color_scheme/blob/master/resources/fcs_phone_ex1al.png?raw=true" alt="ColorScheme example 1 light" width="180"/><img src="https://github.com/rydmike/flex_color_scheme/blob/master/resources/fcs_phone_ex1bl.png?raw=true" alt="ColorScheme example 1 lightb" width="180"/><img src="https://github.com/rydmike/flex_color_scheme/blob/master/resources/fcs_phone_ex1cl.png?raw=true" alt="ColorScheme example 1 dark" width="180"/>

The default sample app, example 1, just shows the simplest use-case of FlexColorScheme and barely scratches the
surface of what it can do. To get the full details in a step by step progression you should go through the tutorial
that uses examples 1 through 5 to introduce more features in a step by step complexity progression.

> **Building the examples**
>If you cloned the repository to build the examples, you can open the package `/example` folder with your IDE to build
>the above default example. This example is the same as the example in the `/example/lib/example1` folder.
Expand Down Expand Up @@ -937,7 +941,7 @@ have matching background and theme mode that matches the active application them
how this can be fixed and that the used method remain in effect when opening a subpage.

The same custom color schemes as in example 4, are also used in this example. They are not explained here again, please
see [example 4](#example-4-switch-between-all-built-in-color-schemes-and-three-custom-ones) for details.
see [example 4](#example-4---switch-between-built-in-color-schemes-and-custom-ones) for details.
The full example code is not shown here either, please see the code in the package folder
[flex_color_scheme/example/lib/example5](https://github.com/rydmike/flex_color_scheme/tree/master/example/lib/example5/main.dart)
for the entire example's code.
Expand Down Expand Up @@ -1880,7 +1884,7 @@ are, as well as the rationale behind the made design choices and changes to the
an annotated region for the system navigation bar that uses
the active color scheme and theme mode to make use
a correctly colored theme colored background for the active theme.
See [example 5](#example-5-full-featured-demo) for an explanation
See [example 5](#example-5---full-featured-demo) for an explanation
on how to use this.
## Appendix A - Built-in Scheme Reference
Expand Down
1 change: 1 addition & 0 deletions example/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: flex_color_scheme_example
description: Five examples that demonstrate how to use the FlexColorScheme package.
version: 1.4.1
publish_to: 'none'
environment:
sdk: ">=2.7.0 <3.0.0"

Expand Down

0 comments on commit 8aa32d1

Please sign in to comment.