material_design 0.11.0
material_design: ^0.11.0 copied to clipboard
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.
Changelog #
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adherves to Semantic Versioning.
0.11.0 #
New Features #
- Introduced
M3Padding
Widget: A new token-driven widget that replaces the standardPadding
to enforce the use ofM3SpacingToken
for consistent padding across the application. It provides convenient constructors likeM3Padding.all
,M3Padding.only
, andM3Padding.symmetric
. - Introduced
M3Gap
Widget: A direct, token-based replacement forSizedBox
used for creating space between widgets.M3Gap
simplifies creating consistent spacing inRow
s andColumn
s by usingM3SpacingToken
. - Introduced
M3EdgeInsets
Utility: A new utility class to createEdgeInsets
exclusively fromM3SpacingToken
, ensuring all spacing values adhere to the Material Design system's defined scale.
Refactoring #
- Adopted New Spacing Widgets: Refactored the entire demo application, examples, and internal library widgets to use the new
M3Padding
andM3Gap
widgets. This removes direct dependency on Flutter'sPadding
andSizedBox
for spacing tasks, promoting design system consistency. - Simplified Token API: Updated the API for spacing tokens. It's no longer necessary to call
.value
on tokens when using them with the new spacing widgets (e.g.,M3Padding.all(M3SpacingToken.space16)
). - Improved Code Organization: Relocated core utility files from the
lib/src/m3/mt/
directory to a more semantically correctlib/src/m3/utils/
directory, improving the project's structure.
Documentation #
- Updated All Examples: Revised all documentation, including
README.md
, implementation guides, and inline code comments, to reflect the new spacing widgets and strongly recommend their usage over standard Flutter widgets for spacing.
0.10.0 #
π₯ BREAKING CHANGES #
- Major Token System Refactor: The token system has been significantly refactored to improve consistency, remove redundancy, and align more closely with a unified design system architecture.
- Unified Shape Tokens:
M3BorderRadiusToken
andM3RadiusToken
are now internal (_M3BorderRadiusToken
,_M3RadiusToken
). All shape properties should be accessed directly throughM3ShapeToken
.- Before:
M3BorderRadiusToken.medium.value
- After:
M3ShapeToken.medium.borderRadius
- Before:
- Screen Size Enum Renamed:
M3WindowSizeClass
has been renamed toM3ScreenSize
for better clarity and to avoid conflicts with Flutter's own window size classes. - Private Component/State Tokens:
M3ComponentElevationToken
andM3StateElevationToken
have been made private (_M3ComponentElevationToken
,_M3StateElevationToken
) as they are intended for internal use within the system. - Simplified Motion API:
M3MotionToken
now includesduration
andeasing
getters, simplifying animation definitions.
- Unified Shape Tokens:
β¨ Enhancements #
- Improved API Consistency: The token API is now more consistent and predictable. Accessing related values (like radius from a shape) is more intuitive.
- Streamlined Architecture: By removing redundant and reference-level tokens, the public API is smaller, cleaner, and easier to learn.
- Enhanced Readability: The new patterns (
M3ShapeToken.medium.borderRadius
) make the code more declarative and easier to read.
ποΈ Deprecations & Removals #
- Removed Reference Tokens: The
M3Ref...
token files (M3RefPalette
,M3RefOpacity
,M3RefTypeface
) have been removed from the public API. Their values are now integrated directly into the system tokens where needed. - Removed Component-Specific Button Tokens:
M3CompButton
has been removed. Use standard FlutterButtonStyle
with system tokens for customization. - Removed
M3ColorSchemeToken
: This has been removed as part of the color system simplification. UseTheme.of(context).colorScheme
for semantic color access. - Removed Demo Component Showcase: The
components_showcase_page.dart
file has been deleted from the demo application as part of a broader demo simplification effort.
π§ Migration Guide #
Shape and Radius:
Update all references to M3BorderRadiusToken
to use the new M3ShapeToken
accessors.
Before (v0.9.2):
Container(
decoration: BoxDecoration(
borderRadius: M3BorderRadiusToken.medium.value,
),
)
After (v0.10.0):
Container(
decoration: BoxDecoration(
borderRadius: M3ShapeToken.medium.borderRadius,
),
)
Adaptive Layouts:
Update all references from M3WindowSizeClass
to the new M3ScreenSize
.
Before (v0.9.2):
final sizeClass = M3BreakpointToken.getWindowSizeClassFromContext(context);
if (sizeClass == M3WindowSizeClass.compact) {
// ...
}
After (v0.10.0):
final sizeClass = M3BreakpointToken.getWindowSizeClassFromContext(context);
if (sizeClass == M3ScreenSize.compact) {
// ...
}
0.9.2 #
π BREAKING CHANGES #
- Typography Token Naming: Renamed
M3TypeScaleToken
toM3TextStyleToken
throughout the entire codebase for better semantic clarity and consistency with Material Design 3 nomenclature- All references to
M3TypeScaleToken
in code, documentation, and examples have been updated toM3TextStyleToken
- The class provides the same 15
TextStyle
tokens (displayLarge to labelSmall) with identical functionality - Enhanced README examples showing
copyWith()
usage for customizing text styles
- All references to
β¨ Enhancements #
- Improved API Semantics: The new
M3TextStyleToken
name better reflects that these are complete text style definitions rather than just type scale values - Enhanced Documentation: Updated all documentation files (English and Portuguese) to use the new token naming convention
- Better Code Examples: Improved README with more comprehensive typography examples showing real-world usage patterns
- Consistent Token Interface: All typography-related utility methods (responsiveDisplay, enhancedReadability, monoVariant, highContrast) maintained under the new class name
π Documentation Updates #
- Comprehensive Naming Updates: Updated all documentation files in both English (
en_US
) and Portuguese (pt_BR
) directories - Implementation Guide Updates: Refreshed implementation examples and component mappings with new token references
- README Enhancement: Added better typography examples showing advanced usage with
copyWith()
method - Demo Application Updates: Updated showcase pages to demonstrate the new
M3TextStyleToken
API
π― Demo & Example Applications #
- Complete Demo Update: All demo showcase pages updated to use
M3TextStyleToken
- Theme Integration: Updated theme provider to use new typography token naming
- Interactive Examples: Enhanced typography page and utility examples with new token references
π§ Migration Guide #
Before (v0.9.1):
Text('Title', style: M3TypeScaleToken.headlineMedium.value)
textTheme: TextTheme(
displayLarge: M3TypeScaleToken.displayLarge.value,
bodyMedium: M3TypeScaleToken.bodyMedium.value,
)
After (v0.9.2):
Text('Title', style: M3TextStyleToken.headlineMedium.value)
textTheme: TextTheme(
displayLarge: M3TextStyleToken.displayLarge.value,
bodyMedium: M3TextStyleToken.bodyMedium.value,
)
π Compatibility Notes #
- No Functional Changes: All text style values and functionality remain identical - only the class name has changed
- Same API Structure: All properties (.value, .responsiveDisplay, .enhancedReadability, etc.) maintain the same interface
- Import Structure Unchanged: Main package imports continue to work as before
Recommended Version Bump: MINOR (0.9.1 β 0.9.2) #
This release contains a breaking change in class naming but maintains API compatibility and adds semantic improvements to the typography system.
0.9.1 #
π Bug Fixes #
- Visual Density Token: Fixed critical StackOverflowError in
M3VisualDensityToken.adaptivePlatform
by removing recursive call and directly returningVisualDensity.adaptivePlatformDensity
- Motion Tokens API: Updated motion showcase to use direct token properties instead of
.value
accessor for better consistency - Shape Token References: Updated all documentation and demo references from
M3Shape
toM3ShapeToken
for consistency
β¨ Enhancements #
- Enhanced Visual Density Documentation: Improved inline documentation with clearer property descriptions and usage examples
- Better Type Safety: Enhanced visual density token implementation with proper typing and clearer API contracts
- Motion Token Consistency: Standardized motion token usage pattern across demo application
π Documentation Updates #
- Token Reference Updates: Updated all documentation files to reflect correct
M3ShapeToken
naming - API Documentation: Enhanced visual density token documentation with detailed property descriptions
- Usage Examples: Updated code examples throughout documentation to use correct token references
π§ Code Quality #
- Gitignore Cleanup: Updated
.gitignore
to use more generic trash directory pattern (lib/src/trash
instead oflib/src/m3/trash
) - Code Organization: Improved visual density token file structure and removed redundant utility methods
- Better Error Handling: Eliminated potential runtime errors through proper token implementation
Recommended Version Bump: PATCH (0.9.0 β 0.9.1) #
This release contains bug fixes and documentation improvements without breaking changes to the public API.
0.9.0 #
π BREAKING CHANGES #
-
Token System Standardization: Massive refactoring to standardize all token class names with "Token" suffix for better consistency and clarity
-
Renamed Core Token Classes:
M3Spacing
βM3SpacingToken
M3Elevation
βM3ElevationToken
M3Shape
βM3ShapeToken
M3Motion
βM3MotionToken
M3MotionDuration
βM3MotionDurationToken
M3MotionEasing
βM3MotionEasingToken
M3Border
βM3BorderToken
M3Breakpoint
βM3BreakpointToken
M3IconSize
βM3IconSizeToken
M3ZIndex
βM3ZIndexToken
M3VisualDensity
βM3VisualDensityToken
M3StateLayerOpacity
βM3StateLayerOpacityToken
M3Opacity
βM3OpacityToken
M3TypeScale
βM3TypeScaleToken
-
Removed Legacy System Classes:
M3SysColor
β Replaced withM3ColorSchemeToken
M3TypeScale
β Consolidated intoM3TypeScaleToken
M3VisualDensity
β Renamed toM3VisualDensityToken
-
β¨ Enhanced Token Architecture #
- Improved Token Consistency: All token classes now follow a unified naming convention with "Token" suffix
- Better API Clarity: The "Token" suffix makes it clear that these are design token classes rather than utility classes
- Streamlined Color System: Introduced
M3ColorSchemeToken
as a more organized approach to color tokens - Enhanced State System: Added
M3OpacityToken
for general opacity values alongside the existing state layer opacities
π Documentation Updates #
- Comprehensive Documentation Refresh: Updated all documentation files (both English and Portuguese) to reflect new token naming
- Implementation Guide Updates: All implementation examples now use the new token class names
- Component Map Updates: Updated component mapping documentation with new token references
- README Updates: Main README.md updated with new API examples and migration guidance
π― Demo & Example Applications #
- Complete Demo Application Update: All demo showcase pages updated to use new token naming conventions
- Enhanced Theme Integration: Theme examples updated to demonstrate proper usage of renamed tokens
- Interactive Examples: All interactive widgets and examples updated with new token class names
- Comprehensive Showcases: Typography, spacing, motion, shape, and component showcases all updated
π§ Migration Guide #
Before (v0.8.1):
// Old token naming
Card(elevation: M3Elevation.level2.value)
Padding(padding: EdgeInsets.all(M3Spacing.space16.value))
AnimatedContainer(duration: M3MotionDuration.short2.value)
Text('Title', style: M3TypeScale.headlineMedium)
After (v0.9.0):
// New standardized naming with "Token" suffix
Card(elevation: M3ElevationToken.level2.value)
Padding(padding: EdgeInsets.all(M3SpacingToken.space16.value))
AnimatedContainer(duration: M3MotionDurationToken.short2.value)
Text('Title', style: M3TypeScaleToken.headlineMedium)
ποΈ File Structure Improvements #
- Token File Reorganization: All token implementation files renamed to include "_token" suffix for better organization
- Cleaner Export Structure: Main library exports updated to expose new token class names
- Consistent Internal Structure: Internal token files follow consistent naming patterns
π Compatibility Notes #
- No Functional Changes: All token values and functionality remain identical - only class names have changed
- Import Structure Unchanged: Main package imports (
import 'package:material_design/material_design.dart'
) remain the same - Enum Values Preserved: All enum values and properties maintain their existing names and functionality
0.8.1 #
π Major Documentation System #
- Comprehensive Documentation Portal: Added complete Obsidian-based documentation system with bilingual support (English/Portuguese)
- Structured Documentation: Organized into Foundations, Styles, Components, and Implementation sections
- Interactive Navigation: Component maps, token maps, and implementation guides with cross-references
- Bilingual Support: Full documentation available in both English (
en_US
) and Portuguese (pt_BR
) - Visual Documentation: Mermaid diagrams and structured navigation for better understanding
ποΈ Documentation Architecture #
- Foundations Section:
- Design Tokens hierarchical system (ref/sys/comp)
- Accessibility guidelines and WCAG compliance
- Adaptive design patterns and responsive utilities
- Styles Section:
- Typography system (complete 15-level type scale)
- Elevation system (6 levels with shadows)
- Motion system (durations and easing curves)
- Shape system (complete corner radius system)
- Implementation Section:
- Flutter integration guides
- Token structure documentation
- Theme system implementation
- Best practices and usage examples
β¨ Enhanced Developer Experience #
- Interactive Maps: Component map, token map, and implementation map for visual navigation
- Status Indicators: Clear marking of implemented vs. planned features
- External Links: Comprehensive links to official Material Design 3 resources
- Code Examples: Practical implementation examples throughout documentation
π§Ή Code Organization #
- Cleaned Documentation: Removed
ENHANCED_FEATURES.md
file to consolidate documentation structure - Updated README: Restructured README.md with better organization and clearer API migration guides
- Gitignore Updates: Removed documentation folder from gitignore to include new documentation system
π§ Configuration Updates #
- Obsidian Integration: Added complete Obsidian vault configuration for seamless documentation editing
- Workspace Setup: Pre-configured workspace with proper graph view and navigation settings
- Core Plugins: Enabled essential plugins for documentation workflow (file explorer, search, graph, backlinks)
0.8.0 #
π BREAKING CHANGES #
- Elevation System Overhaul: Complete refactor of the elevation token system with improved type safety and API consistency
- Removed
M3TonalColor
class: Replaced with internal_M3TonalColor
implementation accessed through elevation tokens - Removed
M3Shadow
class: Replaced with internal_M3ShadowToken
implementation accessed through elevation tokens - New Unified API: All elevation-related functionality now accessed through
M3ElevationToken.levelX.shadows
andM3ElevationToken.levelX.surfaceColor(context)
- Removed
β¨ Major Features #
- New Token Interface System: Introduced
IM3Token<T>
interface for consistent token architecture across the library - Enhanced Elevation Tokens:
- Added
M3ElevationToken
enum with 6 predefined levels (level0-level5) - Added
M3ComponentElevationToken
enum for component-specific elevations (card, button, fab, appBar, etc.) - Added
M3StateElevationToken
enum for interactive state elevations (hover, pressed, focus, etc.)
- Added
- Improved Type Safety: All elevation tokens now implement
IM3ElevationToken
interface with consistentvalue
andhasShadow
properties - Advanced Extension Methods: Added
IM3ElevationTokenVisuals
andIM3ElevationTokenComparison
extensions for enhanced functionality
π― Enhanced Developer Experience #
- Simplified API: Unified access pattern for shadows and surface colors through elevation tokens
- Better Documentation: Comprehensive inline documentation with Material 3 specification references
- Component-Specific Tokens: Predefined elevation values for all major Material 3 components
- State-Aware Elevations: Built-in support for interactive states (hover, pressed, focus, drag)
ποΈ Architectural Improvements #
- Modular Design: Elevation system split into focused modules (
_m3_shadow_token.dart
,_m3_tonal_color.dart
) - Consistent Naming: All elevation-related classes follow unified naming conventions
- Better Abstraction: Internal implementation details hidden behind clean public APIs
- Enhanced Performance: Optimized shadow and surface color calculations
π Bug Fixes #
- Demo Application: Fixed incorrect elevation token usage in demo surface cards
- Documentation: Corrected widget references and improved code examples
- Code Quality: Updated analysis configuration to use
very_good_analysis
for stricter linting
π Documentation Updates #
- README.md: Updated examples to use new elevation token API
- ENHANCED_FEATURES.md: Refreshed elevation examples with current API patterns
- Inline Documentation: Added comprehensive documentation throughout the elevation system
- Example Applications: Updated demo and example apps to showcase new elevation capabilities
π§ Migration Guide #
Before (v0.7.5):
// Old API - no longer available
Container(
decoration: BoxDecoration(
color: M3TonalColor.surface3(context),
boxShadow: M3ShadowToken.fromElevation(4.5),
),
)
After (v0.8.0):
// New unified API
final elevation = M3ElevationToken.fromValue(4.5);
Container(
decoration: BoxDecoration(
color: elevation.surfaceColor(context),
boxShadow: elevation.shadows,
),
)
π¨ Component Usage Examples #
// Component-specific elevations
Card(
elevation: M3ComponentElevationToken.card.value,
surfaceTintColor: Theme.of(context).colorScheme.surfaceTint,
)
// State-aware elevations
AnimatedContainer(
decoration: BoxDecoration(
color: isHovered
? M3StateElevationToken.cardHover.surfaceColor(context)
: M3ComponentElevationToken.card.surfaceColor(context),
boxShadow: isHovered
? M3StateElevationToken.cardHover.shadows
: M3ComponentElevationToken.card.shadows,
),
)
0.7.5 #
Enhanced Demo Experience #
- Live Demo Integration: Added prominent live demo section to README.md with direct link to interactive showcase
- Featured interactive demo at
https://fluttely.github.io/material_design/
with comprehensive token visualization - Reorganized README structure with dedicated demo section for better user onboarding
- Added links to additional resources including Material Design 3 guidelines and Flutter M3 documentation
- Featured interactive demo at
Major Demo Application Improvements #
-
Comprehensive Documentation: Added extensive inline documentation throughout the demo application
- Complete component and class documentation with detailed feature descriptions
- Enhanced code comments explaining Material Design 3 implementation patterns
- Improved developer experience with clear architectural explanations
-
Enhanced Navigation Experience:
- Custom NavigationRail implementation with Material Design 3 hover animations and state layer effects
- Improved mobile navigation with floating hamburger menu and proper M3 specifications
- Better visual hierarchy with organized Foundation, Styles, and Components sections
- Fixed bottom controls layout with proper spacing and alignment
-
Material Design 3 Compliance:
- Updated
WindowSizeClass
references to useM3WindowSizeClass
for proper M3 alignment - Enhanced theme implementation with proper Material 3 color schemes and component theming
- Added
useMaterial3: true
flag to theme configurations for full M3 compliance - Improved adaptive layouts following M3 responsive navigation patterns
- Updated
Example Application Enhancements #
-
Advanced Theme System: Enhanced example application with sophisticated theming capabilities
- Added smooth theme transition animations with AnimationController
- Comprehensive Material 3 component theme implementations for both light and dark modes
- Enhanced AppBar, Card, and Button theming with proper M3 specifications
- Improved color scheme generation with dynamic seed color support
-
Better Code Organization: Restructured example application with improved architecture
- Enhanced documentation with detailed class and method descriptions
- Better separation of concerns with dedicated theme building methods
- Improved code readability and maintenance
User Experience Improvements #
- Updated Application Titles: Changed demo app title to "Material Design 3 Token Showcase" for better clarity
- Enhanced Visual Design: Improved navigation item styling with proper M3 indicators and hover effects
- Better Resource Links: Updated and reorganized links to Material Design documentation and resources
- Improved Accessibility: Enhanced touch targets and navigation patterns following M3 accessibility guidelines
Development Experience #
- Code Quality: Extensive code documentation and architectural improvements
- Better Examples: Enhanced example implementations demonstrating proper M3 patterns
- Maintainability: Improved code organization and separation of concerns
0.7.4 #
CI/CD & Deployment #
- GitHub Actions Workflow: Added automated deployment workflow for demo application
- Introduced
.github/workflows/deploy-demo.yml
with GitHub Pages deployment - Supports both push-to-main and manual workflow dispatch triggers
- Automated Flutter web build with proper base href configuration
- Introduced
- Custom Domain Setup: Added CNAME file for custom domain deployment at
material-design.fluttely.com
- Local Deployment Script: Created
demo/deploy.sh
script for manual deployment workflows - Deploy Status Badge: Added GitHub Actions deploy status badge to README.md
Bug Fixes #
- Color Display Enhancement: Fixed color picker button styling in example application
- Added outline border to color circles for better visibility
- Improved color hex code display with robust string formatting
- Replaced dynamic spacing token with fixed spacing value for stability
Documentation #
- README Updates: Updated package version references from
0.7.3
to0.7.4
across documentation - Version Consistency: Synchronized version numbers across all package files and dependencies
Development #
- Dependency Updates: Updated pubspec.lock files in both demo and example applications
- Version Alignment: Maintained consistent versioning across the project structure
0.7.3 #
Features #
- New Simplified Demo Application: Added a complete new
demo/
directory containing a streamlined, single-file demonstration of the Material Design library- Consolidated all key library features into one scrollable page for easier user onboarding
- Features comprehensive showcase of foundations (spacing, visual density, opacity, borders), styles (colors, typography, shapes, elevation), and components (buttons, cards, chips)
- Interactive theme controls with dark/light mode toggle and seed color picker with 8 preset colors
- Live breakpoint detection and adaptive layout behavior
- Fully localized in English for global accessibility
- Cross-platform support (Android, iOS, Web, Windows, macOS, Linux)
Enhanced Developer Experience #
- Improved Example Navigation: The original complex example application has been refined with better navigation structure
- Better Library Accessibility: Users now have two options:
demo/
- Simple, single-file showcase for quick library evaluation and testingexample/
- Comprehensive, detailed showcase for in-depth exploration of advanced features
- Reduced Complexity: New developers can now easily understand and test the library features without navigating through complex multi-page structures
Documentation #
- Updated README.md: Enhanced documentation to reflect the new demo structure and improved library presentation
- Analysis Configuration: Updated
analysis_options.yaml
for better code quality and consistency
Migration Guide #
For users upgrading from v0.7.2:
- No breaking changes to the core library APIs
- The original
example/
app remains fully functional with all existing features - The new
demo/
app provides an alternative, simplified entry point for library evaluation - All existing code using the library tokens and utilities will continue to work without modification
Development #
- Multi-Platform Support: Both demo and example applications support all Flutter target platforms
- Dependency Management: Proper dependency isolation between demo and example applications
- Build Configuration: Complete build configurations for all supported platforms in the new demo app
0.7.2 #
Features #
- Enhanced Documentation: Completely revamped README.md with improved structure, clearer value proposition, and comprehensive feature highlights
- Professional Presentation: Added visual emoji indicators, popularity badge, and enhanced package description for better discoverability
- Better Developer Experience: Improved code examples with proper formatting, better context, and clearer inline documentation
- Resource Organization: Added dedicated sections for additional resources, contributing guidelines, and license information
- Elevation System Enhancement: Improved elevation token interface with clearer property naming and better shadow interpolation
Refactor #
- Token Organization: Major reorganization of the token system for better structure and maintainability:
- Moved button component tokens to
lib/src/m3/tokens/comp/button/
for better component organization - Relocated shadow tokens to
lib/src/m3/tokens/sys/elevation/
to align with elevation system - Moved geometry tokens (
border
,breakpoint
,icon_size
,z_index
) tolib/src/m3/tokens/sys/geometry/
for better categorization - Relocated visual density token to
lib/src/m3/tokens/sys/interaction/
to align with interaction patterns
- Moved button component tokens to
- Import Structure: Updated main export file (
m3.dart
) to reflect new token organization and maintain backward compatibility - Elevation Token Improvements:
- Renamed
dp
property tovalue
across all elevation tokens for consistency with other token patterns - Enhanced shadow interpolation algorithm for smoother transitions between elevation levels
- Improved elevation interface documentation and method signatures
- Renamed
Documentation #
- README Improvements:
- Added compelling tagline and clear value proposition
- Introduced comprehensive "Key Features" section highlighting type safety, completeness, and production readiness
- Enhanced code examples with better formatting and clearer explanations
- Fixed inconsistent example formatting and corrected token usage patterns
- Added proper installation instructions and usage examples
- Included dedicated sections for additional resources and community contributions
- Updated migration guide with more comprehensive examples showing the evolution from v0.6.1 to v0.7.0+
Fix #
- Example App Updates:
- Fixed elevation token usage throughout example app to use new
.value
property - Updated accessibility showcase to use correct elevation values
- Improved code formatting and consistency across showcase pages
- Removed obsolete commented code and examples for cleaner codebase
- Fixed elevation token usage throughout example app to use new
Chore #
- Example Dependencies: Updated example app's pubspec.lock to reflect new version
- Code Cleanup: Removed unused example code and improved formatting consistency
0.7.1 #
0.7.0 #
BREAKING CHANGES #
- Tokens: The Material 3 token system has been completely refactored for better organization and clarity.
- System tokens are now organized under
lib/src/m3/tokens/sys/
. This includesColor
,Elevation
,Motion
,Shape
,Spacing
, andTypography
. - Many token files have been moved, renamed, or consolidated. Please refer to the updated documentation for the new token structure.
- The
M3Theme
class has been removed as part of this refactoring.
- System tokens are now organized under
Features #
- Components: Added a new Material 3 Button component (
M3CompButton
). - Tokens: Introduced new system tokens for
Elevation
,Motion
,Shape
,Spacing
, andStateLayerOpacity
.
Refactor #
- Refactored the entire token system to align more closely with the official Material Design 3 specifications.
- Renamed and moved several internal utilities and classes to a new
mt
(Material Toolkit) namespace for better internal structure. - Updated the example application to reflect all the latest changes and new APIs.
- Renamed the "Density" showcase page to "Visual Density" for clarity.
Chores #
- Updated
.gitignore
to exclude new generated files. - Updated
README.md
with the latest information.
0.6.2 #
Major Refactoring: Token System Overhaul #
- Shape System: Replaced
BoxDecoration
withShapeDecoration
across the example app for better semantics. IntroducedM3BorderRadius
and convertedM3Radius
fromdouble
toRadius
constants, providing a more robust and type-safe way to define shapes. - Motion Tokens: Consolidated motion-related tokens.
M3MotionDuration
andM3MotionEasing
have been merged into a single, more organizedm3_motion.dart
file under thesys
directory, improving clarity and discoverability. - File Structure: Reorganized the token file structure to better align with the Material Design 3 system. Legacy and unused token files like
M3ColorRoles
,m3_radius.dart
(the olddouble
based one), andm3_examples.dart
have been removed to streamline the package.
Breaking Changes #
- Removed
M3ColorRoles
: The staticM3ColorRoles
class has been removed. Please use the color scheme provided by theM3Theme
orTheme.of(context).colorScheme
for semantic color access. - Removed
M3Radius
(asdouble
): TheM3Radius
class that provideddouble
values has been replaced byM3BorderRadius
(which providesBorderRadius
objects) and a newM3Radius
class that providesRadius
objects. - Consolidated Motion Tokens:
M3MotionDuration
andM3MotionEasing
are no longer separate files. Importpackage:material_design/material_design.dart
and use theM3MotionDuration
andM3MotionEasing
classes directly.
Enhancements & Fixes #
- Code Cleanup: Performed a general code cleanup, removing obsolete files and refactoring the example app for better readability and consistency.
- Shape Implementation: Consistently replaced
BorderRadius.circular()
with the newM3BorderRadius
constants throughout the example app. - New
md
Module: Introduced a newmd
module for future development, starting with a new barrel filemd.dart
.
0.6.1 #
Refinements and Internationalization #
- Refactored README: Simplified the documentation to focus on core features and improve clarity.
- Internationalized Example App: All user-facing strings in the accessibility showcase are now in English, making the example more accessible to a global audience.
- Code Cleanup: Minor code cleanup and refactoring in the example app for better readability and maintenance.
0.6.0 #
New Features #
- Complete M3 Theme System: Introduced
M3Theme
, an integrated theme builder that generates a completeThemeData
from a seed color, with full support for light, dark, and high-contrast modes. - Comprehensive Accessibility Utilities: Added the
M3Accessibility
class, providing a suite of tools for building WCAG-compliant UIs, including accessible form fields, focus indicators, contrast checking, and touch target enforcement. - Adaptive Design System: Implemented the
M3Adaptive
class with helpers for responsive layouts (M3Adaptive.responsiveLayout
), adaptive navigation (M3AdaptiveScaffold
), and adaptive components that adjust to different screen sizes and platforms. - Advanced Token Utilities: Added new utility classes for enhanced token functionality:
M3TypeScale
: Responsive and accessible typography helpers.M3ColorUtils
: Color manipulation and contrast validation.M3ShapeUtils
: Responsive and brand-specific shape generation.M3MotionUtils
: Contextual animation patterns (fade, slide, scale).
Breaking Changes #
- Token Architecture Refactor: The entire token system has been restructured to follow the official Material Design 3 hierarchy:
- Reference Tokens (Ref): Foundational values (e.g.,
M3RefPalette
,M3RefDuration
). - System Tokens (Sys): Semantic roles (e.g.,
M3SysColor
). - Component Tokens (Comp): Component-specific values (e.g.,
M3CompButton
).
- Reference Tokens (Ref): Foundational values (e.g.,
- The old token structure is now considered legacy and will be deprecated in a future version.
Enhancements & Fixes #
- Example App Overhaul: The example app has been completely reorganized into
Foundations
,Styles
, andComponents
sections to provide a comprehensive showcase of all new features and the new token architecture. - Documentation: Massively updated
README.md
and addedENHANCED_FEATURES.md
to document the new capabilities. - Code Quality: Refactored numerous widgets and classes for better organization, consistency, and adherence to M3 specifications.
0.5.1 #
- BREAKING: Renamed
M3Margins
toM3Margin
andM3Spacers
toM3Spacer
for better naming consistency. - DOCS: Updated
README.md
to reflect the new class names and provide clearer examples. - CHORE: Updated the example app to use the new
M3Margin
andM3Spacer
classes.
0.5.0 #
- BREAKING: Token classes are now
abstract class
instead ofabstract final class
to allow for extension. - BREAKING: Change dart version from
3.8.1
to>=2.17.0 <4.0.0
to allow for extension. - BREAKING: The
equatable
dependency has been removed. - FEAT: Added
M3Margins
andM3Spacers
classes for more semantic layout spacing. - FEAT: Added new radius and shape tokens (
largeIncreased
,extraLargeIncreased
,extraExtraLarge
). - FEAT: The example app has been revamped to better demonstrate the updated tokens, including a new
LaunchURLText
widget. - CHORE: Lowered the minimum Dart SDK requirement from
3.8.1
to2.17.0
for wider project compatibility. - CHORE: As restriΓ§Γ΅es do SDK do Flutter e do Dart foram atualizadas.
- CHORE:
very_good_analysis
has been commented out inanalysis_options.yaml
. - DOCS:
README.md
has been updated with the latest changes.
0.4.1 #
- BREAKING: Renamed
M3Opacity
toM3StateLayerOpacity
to better reflect its purpose. - feat: Added
LaunchURLText
widget to the example app for styled URL links. - feat: Added
M3StateLayerOpacityButtonExample
to demonstrate state layer opacity on a custom button. - refactor: Updated the example app to consistently use
Theme.of(context).textTheme
for typography. - docs: Updated
README.md
with the latest changes and examples.
0.4.0 #
- BREAKING:
M3Motion
has been refactored intoM3MotionDuration
andM3MotionEasing
to better align with the Material Design 3 specifications. - BREAKING:
M3Density
has been removed and replaced withM3VisualDensity
, which uses Flutter's nativeVisualDensity
class. - FEAT: Added new icon sizes:
dense
,medium
,large
, andextraLarge
toM3IconSize
. - FEAT: The
M3Shadow
implementation has been revised, including a newfromElevation
method. - FEAT: Added the
url_launcher
dependency for opening URLs. - FIX: The Z-Index section on the example page has been reworked for a better visual demonstration.
- CHORE: Various formatting and code cleanup improvements in the example app.
0.3.0 #
- Breaking Change: Renamed all tokens from
Material*
toM3*
(e.g.,MaterialTonalColor
toM3TonalColor
) to align with Material Design 3 naming conventions and avoid conflicts with Flutter'sMaterial
class. - Breaking Change: Reorganized the file structure by moving all token files to
lib/src/m3/tokens/
and renaming them with them3_
prefix (e.g.,motion.dart
tom3_motion.dart
). This improves clarity and consistency. - Feat: Implemented a responsive layout in the example app using
NavigationRail
andNavigationDrawer
to showcase theM3Breakpoint
token. - Fix: Updated the copyright year in the
LICENSE
file. - Chore: Updated
pubspec.yaml
by removing thehomepage
field and addingissue_tracker
.
0.2.6 #
- Feat: Added
MaterialDensity
token to control UI density. - Refactor: Replaced
MaterialColorScheme.create
withColorScheme.fromSeed
to align with Flutter's core API. - Refactor: Refined motion tokens by separating them into
MotionEasing
andMotionDuration
for more granular control. - Example: Added a new
DensityPage
to the example app to showcase theMaterialDensity
token. - Example: Updated the example app to use the new motion tokens and
ColorScheme.fromSeed
.
0.2.5 #
- Refactor: The
MaterialMotionToken
has been renamed toMotionScheme
to better align with the Material Design 3 specifications. - Feature: Introduced
MotionDurations
andMotionEasings
classes to provide more granular control over animation durations and easing curves. - Example: Simplified the elevation page logic and updated the motion page to use the new
MotionScheme
.
0.2.4 #
- Refactor: Renamed
MaterialSurface
toMaterialTonalColor
and its methodgetTintedColor
tofromElevation
for better alignment with Material Design 3 terminology, where tonal colors are applied based on surface elevation. - Refactor: Renamed
MaterialColorSchemes
toMaterialColorScheme
to maintain consistency with Flutter'sColorScheme
. - Feat: Added detailed comments to
MaterialBreakpoint
explaining the different breakpoint values based on the Material Design 3 guidelines. - Feat: Added
allLevels
toMaterialElevation
, providing a convenient list of all elevation levels. - Fix: Ignored
.vscode/
and.env
files in.gitignore
to avoid committing editor-specific settings and environment variables. - Example: Updated the example app to use
MaterialTonalColor.fromElevation
and other related changes.
0.2.3 #
- Docs: Added detailed examples to
README.md
forMaterialBorder
,MaterialOpacity
,MaterialBreakpoint
,MaterialIconSize
, andMaterialZIndex
. - Example: Added a new
MotionPage
to the example app to showcase allMaterialMotion
tokens. - Example: Updated the
OtherTokensPage
in the example app to include showcases forMaterialBreakpoint
,MaterialIconSize
, andMaterialZIndex
. - Refactor: Renamed
MotionToken
toMaterialMotionToken
for better clarity and consistency. - Fix: Removed
MaterialBorder.none
as it was redundant (equivalent to0
).
0.2.1 #
Changed #
- Renamed
MaterialColorSchemes
toMaterialColorScheme
. - Removed static schemes
lightScheme
anddarkScheme
; use thecreate()
method instead.
0.2.0 #
Added #
MaterialSurface
Utility: Introduced a new utility class with agetTintedColor()
method to easily apply Material 3 surface tint based on elevation. This encapsulates theElevationOverlay
logic into a clean, reusable token.
0.1.0 #
Added #
- Complete Material 3 Token System:
MaterialColorSchemes
: Light and dark color schemes generated from a seed color.MaterialTypeScale
: Full set of 15 M3 text styles (Display, Headline, Title, Body, Label).MaterialShape
:ShapeBorder
tokens for all M3 corner radius levels.MaterialShadow
:BoxShadow
tokens aligned with the 6 elevation levels of M3.MaterialBorder
: Tokens for border widths.
- Style Guide Example: The example app was completely rewritten to serve as a visual style guide for all tokens.
- Barrel Files: Added barrel files for easy token import by category (
color
,typography
,geometry
, etc.).
Changed #
- Refactored
MaterialOpacity
: Aligned with M3 state layer values (Hover, Focus, Press, Drag) and disabled opacities. - Refactored
MaterialRadius
: Values adjusted to match the M3 corner radius token scale. - Refactored
MaterialIconSize
: Simplified to focus on the default 24dp size, with guidance for contextual usage. - Refactored
motion.dart
: FixedasTween
return type toAnimatable<T>
to ensure proper typing.