flutter_dialogs 1.0.3

  • Readme
  • Changelog
  • Example
  • Installing
  • 85

flutter_dialogs #

A lightweight and platform-aware plugin for showing dialogs and alerts for both Android and iOS devices.

Features #

  • Platform aware
  • Extendable widgets
  • Lightweight < 28 KB

Usage #

Sample Alert

showPlatformDialog(
  context: context,
  builder: (_) => BasicDialogAlert(
    title: Text("Current Location Not Available"),
    content:
        Text("Your current location cannot be determined at this time."),
    actions: <Widget>[
      BasicDialogAction(
        title: Text("OK"),
        onPressed: () {
          Navigator.pop(context);
        },
      ),
    ],
  ),
);

Output

iOSAndroid
ios-basic-dialog-alertandroid-basic-dialog-alert

Sample Confirmation

showPlatformDialog(
  context: context,
  builder: (_) => BasicDialogAlert(
    title: Text("Discard draft?"),
    content: Text("Action cannot be undone."),
    actions: <Widget>[
      BasicDialogAction(
        title: Text("Cancel"),
        onPressed: () {
          Navigator.pop(context);
        },
      ),
      BasicDialogAction(
        title: Text("Discard"),
        onPressed: () {
          Navigator.pop(context);
        },
      ),
    ],
  ),
);

Output

iOSAndroid
ios-basic-dialog-confirmationandroid-basic-dialog-confirmation

Sample List

showPlatformDialog(
  context: context,
  builder: (_) => BasicDialogAlert(
    title: Text("Select account"),
    content: Container(
      height: 200,
      child: ListView(
        children: <Widget>[
          _buildListSampleItem("contact@jdg.ph"),
          _buildListSampleItem("hello@gmail.com"),
          _buildListSampleItem("hi@joshuadeguzman.net"),
          _buildListSampleItem("jdeguzman@freelancer.com"),
        ],
      ),
    ),
    actions: <Widget>[
      BasicDialogAction(
        title: Text("Cancel"),
        onPressed: () {
          Navigator.pop(context);
        },
      ),
    ],
  ),
);

Output

iOSAndroid
ios-basic-dialog-listandroid-basic-dialog-list

License #

MIT @joshuadeguzman

[1.0.3] - March 28, 2020 #

  • Documentation fixes

[1.0.2] - January 21, 2020 #

  • Update some formatting
  • Update description in pubspec.yaml

[1.0.1] - January 21, 2020 #

  • Fix broken table in README

[1.0.0] - January 21, 2020 #

  • Major code refactoring

[0.0.1+2] - October 5, 2019 #

  • Documentation fixes

[0.0.1+1] - October 5, 2019 #

  • Initial attempt to make platform aware dialog and alert widgets
  • Added FDBasicDialog and other core utilities

example/lib/main.dart

import 'dart:io';

import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';
import 'package:flutter_dialogs/flutter_dialogs.dart';

void main() => runApp(ExampleApp());

class ExampleApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Dialogs Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        platform: TargetPlatform.iOS,
      ),
      home: ExampleScreen(),
    );
  }
}

class ExampleScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            RaisedButton(
              onPressed: () {
                _showAlert(context);
              },
              child: const Text("Show Alert"),
            ),
            RaisedButton(
              onPressed: () {
                _showConfirmationAlert(context);
              },
              child: const Text("Show Confirmation Alert"),
            ),
            RaisedButton(
              onPressed: () {
                _showListAlert(context);
              },
              child: const Text("Show List Alert"),
            ),
          ],
        ),
      ),
    );
  }

  _showAlert(BuildContext context) {
    showPlatformDialog(
      context: context,
      builder: (_) => BasicDialogAlert(
        title: Text("Current Location Not Available"),
        content:
            Text("Your current location cannot be determined at this time."),
        actions: <Widget>[
          BasicDialogAction(
            title: Text("OK"),
            onPressed: () {
              Navigator.pop(context);
            },
          ),
        ],
      ),
    );
  }

  _showConfirmationAlert(BuildContext context) {
    showPlatformDialog(
      context: context,
      builder: (_) => BasicDialogAlert(
        title: Text("Discard draft?"),
        content: Text("Action cannot be undone."),
        actions: <Widget>[
          BasicDialogAction(
            title: Text("Cancel"),
            onPressed: () {
              Navigator.pop(context);
            },
          ),
          BasicDialogAction(
            title: Text("Discard"),
            onPressed: () {
              Navigator.pop(context);
            },
          ),
        ],
      ),
    );
  }

  _showListAlert(BuildContext context) {
    showPlatformDialog(
      context: context,
      builder: (_) => BasicDialogAlert(
        title: Text("Select account"),
        content: Container(
          height: 200,
          child: ListView(
            children: <Widget>[
              _buildListSampleItem("contact@jdg.ph"),
              _buildListSampleItem("hello@gmail.com"),
              _buildListSampleItem("hi@joshuadeguzman.net"),
              _buildListSampleItem("jdeguzman@freelancer.com"),
            ],
          ),
        ),
        actions: <Widget>[
          BasicDialogAction(
            title: Text("Cancel"),
            onPressed: () {
              Navigator.pop(context);
            },
          ),
        ],
      ),
    );
  }

  Widget _buildListSampleItem(String title) {
    return Container(
      height: 30,
      margin: EdgeInsets.only(bottom: 16),
      child: Row(
        children: <Widget>[
          CircleAvatar(),
          SizedBox(width: 8),
          Text(
            title,
            style: TextStyle(fontSize: 12),
          )
        ],
      ),
    );
  }
}

Use this package as a library

1. Depend on it

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


dependencies:
  flutter_dialogs: ^1.0.3

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

We analyzed this package on Apr 3, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Health issues and suggestions

Document public APIs. (-1 points)

26 out of 26 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/src/basic_dialog_alert.dart. (-0.50 points)

Analysis of lib/src/basic_dialog_alert.dart reported 1 hint:

line 22 col 7: This class (or a class which this class inherits from) is marked as '@immutable', but one or more of its instance fields are not final: BasicDialogAlert.title, BasicDialogAlert.content, BasicDialogAlert.actions, BasicDialogAlert.android, BasicDialogAlert.ios

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