Skip to content

Latest commit

 

History

History
90 lines (54 loc) · 2.27 KB

README.md

File metadata and controls

90 lines (54 loc) · 2.27 KB
Raw

ZDS Flutter

A library of Flutter components made by Zebra Technologies based on the Zebra Design System, or ZDS.

zds_flutter example

Requirements

Make sure your app meets the following requirements before using ZDS Flutter

  • sdk: >=3.2.0 <4.0.0
  • flutter: >=3.16.0

Usage

Add the following as a dependency in your pubspec.yaml file.

zds-flutter: ^2.0.0-alpha.5

Getting started

Template

To speed up development, we have a template repo with ZDS Flutter already set up: zds_flutter_template

Manual setup

In order to use components from ZDS Flutter, you must change your app widget to be a ZdsApp

class DemoApp extends StatelessWidget {
  const DemoApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return ZdsApp(
      title: 'ZDS Flutter demo',
      routes: kAllRoutes,
    );
  }
}

Viewing the components

To view examples of all the components in the library, you can run the example app in this repo or go to this link.

Theming

The ZDS uses the color system from another Zebra design library - zeta_flutter.

Platform support

Full support on Android and iOS.

On Web, Windows, Mac and Linux some features may be missing, but most functionality remains.

Licensing

This software is licensed with the MIT license (see LICENSE) and uses some components that are distributed under their own terms (see LICENSE-3RD-PARTY).

Future project Todos:

[ ] Add Widgetbook.

[ ] Fix untranslated strings - see untranslated.json.

[ ] Set up themes to inherit from parent classes - think of toolbar within bottom of appbar.

[ ] Integrate ZetaColors better.

[ ] Analyze dependencies for weaknesses, possibly phase out some.

[ ] Remove code from this repo that is not strictly needed for flutter - github actions could be in another repo?