platty 0.0.9+1

  • Readme
  • Changelog
  • Example
  • Installing
  • 70

platty #

Platform Conforming Widgets for Flutter!

Flutter makes no attempt to provide familiar widgets for a specific platform (unlike React Native, ionic, and other cross platform tooling). This has enormous benefits to unified rendering on all platforms, maximum flexibility, and eliminating a whole class of bugs and testing done for each platform. While this is great, many scenarios we want our apps to look and feel like an Android or iOS app. Platty allows you to render iOS (Cupertino) and Android (Material) like widgets with minimal effort and maximum control in a unified API.

No more checking for platform inside render blocks to render a CupertinoButton or FlatButton, let platty do the logic for you! Want to use bottom tabs in your app that resolve to platform specific UI? No problem!

Widgets #

List of Widget Files:

PAlertDialog

PBackButton

PButton/PFlatButton

PNavigationBar/PSliverNavigationBar

PActivityIndicator

PRoute

PScaffold

PSlider

PSwitch

PTabBar

PTextField

Getting Started #

Use platty to unify render-specific APIs for you. The library utilizes the BuildContext theming APIs to propagate platform information into the Widgets.

By default, all widgets conform to the default TargetPlatform. It looks up the Theme.of(context).platform for its default. Also, all widgets provide a renderPlatform prop that allows you to choose which one to render (if you wish).

Replace MaterialApp and CupertinoApp with PlatformApp:


class MyApp extends StatelessWidget {
  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return PlatformApp(
      title: 'Flutter Demo',
      // specify our app theme here. We do the leg work of bridging it to Cupertino.
      unifiedTheme: ThemeData(
            colorScheme: ColorScheme.fromSwatch(primarySwatch: Colors.red),
            bottomAppBarColor: Colors.red,
          ),
      home: ExamplePage(),
    );
  }
}

PlatformApp unifies all of the same properties between MaterialApp and CupertinoApp to allow both instances of widgets in the hiearchy and switching styling based on platform.

Now you replace widgets that are included in this library with their "P" counterparts:

Buttons #

Button/CupertinoButton -> PButton Source

FlatButton/CupertinoButton -> PFlatButton Source

Below is a side-by-side comparison of the different button states. Note how iOS and Android have similar theming.

Button Example

AppBar/CupertinoNavigationBar -> PNavigationBar

Android Nav iOS Nav

By default, the PNavigationBar on iOS will mirror Material Android theming. This means button tint and text style of the title will match. If you wish to change that, set iosMirrorAndroid: false. Otherwise it will default to cupertino theming:

Plain iOS Nav

Source

SliverAppBar/CupertinoSliverNavigationBar -> PSliverNavigationBar

Sliders #

Slider/CupertinoSlider -> PSlider

Sliders

Source

Switches #

Switch/CupertinoSwitch -> PSwitch

Switch

Source

Inputs #

TextField/CupertinoTextField -> PTextField

TextField

By default, the PTextField on iOS will mirror Android styling and decoration (map OutlineInputBorder to a similar outline for iOS). Also PTextField on iOS will show helperText and errorText (even though not native iOS widget).

Bottom Navigation #

BottomNavigationBar/CupertinoTabBar -> PTabBar

Bottom Navigation Android Bottom Navigation iOS

Source

Scaffold #

Scaffold/CupertinoScaffold -> PScaffold

Progress Indicators #

CircularProgressIndicator/CupertinoActivityIndicator -> PActivityIndicator

Progress

Source

Back Button #

BackButton/CupertinoNavigationBarBackButton -> PBackButton

Alerts #

AlertDialog/CupertinoAlertDialog -> PAlertDialog

Android Alert Ios Alert

Source

The Alert expect a List<Widget>. When feeding PFlatButton, utilize the helper methods to theme the buttons properly for iOS:

PAlertDialog(
  title: Text("Sample Alert"),
  content:
      Text("I can adapt based on target platform defaults, PTheme wrapper, "
          "or individual render platform overrides."),
  actions: <Widget>[
    PFlatButton.alertPrimary(
      text: "Ok",
      onPressed: () {
        Navigator.of(context).pop();
      },
    ),
    PFlatButton.alertSecondary(
      text: "Cancel",
      onPressed: () {
        Navigator.of(context).pop();
      },
    )
  ],
)

Properties Specific to a platform have a prefix #

Any widgets that have ios-only or android-only counterparts, they are prefixed to android/ios accordingly:

For example PButton, androidShape applies to RaisedButton.shape property. It does not exist on a CupertinoButton. However CupertinoButton has a borderRadius and pressedOpacity. Those two props become iosBorderRadius and iosPressedOpacity.

Helpers #

This library bundles a few standard functions to easily return code that is unique for each platform. Instead of checking
and switching on the result of Theme.of(context).targetPlatform, utilize the following methods:

Specific Platform Instance #

To have a specific P-Widget utilize a specific platform theme only, such as Material or Cupertino, you can wrap it in a PTheme instance:

PTheme(
  data: PThemeData(
    platform: TargetPlatform.android,  // or iOS
    child: child,
  ),
);

Or, more simply, utilize helper method:

PTheme.ios(child);
PTheme.android(child);

Also, all P-widgets and methods allow you to override the PTheme with a renderPlatform parameter in their constructor or calling method:

PButton("Hello Android", 
  renderPlatform: TargetPlatform.Android,
)

This will swap the rendering over to Material widgets for this specific widget.

Note: Wrapping a widget with the PTheme will propagate that instance down the widget hierarchy and is thus preferred than manually specifying the renderPlatform for each individual widget.

Creating Your Own Platform-Adapting Widgets #

We can extend upon the logic included in this library to build our own, powerful platform-adapting widgets. Included in the library is the PlatformAdaptingWidget base class, which inherits from StatelessWidget.

class SamplePlatformWidget extends PlatformAdaptingWidget {
  final Color color;

  SamplePlatformWidget({Key key, @required this.color, TargetPlatform renderPlatform}) // should allow consumers to choose TargetPlatform
      : super(key: key, renderPlatform: renderPlatform);

  /// Render a material widget here. Most Material widgets require a Material Theme instance above it.
  @override
  get renderMaterial => (BuildContext context) {
        return BackButton(
          color: color,
        );
      };

  /// Render a cupertino widget here.
  @override
  get renderCupertino => (BuildContext context) {
        return CupertinoNavigationBarBackButton(
          color: color,
        );
      };
  
  /// Render a fuchsia widget here. (defaults to material)
    @override
    get renderFuchsia => (BuildContext context) {
          return BackButton(
            color: color,
          );
        };
}

Platform-specific logic #

This library comes with a few standard ways to implement behavior based on platform. You can utilize platformWrap, which allows you to specify a child, and on 1 or all platforms, wrap it with another widget:

platformWrap(
      context,
      child: PButton(
        padding: EdgeInsets.all(0.0),
        child: Text(title),
        color: Colors.red,
        onPressed: () {
          Navigator.push(context, PRoute.of(context, builder: page));
        },
      ),
      renderCupertino: (context, child) => Padding(
            padding: EdgeInsets.only(bottom: 8.0),
            child: child,
          ),
    );

You can specify any of renderCupertino, renderMaterial, or renderFuschia (or none). Any render methods not specified default to the child.

Also, platformSelect is a helper that enables returning different objects based on platform in a unified way. In our PlatformAdaptingWidget, we utilize it to return a different widget based on platform. You can use it to return any return type based on platform:


Column(
  children: [
    platformSelect(context, 
      renderMaterial: (context) => Text("I am android"),
      renderCupertino: (context) => Text("I am iOS"),
      renderFuchsia: (context) => Text("I am FUCHSIA")) 
  ],
),

renderMaterial and renderCupertino are required. renderFuchsia defaults to material.

or you can return a non-widget too:

Column(
  children: [
    Text(platformSelect(context, 
      renderMaterial: (context) => "I am android"),
      renderCupertino: (context) => "I am iOS",
      renderFuchsia: (context) => "I am FUCHSIA")) 
  ],
),

[0.0.9+1] - 11/23/2019 #

Fix issue using Platform.isAndroid on Flutter web causes a crash:

Another exception was thrown: Failed assertion: boolean expression must not be null

This is due to a an issue with what is a platform

[0.0.9] - 10/28/2019 #

Unify button styling between platforms more easily

Added many more examples of buttons, alerts, nav, etc

NEW: Added PTextField with ability to use same between platforms in different visual paradigms

Updated readme

Rename PlatformRoute to PRoute

Add many missing passdown props on PButton/PFlatButton for Android configuration

Added AlertData which is used for PFlatButton to style in alert mode easily.

Update to Flutter 1.10.14.

[0.0.8] - 1/3/2018 #

FIX - issue where using navigatorObservers in the PlatformApp threw an exception since if one is reused in multiple instances, the framework will throw an exception. Now we utilize them in whatever the current render platform is only.

[0.0.7] - 1/2/2018 #

NEW - Upgrade to Flutter 1.1.4

NEW - all widgets are now marked private imports, meaning switch imports from:

import 'package:platty/widgets/alert.dart';
import 'package:platty/widgets/button.dart';

to:

import 'package:platty/platty.dart';

This will clean up the imports and make it easier to use the library.

NEW - Library now utilizes new CupertinoTheme and MaterialBasedCupertinoThemeData to bridge styling gap between widgets finally.

androidTheme -> unifiedTheme and no longer a function. The app will utilize the material theme and properly bridge it to Cupertino world.

buttonColor for Theme is now reflected in PButton iOS as well.

bottomAppBarColor for Theme now actually works with android and iOS PTabBar.

caption from TextTheme used in Theme now propagates to PTabBar as the inactive color on iOS and Android, to match behavior expected.

iconColor for a PNavBar utilizes the IconTheme if no iconColor specified. Defaults to CupertinoColors.ActiveBlue if all missing.

[0.0.6] - 12/29/2018 #

Fixes issue where PSliverNavigationBar on iOS, when specifying title and iosLargeTitle, displays both a middle and the large title. This would require dev to pass null title on iOS, requiring more work than necessary.

[0.0.5] - 12/03/2018 #

  • NEW - adds MaterialPatcher component to wrap certain Cupertino widgets so that material ancestors have a material reference and do not error out. This fixes error using CupertinoApp with some material ancestors without Material parents.

  • PlatformApp can specify a PTheme to be passed down the hierarchy instead.

  • FIX - swapping rendering platform from the IDE did not hot reload widgets in debug mode.

  • NEW - adds platformWrap and platformSelect. platformWrap enables platform-specific logic for a component by passing down the child and allowing you to wrap it:

platformWrap(
      context,
      child: PButton(
        padding: EdgeInsets.all(0.0),
        child: Text(title),
        color: Colors.red,
        onPressed: () {
          Navigator.push(context, PlatformRoute.of(context, builder: page));
        },
      ),
      // CupertinoButton does not include a margin like MaterialButton.
      renderCupertino: (context, child) => Padding(
            padding: EdgeInsets.only(bottom: 8.0),
            child: child,
          ),
    );

You can specify any of renderCupertino, renderMaterial, or renderFuschia (or none). Any not specified default to the child.

platformSelect is a helper that enables returning different objects based on platform in a unified way. In our PlatformAdaptingWidget, we utilize it to return a different widget based on platform. You can use it to return any return type based on platform:


Column(
  children: [
    platformSelect(context, 
      renderMaterial: (context) => Text("I am android"),
      renderCupertino: (context) => Text("I am iOS"),
      renderFuchsia: (context) => Text("I am FUCHSIA")) 
  ],
),

renderMaterial and renderCupertino are required. renderFuchsia defaults to material.

[0.0.4] - 11/25/2018 #

  • Adds support for Fuchsia in PlatformAdaptingWidget, which defaults to renderMaterial.

  • Added missing props for MaterialButton in PButton to be passed down on Android.

[0.0.3] - 11/21/2018 #

Fix for PButton Border Radius on iOS. Previously did not utilize same default as CupertinoButton, causing button not to be rounded.

[0.0.2] - First Release #

Initial Release of platty

example/README.md

example #

A new Flutter project.

Getting Started #

For help getting started with Flutter, view our online documentation.

Use this package as a library

1. Depend on it

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


dependencies:
  platty: ^0.0.9+1

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:platty/platty.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
52
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]
70
Learn more about scoring.

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

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

Health suggestions

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

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

line 16 col 28: 'inheritFromWidgetOfExactType' is deprecated and shouldn't be used. Use dependOnInheritedWidgetOfExactType instead. This feature was deprecated after v1.12.1..

Fix lib/src/widgets/material_patcher.dart. (-0.50 points)

Analysis of lib/src/widgets/material_patcher.dart reported 1 hint:

line 52 col 39: 'ancestorWidgetOfExactType' is deprecated and shouldn't be used. Use findAncestorWidgetOfExactType instead. This feature was deprecated after v1.12.1..

Format lib/src/widgets/scaffold.dart.

Run flutter format to format lib/src/widgets/scaffold.dart.

Maintenance suggestions

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.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.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