Android 12 Developer Preview is here! Try it out, and give us your feedback!

SlidingPaneLayout

open class SlidingPaneLayout : ViewGroup, Openable
kotlin.Any
   ↳ android.view.View
   ↳ android.view.ViewGroup
   ↳ androidx.slidingpanelayout.widget.SlidingPaneLayout

SlidingPaneLayout provides a horizontal, multi-pane layout for use at the top level of a UI. A left (or first) pane is treated as a content list or browser, subordinate to a primary detail view for displaying content.

Child views may overlap if their combined width exceeds the available width in the SlidingPaneLayout. When this occurs the user may slide the topmost view out of the way by dragging it, or by navigating in the direction of the overlapped view using a keyboard. If the content of the dragged child view is itself horizontally scrollable, the user may grab it by the very edge.

Thanks to this sliding behavior, SlidingPaneLayout may be suitable for creating layouts that can smoothly adapt across many different screen sizes, expanding out fully on larger screens and collapsing on smaller screens.

SlidingPaneLayout is distinct from a navigation drawer as described in the design guide and should not be used in the same scenarios. SlidingPaneLayout should be thought of only as a way to allow a two-pane layout normally used on larger screens to adapt to smaller screens in a natural way. The interaction patterns expressed by SlidingPaneLayout imply a physicality and direct information hierarchy between panes that does not necessarily exist in a scenario where a navigation drawer should be used instead.

Appropriate uses of SlidingPaneLayout include pairings of panes such as a contact list and subordinate interactions with those contacts, or an email thread list with the content pane displaying the contents of the selected thread. Inappropriate uses of SlidingPaneLayout include switching between disparate functions of your app, such as jumping from a social stream view to a view of your personal profile - cases such as this should use the navigation drawer pattern instead. (DrawerLayout implements this pattern.)

Like LinearLayout, SlidingPaneLayout supports the use of the layout parameter layout_weight on child views to determine how to divide leftover space after measurement is complete. It is only relevant for width. When views do not overlap weight behaves as it does in a LinearLayout.

When views do overlap, weight on a slideable pane indicates that the pane should be sized to fill all available space in the closed state. Weight on a pane that becomes covered indicates that the pane should be sized to fill all available space except a small minimum strip that the user may use to grab the slideable view and pull it back over into a closed state.

Summary

Nested classes
open

abstract

Listener for monitoring events about sliding panes.

open

No-op stubs for PanelSlideListener.

Public constructors
<init>(@NonNull context: Context)

<init>(@NonNull context: Context, @Nullable attrs: AttributeSet?)

<init>(@NonNull context: Context, @Nullable attrs: AttributeSet?, defStyle: Int)

Public methods
open Boolean

open Unit

Close the sliding pane if it is currently slideable.

open Boolean

Close the sliding pane if it is currently slideable.

open Unit

open Unit
draw(c: Canvas!)

open LayoutParams!

open Int

open Int

open Int

open Boolean

Check if the layout is completely open.

open Boolean

Check if the content in this layout cannot fully fit side by side and therefore the content pane can be slid back and forth.

open Boolean

open Boolean

open Unit

Open the sliding pane if it is currently slideable.

open Boolean

Open the sliding pane if it is currently slideable.

open Unit
requestChildFocus(child: View!, focused: View!)

open Unit
setCoveredFadeColor(@ColorInt color: Int)

Set the color used to fade the pane covered by the sliding pane out when the pane will become fully covered in the closed state.

open Unit

open Unit
setParallaxDistance(@Px parallaxBy: Int)

Set a distance to parallax the lower pane by when the upper pane is in its fully closed state.

open Unit

open Unit

Set a drawable to use as a shadow cast by the right pane onto the left pane during opening/closing.

open Unit

Set a drawable to use as a shadow cast by the left pane onto the right pane during opening/closing to support right to left language.

open Unit
setShadowResource(@DrawableRes resId: Int)

Set a drawable to use as a shadow cast by the right pane onto the left pane during opening/closing.

open Unit