|
| 1 | +<!-- Copyright © SixtyFPS GmbH <[email protected]> ; SPDX-License-Identifier: MIT --> |
| 2 | + |
| 3 | +## Technical Preview -> 1.0 migration guide |
| 4 | + |
| 5 | +This document summarizes all changes made to the Material Components between the Technical Preview and the 1.0 release. |
| 6 | + |
| 7 | +## Major System-Wide Changes |
| 8 | + |
| 9 | +### Styling System Renaming |
| 10 | +- **`Animation` → `MaterialAnimation`** |
| 11 | + - All animation imports now use `MaterialAnimation` instead of `Animation` |
| 12 | + - Affects: bottom-sheet, check-box, chip, dialog, drawer, extended-touch-area, modal, navigation-drawer, radio-button, search-bar, segmented-button, snack-bar, state-layer, switch, tab-bar, text-field |
| 13 | + |
| 14 | +- **`typography` → `MaterialTypography`** |
| 15 | + - Typography system renamed for consistency |
| 16 | + - Affects: app-bar, badge, base-button, chip, date-picker, dialog, drawer, elevated-button, filled-button, filled-icon-button, floating-action-button, icon-button, list, material-text, menu, navigation-bar, navigation-drawer, outline-button, outline-icon-button, search-bar, snack-bar, tab-bar, text-button, text-field, time-picker, tonal-button, tonal-icon-button, tooltip |
| 17 | + |
| 18 | +## Component Changes |
| 19 | + |
| 20 | +### Navigation Components |
| 21 | + |
| 22 | +#### Navigation Drawer |
| 23 | +- **New**: ModalNavigationDrawer documentation added |
| 24 | +- **API Changes**: |
| 25 | + - `leading_clicked` → `leading_button_clicked` |
| 26 | + - `trailing_clicked` → `trailing_button_clicked` |
| 27 | + - `leading_icon` → `leading_button` |
| 28 | + - `trailing_icon` → `trailing_button` |
| 29 | + - `current_item` → `current_index` |
| 30 | +- **New Features**: Added `index_changed` callback |
| 31 | + |
| 32 | +#### Navigation Bar |
| 33 | +- **API Changes**: Same navigation-related changes as Navigation Drawer |
| 34 | + |
| 35 | +### Form Components |
| 36 | + |
| 37 | +#### Check-Box |
| 38 | +- **Component Rename**: `CheckBoxListTile` → `CheckBoxTile` |
| 39 | +- **Various fixes** implemented |
| 40 | + |
| 41 | +#### Radio-Button |
| 42 | +- **New Components**: Added RadioButton and RadioButtonTile |
| 43 | + |
| 44 | +#### Progress-Indicator |
| 45 | +- **API Change**: `value` property → `progress` property |
| 46 | + |
| 47 | +#### Slider |
| 48 | +- **New Feature**: Added `released` callback |
| 49 | +- **Improvements**: Various slider enhancements |
| 50 | + |
| 51 | +#### Segmented-Button |
| 52 | +- **API Changes**: |
| 53 | + - `model` → `items` |
| 54 | + - `icon-selected` → `selected-icon` |
| 55 | +- **New Feature**: Added `index-changed` callback |
| 56 | + |
| 57 | +### Input Components |
| 58 | + |
| 59 | +#### Text-Field |
| 60 | +- **API Changes**: |
| 61 | + - `placeholder` → `placeholder-text` |
| 62 | + |
| 63 | +#### Time-Picker |
| 64 | +- **Component Rename**: `TimePicker` → `TimePickerPopup` |
| 65 | +- **API Changes**: |
| 66 | + - `twelf_hour_model` → `twelfth_hour_model` (typo fix) |
| 67 | + - `current_item` → `current_index` |
| 68 | + - `hour_labl` → `hour_label` (typo fix) |
| 69 | +- **New Properties**: Added various time picker properties (radius, picker_diameter, center, outer_padding, inner_padding, etc.) |
| 70 | +- **New Properties**: Added `use_24_hour_format`, `title`, `cancel_text` properties |
| 71 | + |
| 72 | +#### Date-Picker |
| 73 | +- **New Component**: Added DatePickerPopup |
| 74 | + |
| 75 | +### Button Components |
| 76 | + |
| 77 | +#### All Button Types |
| 78 | +- **API Changes**: Same typography and animation system updates as listed above |
| 79 | + |
| 80 | +### Layout Components |
| 81 | + |
| 82 | +#### List |
| 83 | +- **API Changes**: |
| 84 | + - `action-icon` → `action-button-icon` |
| 85 | + |
| 86 | +#### Badge |
| 87 | +- **API Changes**: |
| 88 | + - `empty-badge` → `show-badge` |
| 89 | + |
| 90 | +### Menu Components |
| 91 | + |
| 92 | +#### Menu |
| 93 | +- **New Component**: Added Menu component |
| 94 | +- **API Changes**: |
| 95 | + - `item_clicked` → `activated` callback |
| 96 | + - Component rename: `Menu` → `PopupMenu` |
| 97 | + |
| 98 | +#### Drop-Down-Menu |
| 99 | +- **New Component**: Added DropDownMenu |
| 100 | +- **API Changes**: |
| 101 | + - Added `selected` callback |
| 102 | + |
| 103 | +### Dialog Components |
| 104 | + |
| 105 | +#### Dialog & SnackBar |
| 106 | +- **Multi-rename changes** |
| 107 | + |
| 108 | +#### Action-Chip & Search-Bar |
| 109 | +- **API Changes**: |
| 110 | + - `avatar` → `avatar-icon` |
| 111 | + |
| 112 | +### Visual Components |
| 113 | + |
| 114 | +#### Check-Box (Icon Properties) |
| 115 | +- **API Changes**: |
| 116 | + - `icon-checked` → `checked-icon` |
| 117 | + |
| 118 | +#### Various Components |
| 119 | +- **API Changes**: |
| 120 | + - `container-background` → `show-background` |
| 121 | + |
| 122 | +## New Components Added |
| 123 | + |
| 124 | +1. **Radio-Button** and **RadioButtonTile** |
| 125 | +2. **Menu** component |
| 126 | +3. **Drop-Down-Menu** component |
| 127 | +4. **Date-Picker-Popup** component |
| 128 | +5. **Modal-Navigation-Drawer** documentation |
| 129 | + |
| 130 | + |
0 commit comments