feat: adding a basic gallery brick (#100)

* feat: adding a basic gallery brick

* some updates for latest flutter version

* removing unused files and improving readme

.github/workflows/main.yml

@@ -17,7 +17,7 @@ jobs:
         with:
           channel: 'stable'
           cache: true
-      - run: flutter format --set-exit-if-changed lib test
+      - run: dart format --set-exit-if-changed lib test
 
   analyze:
     runs-on: ubuntu-latest

README.md

@@ -18,6 +18,10 @@ Add the dependency to your `pubspec.yaml`
 dashbook: ^0.1.12
 ```
 
+> Tip ℹ️: If you use [mason](https://pub.dev/packages/mason_cli), a basic Dashbook brick called
+`dashbook_gallery` is available in brickhub.dev, which creates a basic gallery in seconds.
+
+
 A `Dashbook` instance has a collection of the app widgets (Stories) and its variants (Chapters). Here you can see a very simple example of how to use it.
 
 ```dart

bricks/dashbook_gallery/README.md

@@ -0,0 +1,13 @@
+# dashbook_gallery
+
+[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
+
+Creates a simple, opionated structure for a [Dashbook](https://github.com/bluefireteam/dashbook)
+based gallery for your Flutter Application.
+
+Note that this brick does not include any platform folders, so in order to run it, be sure to
+create the desired platforms:
+
+```sh
+flutter create . --platforms ...
+```

bricks/dashbook_gallery/__brick__/gallery/README.md

@@ -0,0 +1,3 @@
+# Gallery
+
+Dashbook based gallery sandbox.

bricks/dashbook_gallery/__brick__/gallery/analysis_options.yaml

@@ -0,0 +1,4 @@
+include: package:very_good_analysis/analysis_options.5.0.0.yaml
+linter:
+  rules:
+    public_member_api_docs: false

bricks/dashbook_gallery/__brick__/gallery/lib/main.dart

@@ -0,0 +1,11 @@
+import 'package:dashbook/dashbook.dart';
+import 'package:flutter/material.dart';
+import 'package:gallery/widgets/widgets.dart';
+
+void main() {
+  final dashbook = Dashbook();
+
+  addTextStories(dashbook);
+
+  runApp(dashbook);
+}

bricks/dashbook_gallery/__brick__/gallery/lib/widgets/text.dart

@@ -0,0 +1,47 @@
+import 'package:dashbook/dashbook.dart';
+import 'package:flutter/material.dart';
+
+void addTextStories(Dashbook dashbook) {
+  dashbook
+      .storiesOf('Text')
+      .decorator(CenterDecorator())
+      .add(
+        'default',
+        (context) => Text(
+          context.textProperty('text', 'Hello'),
+        ),
+      )
+      .add(
+        'with style',
+        (_) => const Text(
+          'Hello world',
+          style: TextStyle(
+            color: Colors.blue,
+            fontSize: 20,
+            fontWeight: FontWeight.bold,
+          ),
+        ),
+      )
+      .add(
+        'with overflow',
+        (_) => const SizedBox(
+          width: 100,
+          child: Text(
+            'Hello world'
+            'Hello world'
+            'Hello world'
+            'Hello world'
+            'Hello world'
+            'Hello world'
+            'Hello world'
+            'Hello world'
+            'Hello world'
+            'Hello world'
+            'Hello world'
+            'Hello world'
+            'Hello world',
+            overflow: TextOverflow.ellipsis,
+          ),
+        ),
+      );
+}

bricks/dashbook_gallery/__brick__/gallery/lib/widgets/widgets.dart

@@ -0,0 +1 @@
+export 'text.dart';

bricks/dashbook_gallery/__brick__/gallery/pubspec.yaml

@@ -0,0 +1,16 @@
+name: gallery
+publish_to: none
+
+environment:
+  sdk: '>=3.0.6 <4.0.0'
+
+dependencies:
+  dashbook: ^0.1.12
+  flutter:
+    sdk: flutter
+
+dev_dependencies:
+  very_good_analysis: ^5.1.0
+
+flutter:
+  uses-material-design: true

bricks/dashbook_gallery/brick.yaml

@@ -0,0 +1,7 @@
+name: dashbook_gallery
+description: Creates a simple dashbook gallery app with a minimal structure to get started.
+
+version: 0.1.0+1
+
+environment:
+  mason: ">=0.1.0-dev.50 <0.1.0"

example/lib/stories.dart

@@ -133,7 +133,7 @@ void addStories(Dashbook dashbook) {
             children: [
               Text(
                 'Using DateTimeProperty:',
-                style: Theme.of(context).textTheme.headline6,
+                style: Theme.of(context).textTheme.titleLarge,
               ),
               Text(
                 DateTimePropertyView.dateFormat.format(
@@ -148,7 +148,7 @@ void addStories(Dashbook dashbook) {
               const Divider(),
               Text(
                 'Using anonymous property widget builder:',
-                style: Theme.of(context).textTheme.headline6,
+                style: Theme.of(context).textTheme.titleLarge,
               ),
               Text(
                 DateTimePropertyView.dateFormat.format(

example/pubspec.yaml

@@ -6,10 +6,9 @@ version: 1.0.0+1
 publish_to: none
 
 environment:
-  sdk: ">=2.18.0 <3.0.0"
+  sdk: ">=2.18.0 <4.0.0"
 
 dependencies:
-  cupertino_icons: ^0.1.2
   dashbook:
     path: ../
   flutter:

lib/src/widgets/actions_container.dart

@@ -23,7 +23,7 @@ class ActionsContainer extends StatelessWidget {
       onCancel: onCancel,
       child: Column(
         children: [
-          for (MapEntry<String, void Function(BuildContext)> entry
+          for (final MapEntry<String, void Function(BuildContext)> entry
               in currentChapter.ctx.actions.entries)
             Padding(
               padding: const EdgeInsets.all(8),

lib/src/widgets/device_settings_container.dart

@@ -105,7 +105,7 @@ class _DeviceToggles extends StatelessWidget {
         TextButton(
           onPressed: deviceSettings.reset,
           child: const Text('Reset'),
-        )
+        ),
       ],
     );
   }

lib/src/widgets/property_widgets/widgets/property_4_integer_form.dart

@@ -77,7 +77,7 @@ class _FourIntegerFormState extends State<FourIntegerForm> {
       widget._value1,
       widget._value2,
       widget._value3,
-      widget._value4
+      widget._value4,
     ];
     return values.every((v) => v == values[0]);
   }

lib/src/widgets/property_widgets/widgets/property_scaffold.dart

@@ -34,7 +34,7 @@ class PropertyScaffold extends StatelessWidget {
                   )
                 : Text(label),
           ),
-          Expanded(flex: 6, child: child)
+          Expanded(flex: 6, child: child),
         ],
       ),
     );

lib/src/widgets/select_device/select_device.dart

@@ -10,8 +10,8 @@ class SelectDevice extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
-    return Column(
-      children: const [
+    return const Column(
+      children: [
         DevicePropertyScaffold(
           label: 'Select a device frame:',
           child: DeviceDropdown(),
@@ -54,7 +54,7 @@ class DevicePropertyScaffold extends StatelessWidget {
                   )
                 : Text(label),
           ),
-          Expanded(flex: 6, child: child)
+          Expanded(flex: 6, child: child),
         ],
       ),
     );

lib/src/widgets/stories_list.dart

@@ -130,7 +130,7 @@ class _StoriesListState extends State<StoriesList> {
                 controller: _filterTextController,
               ),
             ),
-            for (Story story in widget.stories)
+            for (final Story story in widget.stories)
               if (_storyMatchesFilter(story))
                 ExpansionTile(
                   key: PageStorageKey('story_${story.name}'),
@@ -143,7 +143,7 @@ class _StoriesListState extends State<StoriesList> {
                   ),
                   initiallyExpanded: true,
                   children: [
-                    for (Chapter chapter in story.chapters)
+                    for (final Chapter chapter in story.chapters)
                       if (_matchesFilter(story.name) ||
                           _matchesFilter(chapter.name))
                         Align(

pubspec.yaml

@@ -4,7 +4,7 @@ version: 0.1.12
 homepage: https://github.com/bluefireteam/dashbook
 
 environment:
-  sdk: ">=2.18.0 <3.0.0"
+  sdk: ">=2.18.0 <4.0.0"
 
 dependencies:
   device_frame: ^1.0.0

test/properties/list_property_test.dart

@@ -12,7 +12,7 @@ Dashbook _getDashbook() {
     return Text(
       'Current: ${ctx.listProperty('listValue', 'ValueX', [
             'ValueX',
-            'ValueY'
+            'ValueY',
           ])}',
     );
   });