Skip to content

Commit

Permalink
[add] bricks/
Browse files Browse the repository at this point in the history
            - with a beam_location brick
  • Loading branch information
slovnicki committed May 2, 2022
1 parent 3ed19b6 commit b3470b8
Show file tree
Hide file tree
Showing 5 changed files with 108 additions and 0 deletions.
3 changes: 3 additions & 0 deletions bricks/beam_location/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 0.1.0

- Initial release
21 changes: 21 additions & 0 deletions bricks/beam_location/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Sandro Lovnički

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
47 changes: 47 additions & 0 deletions bricks/beam_location/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Beam Location

Generates a `BeamLocation` for the [Beamer package](https://pub.dev/packages/beamer).

## Usage

```sh
mason make beam_location --name my
```

## Variables

| Variable | Description | Default | Type |
| -------- |---------------------------------------| ------- | -------- |
| `name` | The name for the `BeamLocation` class | `my` | `string` |

## Output

```sh
└── my_beam_location.dart
```

```dart
import 'package:flutter/widgets.dart';
import 'package:beamer/beamer.dart';
class MyBeamLocation extends BeamLocation<BeamState> {
@override
List<Pattern> get pathPatterns => ['/my'];
@override
List<BeamPage> buildPages(BuildContext context, BeamState state) {
final pages = [
const BeamPage(
key: ValueKey('home'),
child: HomeScreen(), // TODO
),
if (state.uri.pathSegments.contains('my'))
const BeamPage(
key: ValueKey('my'),
child: MyScreen(), // TODO
),
];
return pages;
}
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import 'package:flutter/widgets.dart';
import 'package:beamer/beamer.dart';

class {{name.pascalCase()}}BeamLocation extends BeamLocation<BeamState> {
@override
List<Pattern> get pathPatterns => ['/{{name.paramCase()}}'];

@override
List<BeamPage> buildPages(BuildContext context, BeamState state) {
final pages = [
const BeamPage(
key: ValueKey('home'),
child: HomeScreen(), // TODO
),
if (state.uri.pathSegments.contains('{{name.paramCase()}}'))
const BeamPage(
key: ValueKey('{{name.paramCase()}}'),
child: {{name.pascalCase()}}Screen(), // TODO
),
];
return pages;
}
}
14 changes: 14 additions & 0 deletions bricks/beam_location/brick.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: beam_location
description: Generates a BeamLocation for the Beamer package.
version: 0.1.0+1
repository: https://github.com/slovnicki/beamer/tree/master/bricks/beam_location

environment:
mason: ">=0.1.0-dev <0.1.0"

vars:
name:
type: string
description: The name for the BeamLocation class
default: My
prompt: What is the name of BeamLocation?

0 comments on commit b3470b8

Please sign in to comment.