The Android Support Library package is a set of code libraries that provide backward-compatible versions of Android framework APIs as well as features that are only available through the library APIs. Each Support Library is backward-compatible to a specific Android API level. This design means that your applications can use the libraries' features and still be compatible with devices running Android 1.6 (API level 4) and up.
This guide provides information about what features are enabled by the Support Libraries, how to use them in your development environment and information about library releases.
Overview
Including the Support Libraries in your Android project is considered a best practice for application developers, depending on the range of platform versions your app is targeting and the APIs that it uses. Using the features the libraries provide can help you improve the look of your application, increase performance and broaden the reach of your application to more users. If you use the Android code template tools, you will notice that all the Android application templates include one or more of the Support Libraries by default.
The Support Libraries each target a base Android API level and each provides a different set
of features. In order to effectively use the libraries, it is important to consider what features
you want to support and understand what features are supported by each library at what Android
API level. To get started, review the
Support Library Features guide.
After that, go to the
Support Library Setup topic to
learn how to incorporate the Support Libraries into your application. For more details
about Support Library APIs, see the android.support
packages in the API reference.
Revisions
This section provides details about the Support Library package releases.
Android Support Library, revision 19.1.0 (March 2014)
- Changes for v4 support library:
-
- Added the
SwipeRefreshLayout
class, which enables users to refresh the contents of a view with a vertical swipe gesture. - Fixed accessibility issues with navigation drawers.
- Added the
- Changes for v7 appcompat library:
-
- Fixed background issues with the action bar.
Android Support Library, revision 19.0.1 (December 2013)
- Changes for v4 support library:
-
- Improved
PrintHelper
by adding asynchronous handling of printing. - Fixed the
DrawerLayout
class approximation of theaddChildrenForAccessibility()
method. - Fixed slide drawable mirroring in
ActionBarDrawerToggle
. - Fixed off-by-one issue when removing an item from a collection iterator.
- Improved
- Changes for v7 mediarouter library:
-
- Improved route identification by using full component name in the
MediaRouteProvider.ProviderMetadata
. - Updated
MediaRouteChooserDialog
to hide disabled routes.
- Improved route identification by using full component name in the
- Changes for v8 renderscript library:
-
- Added error propagation for the RenderScript thunking layer.
Android Support Library, revision 19 (October 2013)
- Changes for v4 support library:
-
- Added support for external Storage APIs with the
getObbDirs()
,getExternalFilesDirs()
,getExternalCacheDirs()
, andgetStorageState()
. These helper methods always return a single file object on devices running Android 4.3 (API level 18) and earlier. When running on Android 4.4 (API level 19) and higher, these methods may return more than one file object. - Added
PrintHelper
class that works with the Print APIs to print images with a minimum of code. - Added drag-to-open user interface support for pop-up menus. For more information, see
PopupMenuCompat
andListPopupWindowCompat
. - Improved accessibility support with the addition of a
findFocus()
method inAccessibilityNodeProviderCompat
and thegetLiveRegion()
method inAccessibilityNodeInfoCompat
. - Added helper class
ScaleGestureDetectorCompat
for accessing new scaling gesture methods. - Fixed problem with
ActionBarDrawerToggle
in right-to-left language displays. - Modified
AutoScrollHelper
option to consume touch events or allow them to be passed through to other views.
- Added support for external Storage APIs with the
- Changes for v7 mediarouter library:
-
- Added support for media playback queuing, setting HTTP header values and media playback duration.
- Added explicit start, get, and end session actions for explicitly managing media playback sessions with media router.
Android Support Library, revision 18 (July 2013)
- Changes for v4 support library:
-
- User interface
- Added
BidiFormatter
for handling text strings that combine right to left and left to right-formatted text. - Modified
ViewPager
to better handle cases where the pager has a measured width of zero in the initial layout processing. - Modified
DrawerLayout
andSlidingPaneLayout
to not throw exceptions for measurement while the project code is being edited.
- Added
- Accessibility
- Added
ExploreByTouchHelper
to simplify the implementation of accessibility for custom views. - Fixed a problem with
ViewPager
incorrectly populatingTYPE_VIEW_SCROLLED
accessibility events. - Fixed a null pointer exception in
ViewPager
when populating an accessibility event. - Simplified
AccessibilityNodeInfoCompat
by changingCharSequence
inputs toString
objects. - Deprecated an
AccessibilityRecordCompat
constructor that used anObject
as input.
- Added
- Media
- Added
TransportMediator
helper class to manage media transport control, such as play, pause, skip and other media actions. - Added
DisplayManagerCompat
for managing display output to one or more device displays.
- Added
- Other changes
- Added
WakefulBroadcastReceiver
helper class for implementing a common pattern of detecting a device wakeup event and passing work off to aService
while ensuring that the device does not go back to sleep before the handoff is complete. - Added two new APIs,
commitContentChanged()
androllbackContentChanged()
, toAsyncTaskLoader
to help deal with background updates for data changes that are subsequently canceled.
- Added
- User interface
- New v7 appcompat library:
-
- Added
ActionBar
to allow implementation of the action bar user interface design pattern back to Android 2.1 (API level 7) and higher. Use of this class requires that you implement your activity by extending the newActionBarActivity
class.
- Added
- New v7 mediarouter library:
-
Added a new mediarouter library that provides support for the Google Cast developer preview. The v7 mediarouter library APIs provide a means of controlling the routing of media channels and streams from the current device to external screens, speakers, and other destination devices, with compatibility back to Android 2.1 (API level 7). See V7 mediarouter library for more information.
The v7 mediarouter library APIs introduced in Support Library r18 are subject to change in later revisions of the Support Library. At this time, we recommend using the library only in connection with the Google Cast developer preview.
Android Support Library, revision 13 (May 2013)
- Changes for v4 support library:
-
- Added
DrawerLayout
for creating a Navigation Drawer that can be pulled in from the edge of a window. - Added
SlidingPaneLayout
widget for creating linked summary and detail views that appropriately adapt to various screen sizes. - Added
ActionBarDrawerToggle
as a way to tie together the functions ofDrawerLayout
andActionBar
. - Added
ViewDragHelper
as a new common component for dragging views within a parent view. - Added
ScrollerCompat
to provideScroller
andOverScroller
compatibility support. - Added
FileProvider
to allow sharing of private files between applications. - Updated
ViewPager
to throw an exception if the associatedPagerAdapter
class is modified without a call tonotifyDataSetChanged()
. - Fixed an issue with
ViewPager
children drawing sort order. - Fixed
GestureDetectorCompat
to dispatch missingonSingleTapConfirmed(MotionEvent)
calls between tap timeout and long press events.
- Added
- New v7 gridlayout library:
-
- Added
GridLayout
to provide support for theGridLayout
layout object. - Added
Space
which can be used to create blank areas within aGridLayout
layout object.
- Added
Android Support Library, revision 12 (February 2013)
- Changes for v4 support library:
-
- Improved interaction behavior for
ViewPager
. - Fixed a bug that could cause
ViewPager
to select the wrong page. - Fixed use of
removeView()
method during layout forViewPager
. - Fixed issue with
SearchViewCompat
where using the back button to dismiss does not clear the search text. This fix only applies to host API levels 14 and higher.
- Improved interaction behavior for
Android Support Library, revision 11 (November 2012)
- Changes for v4 support library:
-
- User Interface
- Added support for nested
Fragment
classes. - Added improvements to
FragmentManager
debugging. - Fixed problem in
FragmentTabHost
where fragment and tab interaction could result in aListView
state loss. - Fixed issue with user-visible hint in
FragmentStatePagerAdapter
. - Added
PageTransformer
interface toViewPager
to allow applications to supply a custom transition behavior for scrolling. - Added new features and fixes to
TaskStackBuilder
from current release. - Fixed
PagerTitleStrip
to correctly track thePagerAdapter
currently in use. - Fixed display flickering, positioning, and text clipping problems with
PagerTitleStrip
. - Fixed
PagerTabStrip
to properly respect padding when drawing an underline.
- Added support for nested
- Accessibility
- Added support for new accessibility gesture and touch event types in
AccessibilityEventCompat
. - Added support for new accessibility APIs in
ViewCompat
. - Added support for
performAccessibilityAction()
method toViewCompat
.
- Added support for new accessibility gesture and touch event types in
- Added support for gestures with
GestureDetectorCompat
. - Added support for performing atomic operations on files using a new
AtomicFile
class. - Added support for the full set of
make
methods inIntentCompat
. - Added
trimToSize()
method inLruCache
utility class. - Updated
ConnectivityManagerCompat
to get NetworkInfo from aCONNECTIVITY_ACTION
broadcast.
- User Interface
Android Support Library, revision 10 (August 2012)
- Changes for v4 support library:
-
- Added support for notification features introduced in Android 4.1 (API level 16) with
additions to
NotificationCompat
.
- Added support for notification features introduced in Android 4.1 (API level 16) with
additions to
Android Support Library, revision 9 (June 2012)
- Changes for v4 support library:
-
- User Interface Support
- Added
PagerTabStrip
support, providing enhanced functionality beyondPagerTitleStrip
. - Fixed various bugs for
PagerTitleStrip
andPagerTabStrip
, includingsetAllCaps
option, title alignment, appearance improvements, minimum width constraints and touch navigation issues. - Added support for
ViewPager
page gutters, which helps theViewPager
class provide paging support for content with a large horizontal scroll range, such as a map. - Fixed numerous bugs for
ViewPager
, including size and data set change problems, page positioning, user interaction, scroll tracking and keyboard navigation problems. - Fixed many bugs for
Fragment
, including proper handling ofonActivityResult()
when the target fragment no longer exists, dispatching selection events to invisible fragments, improvedFragmentTransaction.replace()
behavior and added better state handling for fragments being moved out of view. - Added support for the
postOnAnimation()
method inViewCompat
. - Updated
NavUtils
to use Android 4.1 (API level 16) Up navigation functionality when available.
- Added
- Accessibility
- Updated accessibility support classes, including
AccessibilityNodeInfoCompat
, to follow fixes made in Android 4.1 (API level 16). - Added support for accessibility scroll actions in
ViewPager
.
- Updated accessibility support classes, including
- General improvements
- Updated
TaskStackBuilder
to reflect API changes in Android 4.1 (API level 16). - Enhanced
TaskStackBuilder
to allow it to be used from a Service. - Added support for
EXTRA_HTML_TEXT
toShareCompat
. - Updated
NotificationCompat.Builder
to support thesetNumber()
method. - Added support in
ConnectivityManagerCompat
for theisActiveNetworkMetered()
method.
- Updated
- User Interface Support
Android Support Library, revision 8 (April 2012)
- Changes for v4 support library:
-
- Fixed intent flags for
PendingIntent
objects generated byTaskStackBuilder
. - Removed unused attributes from the gridlayout library projects to make sure the library can be built with API level 7 and higher.
- Added
.classpath
and.project
files for the gridlayout library project.
- Fixed intent flags for
Android Support Library, revision 7 (March 2012)
- Changes for v4 support library:
-
- Added
ShareCompat
, which provides helper classes for sending and receiving content for social sharing applications, including new metadata for attributing shared data to the source app. This class also provides compatible integration with the newShareActionProvider
in Android 4.0. - Added
NavUtils
andTaskStackBuilder
to provide support for implementing the Android Design guidelines for navigation. These additions include a way to implement the action bar's Up button across versions. For an example implementation of this pattern, see the AppNavigation sample in (<sdk>/samples/<platform>/AppNavigation
). - Added
NotificationCompat.Builder
to provide a compatibility implementation of Android 3.0'sNotification.Builder
helper class for creating standardized system notifications.
- Added
Android Support Library, revision 6 (December 2011)
Note: Reference for support library APIs are now available with
the framework references, for example: android.support.v4.app
.
- Changes for v4 support library:
-
- Changes to ViewPager:
- Added extra decorative view support for
ViewPager
. Decorative views may be supplied as child views of a pager in XML layout. - Added
PagerAdapter.getPageTitle()
to supply title strings for pages, which defaults to no title for each page. - Added
PagerTitleStrip
, a non-interactive title strip, that can be added as a child of ViewPager. Developers can supply text appearance and color, as well as layout sizing and gravity information. - Updated
PagerAdapter
methods to take ViewGroup objects, rather than View to avoid class casting in adapter implementations. - Updated
ViewPager
to use Launcher-style fling behavior. - Bug fixes for user interface interaction and test automation.
- Added extra decorative view support for
- Support for Fragments:
- Changed
setStartDeferred()
method tosetUserVisibleHint(boolean)
. - Added deferred start for off-screen pages to improve performance.
- Changed
- Support for Accessiblity APIs:
- Updated
AccessibilityDelegateCompat
methods to return empty lists instead of null. - Added new APIs needed by the v4 samples.
- Updated
- Changes to ViewPager:
Android Support Library, revision 5 (December 2011)
- Changes for v4 support library:
-
- Support for Accessiblity APIs:
- Added
AccessibilityDelegateCompat
to supportView.AccessibilityDelegate
. - Added
AccessibilityEventCompat
to supportAccessibilityEvent
. - Added
AccessibilityManagerCompat
to supportAccessibilityManager
. - Added
AccessibilityNodeInfoCompat
to supportAccessibilityNodeInfo
. - Added
AccessibilityRecordCompat
to supportAccessibilityRecord
. - Added
AccessibilityServiceInfoCompat
to supportAccessibilityServiceInfo
. - Added
ViewGroupCompat
to support accessibility features inViewGroup
. - Modified
ViewCompat
to support accessibility features inView
.
- Added
- Changes to ViewPager:
- Added support for margins between pages.
An optional
Drawable
can be provided to fill the margins. - Added support for
EdgeEffect
. - Added support for keyboard navigation
- Added support to control how many pages are kept to either side of the current page.
- Improved touch physics.
- Bug fixes for user interface behavior.
- Added support for margins between pages.
An optional
- Support for Accessiblity APIs:
Android Support Library, revision 4 (October 2011)
- Changes for v4 support library:
-
- Added
EdgeEffectCompat
to supportEdgeEffect
. - Added
LocalBroadcastManager
to allow applications to easily register for and receive intents within a single application without broadcasting them globally. - Added support in
ViewCompat
to check for and set overscroll modes forView
s on Android 2.3 and later. - Changes to Fragment APIs:
- Added new APIs to control the visibility of new menus.
- Added custom animation APIs.
- Added APIs in
FragmentActivity
to retain custom, non-configuration instance data. - Various bug fixes.
- Fixed a
Loader
bug that caused issues in cancelingAsyncTask
s when running on Froyo and older versions of the platform. The support code now uses its own version ofAsyncTask
to keep the same behavior on all platform versions.
- Added
Android Support Library, revision 3 (July 2011)
- Changes for v4 support library:
-
- Adds support for
Fragment.SavedState
- Adds
MotionEventCompat
to support newerMotionEvent
APIs - Adds
VelocityTrackerCompat
to support a newerVelocityTracker
APIs - Adds
ViewConfigurationCompat
to support a newerViewConfiguration
APIs - All new APIs (available only in the support library) that allow you to create UIs
with horizontal paging, allowing users to swipe left and right between content views. Classes to
support this include:
ViewPager
: AViewGroup
that manages the layout for the child views, which the user can swipe between.PagerAdapter
: An adapter that populates theViewPager
with the views that represent each page.FragmentPagerAdapter
: An extension ofPagerAdapter
for flipping between fragments.FragmentStatePagerAdapter
: An extension ofPagerAdapter
for flipping between fragments that uses the library's support forFragment.SavedState
.
- Adds support for
- New v13 support library:
-
- Includes the
FragmentPagerAdapter
andFragmentStatePagerAdapter
to support the horizontal paging.These are exactly the same as the APIs added to the v4 support library, but rely on other platform components in Android 3.2. Use this library instead of v4 if you're developing for Android 3.2 and higher (all other APIs in the v4 library are already available with API level 13).
- Includes the
Android Support Library, revision 2 (May 2011)
- Changes for v4 library:
-
- Support for fragment animations
- Fix
Fragment.onActivityResult()
bug
Android Support Library, revision 1 (March 2011)
Initial release with the v4 library.