Unify examples structure (#1118)

* Animations, CameraAndViewport, CollisionDetection and Components unified

* Added descriptions to effects

* Rename input games

* Unify input stories

* Add info to parallax section

* Added descriptions to the rendering examples

* Add descriptions to the sprites directory

* Fix utils and rendering section

* Add descriptions to the widgets section

* Delete directory that rebase brought back

* Unify game names

* Added some styleguide docs for examples

* Fix analyze issues

* All files should have _example as suffix

* Made the FollowComponentExample a bit easier to understand

* Change priority of ember
This commit is contained in:
Lukas Klingsbo
2021-11-19 14:28:04 +01:00
committed by GitHub
parent 904481d289
commit 8b132d7c0b
90 changed files with 1574 additions and 1140 deletions

View File

@ -1,13 +1,12 @@
import 'package:dashbook/dashbook.dart';
import '../../commons/commons.dart';
import 'custom_painter_component.dart';
import 'nine_tile_box.dart';
import 'overlay.dart';
import 'sprite_animation_widget.dart';
import 'sprite_button.dart';
import 'sprite_widget.dart';
import 'sprite_widget_section.dart';
import 'custom_painter_example.dart';
import 'nine_tile_box_example.dart';
import 'partial_sprite_widget_example.dart';
import 'sprite_animation_widget_example.dart';
import 'sprite_button_example.dart';
import 'sprite_widget_example.dart';
void addWidgetsStories(Dashbook dashbook) {
dashbook.storiesOf('Widgets')
@ -15,37 +14,57 @@ void addWidgetsStories(Dashbook dashbook) {
..add(
'Nine Tile Box',
nineTileBoxBuilder,
codeLink: baseLink('widgets/nine_tile_box.dart'),
codeLink: baseLink('widgets/nine_tile_box_example.dart'),
info: '''
If you want to create a background for something that can stretch you
can use the `NineTileBox` which is showcased here, don't forget to check
out the settings on the pen icon.
''',
)
..add(
'Sprite Button',
spriteButtonBuilder,
codeLink: baseLink('widgets/sprite_button.dart'),
codeLink: baseLink('widgets/sprite_button_example.dart'),
info: '''
If you want to use sprites as a buttons within the flutter widget tree
you can create a `SpriteButton`, don't forget to check out the settings
on the pen icon.
''',
)
..add(
'Sprite Widget (full image)',
spriteWidgetBuilder,
codeLink: baseLink('widgets/sprite_widget.dart'),
codeLink: baseLink('widgets/sprite_widget_example.dart'),
info: '''
If you want to use a sprite within the flutter widget tree
you can create a `SpriteWidget`, don't forget to check out the settings
on the pen icon.
''',
)
..add(
'Sprite Widget (section of image)',
spriteSectionWidgetBuilder,
codeLink: baseLink('widgets/sprite_widget_section.dart'),
partialSpriteWidgetBuilder,
codeLink: baseLink('widgets/partial_sprite_widget_example.dart'),
info: '''
In this example we show how you can render only parts of a sprite within
a `SpriteWidget`, don't forget to check out the settings on the pen
icon.
''',
)
..add(
'Sprite Animation Widget',
spriteAnimationWidgetBuilder,
codeLink: baseLink('widgets/sprite_animation_widget.dart'),
)
..add(
'Overlay',
overlayBuilder,
codeLink: baseLink('widgets/overlay.dart'),
codeLink: baseLink('widgets/sprite_animation_widget_example.dart'),
info: '''
If you want to use a sprite animation directly on the flutter widget
tree you can create a `SpriteAnimationWidget`, don't forget to check out
the settings on the pen icon.
''',
)
..add(
'CustomPainterComponent',
customPainterBuilder,
codeLink: baseLink('widgets/custom_painter_component.dart'),
info: CustomPainterGame.info,
codeLink: baseLink('widgets/custom_painter_example.dart'),
info: CustomPainterExample.description,
);
}