flutter_material_showcase 1.0.0+4

  • Readme
  • Changelog
  • Example
  • Installing
  • 77

flutter_material_showcase #

Material Design components showcase for Flutter apps.

This project is based on Ataul's Material Design Components Showcase Android project, but for Flutter!

You can use this Flutter package to preview your ThemeData and see how it looks like with different Material Widgets.

image

Usage #

  1. Install

Include the library in your project pubspec.yaml:

dependencies:
  flutter_material_showcase: ^1.0.0

You can install packages from the command line:

$ flutter pub get

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

Now in your Dart code, you can use:

import 'package:flutter_material_showcase/flutter_material_showcase.dart';
  1. Add the MaterialShowcase Widget somewhere in your app:
MaterialApp(
  title: 'Flutter Demo',
  theme: ThemeData(
    primarySwatch: Colors.blue,
  ),
  home: Scaffold(
    body: ListView(
      children: <Widget>[
        MaterialShowcase(),
      ],
    ),
  ),
);
  1. Play with the different parameters in ThemeData and see how it looks like.

Contributing #

  • Additions to the MaterialShowcase Widget are welcome.
  • Documentation improvements are welcome.

License #

MIT License

Copyright (c) 2019 Miguel Beltran

[1.0.0+4] - Example README.md

  • Updated README.md for example app

[1.0.0+2] - Formatting and description

  • flutter_material_showcase.dart formatting
  • Added longer package description

[1.0.0+1] - README.md changes

  • Updated README.md

[1.0.0] - First release

  • Initial release

example/README.md

Example for flutter_material_showcase #

Run the project contained in example to check this package.

You can edit the contained ThemeData to try different cases:

theme: ThemeData(
  brightness: brightness,
  primarySwatch: Colors.blue,
),

Also, use the action on the top-right of the screen to switch between light and dark themes, and see how your app reacts to it.

Use this package as a library

1. Depend on it

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


dependencies:
  flutter_material_showcase: ^1.0.0+4

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:flutter_material_showcase/flutter_material_showcase.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
57
Health:
Code health derived from static analysis. [more]
95
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
77
Learn more about scoring.

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

  • Dart: 2.7.0
  • pana: 0.13.1+4
  • Flutter: 1.12.13+hotfix.4

Health issues and suggestions

Fix lib/flutter_material_showcase.dart. (-5 points)

Analysis of lib/flutter_material_showcase.dart reported 1 warning:

line 107 col 9: The parameter 'groupValue' is required. .

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test