Skip to content

Latest commit

 

History

History
189 lines (151 loc) · 12.3 KB

MIGRATION.md

File metadata and controls

189 lines (151 loc) · 12.3 KB
Raw

Upgrade Notes

v8.0.0

  • Ground up refactor of the way the MaterialDrawer is used and integrated into the app.
  • Please consider carefully before upgrading to this version.
  • Prior to v8 the Drawer would automatically inject the DrawerLayout into the layout hierarchy, apply window flags, and take over control of the ActionBarDrawerToggle.
    • This may seem convenient for easy usecases, but created big problems for more advanced implementations where taking over window insets is expected
    • v8 will no longer do any of this, and gives back all the control to the developer, no more unexpected layout flags, changes to the layout hierarchy or anything similar.
  • The core principle behind v8 is to offer just the UI and give back all control to developers.
  • Additionally v8 eliminates dependencies on Materialize, Android-Iconics
  • v8 also now comes with better theming support and better dark mode support
  • As v8 is ground up different in the way it is set up it is recommended to re-read the README and check out the sample again
  • Basic upgrade procedure:
    • Add DrawerLayout into your layout
    • Add MaterialDrawerSliderView as child to the DrawerLayout
    • Find the reference to the MaterialDrawerSliderView in your Activity / Fragment
    • Use the MaterialDrawerSliderView to fill the list / do updates
  • Basic upgrade prodedure for the AccountHeader:
    • Create an instance of the AccountHeaderView
    • Attach to the slider via attachToSliderView(slider)
  • Additionally v8 is more optimized for Kotlin meaning all legacy with(*) methods were replaced (kept as extension functions as legacy support) with properties
Note
  • Please report if additional upgrade notes are required

v7.0.0

Now library is kotlin-first.

  • this release contains a big amount of changes, including many breaking API changes to make its implementation easier, and make the APIs better compatible with kotlin.

  • please note that the interface for items changed in the FastAdapter as such migrating to the new version will require more effort.

  • Update FastAdapter to v4 and make all relevant adjustments to the provided DrawerItems

  • Update Android-Iconics to v4

    • Ensure to update Android-Iconics for your project, and use the updated kotlin icon dependencies
    • See the migration notes for Android-Iconics if you run into problems

  • The general interfaces and everything stayed the same, and mainly everything was migrated to kotlin

If you have any issues during the migration, or any questions come up please open a github issue so we can improve the migration guide or the documentation.

v6.1.1

  • Further adjustments for the theme to properly meet the new material 2 design guidelines.
<item name="material_drawer_header_selection_subtext">@color/material_drawer_header_selection_subtext</item> <!-- Defines the color of the subtext item in the header -->

v6.1.0-rc01.2

  • With the introduction of the material 2 design behaviour, new theme attributes were added.
<item name="material_drawer_selected_legacy">@color/material_drawer_selected</item> <!-- Defines the color if legacy style (Material 1, is enabled) -->
<item name="material_drawer_legacy_style">true</item> <!-- Enables legacy Material 1 style -->
  • Reworked the header views to be a lot more simple by using a ConstraintLayout
    • Any previously custom headers require to be adjusted to the new structure. (The statusbar Guideline is required, for example)
  • The viewHolder.item has no longer the item itself as tag directly. It is now defined with an id R.id.material_drawer_item. ViewHolder.itemView.getTag(R.id.material_drawer_item) will now return the IDrawerItem.

v6.1.0-rc01

  • Final upgrade to the new shiny androidX dependencies :)

v6.0.3

IMPORTANT IF YOU USE THE FASTADAPTER OR ABOUTLIBRARIES

v6.0.0

IMPORTANT IF YOU USE THE FASTADAPTER OR ABOUTLIBRARIES

v5.9.0 & v5.9.2

IMPORTANT IF YOU USE THE FASTADAPTER OR ABOUTLIBRARIES

v5.8.0

IMPORTANT IF YOU USE THE FASTADAPTER OR ABOUTLIBRARIES

v5.7.0

IMPORTANT IF YOU IMPLEMENT CUSTOM-DRAWER-ITEMS OR USE THE FASTADAPTER

  • You have to update your FastAdapter dependency to v2.0.0 with this release
  • If you have CustomDrawerItem's not based on the AbstractDrawerITems make sure you implement the unbindView method, and the new required methods
  • See the MIGRATION information of the FastAdapter https://github.com/mikepenz/FastAdapter/blob/develop/MIGRATION.md

v5.6.0

IMPORTANT IF YOU IMPLEMENT CUSTOM-DRAWER-ITEMS OR USE THE FASTADAPTER

  • This release brings a breaking interface change. Your items now have to implement bindView(ViewHolder holder, List payloads) instead of bindView(VH holder).
  • The additional payload can be used to implement a more performant view updating when only parts of the item have changed. Please also refer to the DiffUtils which may provide the payload.

v5.5.1

  • add void set(ImageView imageView, Uri uri, Drawable placeholder, String tag); to IDrawerImageLoader interface, similar to the tag provided in the placeholder method

v5.5.0

  • Dropping support for API < 14. New MinSdkVersion is 14

v5.3.3 -> 5.3.4

v5.3.1 -> v5.3.2

  • the withOnMiniDrawerItemClickListener was renamed to withOnMiniDrawerItemOnClickListener
  • added new separate OnMiniDrawerItemClickListener which allows to hook into the default behavior, and prevent it if necessary
  • NOTE: this one now uses the withOnMiniDrawerItemClickListener method.

v5.2.0 -> v5.2.1

  • the SecondaryDrawerItem is now a subclass of the PrimaryDrawerItem (extends PrimaryDrawerItem). If you have an if which checks for the type with instanceOf make sure you check for the SecondaryDrawerItem first. (secondaryDrawerItem instanceOf PrimaryDrawerItem == true)

v5.1.6 -> 5.1.8

v5.0.0 -> 5.0.5

v4.6.0 -> v5.0.0

  • the identifier was changed from int to long as the internal adapter (FastAdapter) uses long to identify items (as the Adapter does)
  • v5.0.0 no longer sets the FULL_SCREEN flag to get the drawer below the StatusBar it now uses the fitsSystemWindows everywhere. This should improve compatiblity with a lot of things like the CoordinatorLayout and should also improve compatiblity with future Android updates
  • removed the following methods:
  • DrawerUIUtils.getScreenWidth -> moved to UIUtils from the Materialize library
  • DrawerBuilder.withTranslucentStatusBarProgrammatically -> no longer necessary as we now depend on the fitsSystemWindows flag
  • StatusBarColor can now be set via the Drawer.getDrawerLayout().setStatusBarBackgroundColor(color)
  • DrawerBuilder.keyboardSupportEnabled -> KeyboardUtil should no longer be necessary
  • StatusBar on API < 21 is no longer colored, because of the changed way how we display the Drawer under the StatusBar
  • DrawerItems changed. Please take a look at the CustomDrawerItems from the sample or the default ones, to add the changes to your CustomDrawerItems
  • ...

v4.5.9 -> v4.6.0

  • it is now possible to let the Drawer manage the MiniDrawer. Enable this via withGenerateMiniDrawer(true). Afterwards remove the MiniDrawer calls inside the listeners, those are now done within the Drawer. You can get the MiniDrawer result object via Drawer.getMiniDrawer();

v4.3.7 -> v4.4.3

  • added new method withHeaderPadding to the drawer and withPaddingBelowHeader to the header to control the padding separately from the dividerwhich can be controlled via withHeaderDivider

v4.3.7

  • depends on the latest v23.1.0 support libraries. Those also require you to have compileSDKVersion 23

v4.2.0 -> v4.3.0

  • new placeholder(Context ctx, String tag) to the IDrawerImageLoader interface
  • new AbstractDrawerImageLoader to simplify the DrawerImageLoader usage. See the new implementation in the CustomApplication
  • to keep the old behavior just change from new DrawerImageLoader.IDrawerImageLoader() { to new AbstractDrawerImageLoader() { for the DrawerImageLoader.init
  • add new tag to the placeholder, to be able to define different placeholders for different targets

v4.2.0

  • no more need to define an identifier for the items, they get one automatically. if you do not have logics which require you to do so, you are safe to forget about the identifier now.

v4.0.2 -> v4.0.7

  • renamed setDivider() to withDivider
  • remove setTypeface() use withTypeface() instead

v4.0.0 -> v4.0.2

  • getCurrentSelection() will now return the identifier of the current selection or null
  • getCurrentSelectedPosition() was added
  • renamed all *Footer* methods to *StickyFooter* to prevent confusion

< v4.0.0

Common changes
  • depends on the latest v23 support libraries. Those also require you to have compileSDKVersion 23
  • change the onItemClick listener to onItemClick(View view, int i, IDrawerItem iDrawerItem)
  • modify the import of the AccountHeader and AccountHeaderBuilder to
import com.mikepenz.materialdrawer.AccountHeader
import com.mikepenz.materialdrawer.AccountHeaderBuilder
  • the identifier should now be set for the DrawerItems as it is used now as default for all update/modify/.. actions
  • rename withCheckable() to withSelectable()
  • rename set* methods of the DrawerItems to with* methods as those were renamed
  • rename all methods like setSelection, setFooterSelection, removeItem, ... to *ByPosition (added the ByPosition)
  • rename all methods like setSelectionByIdentifier, setFooterSelectionByIdentifier, ... to setSelection, setFooterSelection (removed the ByIdentifier)
  • change updateName, updateIcon, updateBadge those methods take now an identifier and the specific Holder object
  • all get* methods of the DrawerItems will now return a Holder object for the specific type, making it easier to work with types like String, StringRes, Color, ColorRes, ColorInt, ..
Android-Iconics (icon font)
compile 'com.mikepenz:google-material-typeface:1.2.0.1@aar' //Google Material Design Icons
compile 'com.mikepenz:fontawesome-typeface:4.4.0.1@aar' //FontAwesome **NOTE:** the packagename changed for this font
Advanced usage changes
  • changed the ListView to a RecyclerView
  • rename methods with *ListView* to *RecyclerView*
  • the IDrawerItem interface was extended to better reflect a RecyclerView and to improve performance
  • added an AbstractDrawerItem to implement some common methods
  • see the SectionDrawerItem for an easy example