material_design 0.3.0

The fastest path to consistent Material Design UIs in Flutter. Build beautiful apps aligned with official metrics and guidelines using a powerful set of ready-to-use design tokens and helper widgets.

Material Design

A comprehensive toolkit for implementing Material Design 3 in Flutter. Build beautiful and consistent UIs aligned with official metrics and guidelines using a powerful set of design tokens and ready-to-use helper widgets.

This package encapsulates the Material 3 guidelines into easy-to-use tokens, allowing you to focus on your app logic while maintaining visual fidelity.

Installation

Add this line to your project's pubspec.yaml file:

dependencies:
  material_design: ^0.3.0

Then run flutter pub get.

Usage

Import the package to start using the tokens:

import 'package:material_design/material_design.dart';

Core Tokens

This package provides a comprehensive set of Material 3 design tokens, allowing you to build consistent and beautiful UIs.

Color

The color system is based on a seed color, which generates a full ColorScheme for both light and dark modes.

• ColorScheme.fromSeed({seedColor, brightness}): Generates a full M3 color scheme.

Example:

MaterialApp(
  theme: ThemeData(
    colorScheme: ColorScheme.fromSeed(
      seedColor: Colors.blue,
      brightness: Brightness.light,
    ),
    useMaterial3: true,
  ),
  darkTheme: ThemeData(
    colorScheme: ColorScheme.fromSeed(
      seedColor: Colors.blue,
      brightness: Brightness.dark,
    ),
    useMaterial3: true,
  ),
)

• M3TonalColor.fromElevation(context, elevation): Calculates the surface color with an elevation-based tint, crucial for M3's tonal elevation.

Example:

Container(
  color: M3TonalColor.fromElevation(context, M3Elevation.level2),
)

Typography

The full M3 type scale is available via the M3TypeScale class.

• M3TypeScale: Provides 15 TextStyle tokens, from displayLarge to labelSmall.

Example:

Text(
  'Display Large',
  style: M3TypeScale.displayLarge,
)

Shape & Radius

Define corner shapes using radius and shape tokens.

• M3Radius: Provides radius values from none (0dp) to extraLarge (28dp) and full.
• M3Shape: Provides ShapeBorder objects like extraSmall, medium, large, etc.

Example:

Container(
  decoration: ShapeDecoration(
    shape: M3Shape.medium, // 12dp corner radius
  ),
)

Elevation & Shadow

Use elevation tokens for surface depth and shadow tokens for casting shadows.

• M3Elevation: Defines 6 elevation levels from level0 (0dp) to level5 (12dp).
• M3Shadow: Provides BoxShadow lists for each elevation level (level0 to level5).

Example:

Container(
  decoration: ShapeDecoration(
    shape: M3Shape.medium,
    shadows: M3Shadow.level2, // 3dp elevation shadow
  ),
)

Spacing

A granular spacing scale for consistent layouts.

• M3Spacing: Provides spacing values from none to space512.

Example:

Padding(
  padding: const EdgeInsets.all(M3Spacing.space16), // 16dp padding
  child: Text('Hello, Material!'),
)

Density

Adjust component density for different interaction models.

• M3Density: An enum with comfortable (default) and compact values.

Example:

// Use a switch to toggle between density settings
final density = isCompact ? M3Density.compact : M3Density.comfortable;

// This could be used to adjust layout constraints
final horizontalPadding = density == M3Density.compact
    ? M3Spacing.space8
    : M3Spacing.space16;

Motion

Standardized duration and easing curves for animations.

• M3Motion: Provides M3MotionScheme objects for standard, emphasized, and linear motion, including incoming and outgoing variations.

Example:

AnimatedContainer(
  duration: M3Motion.standard.duration,
  curve: M3Motion.standard.curve,
  // ...
)

Other Tokens

The library also includes tokens for various other UI properties.

• M3Border: Standard border widths.

  • thin (1dp)

  Example:

  Container(
    decoration: BoxDecoration(
      border: Border.all(width: M3Border.thin),
    ),
  )
  

• M3Opacity: Opacity values for states and elements.

  • hover (0.08), focus (0.10), pressed (0.10), dragged (0.16)
  • disabledContent (0.38), disabledContainer (0.12)

  Example:

  Container(
    color: Colors.black.withOpacity(M3Opacity.hover),
  )
  

• M3Breakpoint: Breakpoints for responsive layouts.

  • compact (0), medium (600), expanded (840), large (1200), extraLarge (1600)

  Example:

  final screenWidth = MediaQuery.of(context).size.width;
  if (screenWidth >= M3Breakpoint.medium) {
    // Use a two-column layout
  }
  

• M3IconSize: Standard icon size.

  • standard (24dp)

  Example:

  Icon(
    Icons.favorite,
    size: M3IconSize.standard,
  )
  

• M3ZIndex: Conventional z-index values for layering.

  • content (1), floating (10), drawer (100), modal (1000), snackbar (2000), tooltip (9999)

  Example:

  Stack(
    children: [
      Positioned(
        zIndex: M3ZIndex.content,
        child: Text('Content'),
      ),
      Positioned(
        zIndex: M3ZIndex.floating,
        child: FloatingActionButton(onPressed: () {}),
      ),
    ],
  )
  

Example App

The included example app serves as a complete visual style guide, showcasing all tokens available in this package. Explore it to see the tokens in action.

More content

https://flutterweb-wasm.web.app/