show 0.3.2

  • Readme
  • Changelog
  • Example
  • Installing
  • 46

Show(Case) #

ShowCase your flutter app.

Screenshot

Getting Started #

To install show globally use: flutter pub global activate show

You will also have to add show to your dependencies:

devDependencies:
  show: <version>

Setup project #

The init command will create a showcase/ directory in your project root.

An entry showcase/showcase.dart will be created once. This file can be modified and will not be recreated as long as it exists.

show init

Creating show cases #

The showcases need to be created within the newly created showcase/ folder.

Whenever you've created new files containing showcases you will need to run show init again which will recreate showcase/showcase.g.dart. This is in order to update the files to be imported by the application.

If you modify existing showcases they will be hot reloaded just like any other widget.

Example show case:

showcase/controls.dart

import 'package:flutter/material.dart';
import 'package:show/show.dart';

void showCase(Show controls) {
  controls
    ..setTitle('Controls')
    ..setLayout(Layout.gridLayout)
    ..add('Card', {
      () => Card(
            color: Colors.orange,
          ),
      () => InkWell(
            onTap: action('Hello ShowCase'),
            child: Card(
              color: Colors.green,
            ),
          ),
      () => Card(
            color: Colors.yellow,
          ),
    })
    ..add('CircularProgressIndicator', {
      () => const CircularProgressIndicator(),
      () => const CircularProgressIndicator(
            backgroundColor: Colors.pink,
            strokeWidth: 10,
          ),
      () => const CircularProgressIndicator(
            value: 0.4,
          ),
    });
}

0.3.2 #

  • inject theme
  • change default layout

0.3.1 #

  • update menu styling

0.3.0 #

  • add tree menu
  • add logo
  • make title optional

0.2.1 #

  • update readme

0.2.0 #

  • hot reload show cases
  • fix font sizes

0.1.0 #

  • fix not generating showcase/showcase.dart
  • be less verbose

0.0.7 #

  • generate showcase/showcase.dart
  • improve showcase/showcase.g.dart

0.0.6 #

  • rename entry file to show.dart
  • export master detail container

0.0.5 #

  • only parse files in showcase/ dir

0.0.4 #

  • typos and set target dir to showcase/

0.0.3 #

  • read version from generated file

0.0.2 #

  • fix meta dependency conflict

0.0.1 #

  • initial release

example/README.md

example #

A new Flutter project.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate show

2. Use it

The package has the following executables:


$ show

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  show: ^0.3.2

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:show/show.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
5
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
46
Learn more about scoring.

We analyzed this package on Oct 18, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Fix lib/cli/command/init.dart. (-1 points)

Analysis of lib/cli/command/init.dart reported 2 hints:

line 3 col 1: 'package:analyzer/analyzer.dart' is deprecated and shouldn't be used.

line 149 col 17: 'parseCompilationUnit' is deprecated and shouldn't be used.

Maintenance issues and suggestions

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (analyzer).

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.2 <3.0.0
analyzer >=0.35.0 <0.38.0 0.37.1+1 0.38.5
args ^1.5.2 1.5.2
code_builder ^3.2.0 3.2.0
dart_style ^1.2.9 1.2.10 1.3.1
flutter 0.0.0
flutter_svg ^0.14.0 0.14.2
glob ^1.1.7 1.2.0
meta ^1.1.6 1.1.7
path ^1.6.2 1.6.4
Transitive dependencies
async 2.4.0
built_collection 4.2.2
built_value 6.7.1
charcode 1.1.2
collection 1.14.11 1.14.12
convert 2.1.1
crypto 2.1.3
csslib 0.16.1
fixnum 0.10.9
front_end 0.1.21+1 0.1.27
html 0.14.0+3
js 0.6.1+1
kernel 0.3.21+1 0.3.27
matcher 0.12.5
node_interop 1.0.3
node_io 1.0.1+2
package_config 1.1.0
path_drawing 0.4.1
path_parsing 0.1.4
pedantic 1.8.0+1
petitparser 2.4.0
pub_semver 1.4.2
quiver 2.0.5
sky_engine 0.0.99
source_span 1.5.5
stack_trace 1.9.3
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
vector_math 2.0.8
watcher 0.9.7+12
xml 3.5.0
yaml 2.2.0
Dev dependencies
flutter_test