All Implemented Interfaces:

android.content.ComponentCallbacks , android.content.DialogInterface.OnCancelListener , android.content.DialogInterface.OnDismissListener , android.view.View.OnCreateContextMenuListener , androidx.activity.result.ActivityResultCaller , androidx.lifecycle.HasDefaultViewModelProviderFactory , androidx.lifecycle.LifecycleOwner , androidx.lifecycle.ViewModelStoreOwner , androidx.savedstate.SavedStateRegistryOwner
```
public abstract class SheetFragment
extends DialogFragment
                    
```
This class is the base of all types of sheets. You can implement this class in your own and build your own custom sheet with the already existing features which the base class offers.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`SheetFragment.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`dialogTag`
`private Context`	`windowContext`
`private final Integer`	`mState`
`private final Bundle`	`mSavedFragmentState`
`private final SparseArray<Parcelable>`	`mSavedViewState`
`private final Bundle`	`mSavedViewRegistryState`
`private final Boolean`	`mSavedUserVisibleHint`
`private final String`	`mWho`
`private final Bundle`	`mArguments`
`private final Fragment`	`mTarget`
`private final String`	`mTargetWho`
`private final Integer`	`mTargetRequestCode`
`private final Boolean`	`mAdded`
`private final Boolean`	`mRemoving`
`private final Boolean`	`mFromLayout`
`private final Boolean`	`mInLayout`
`private final Boolean`	`mRestored`
`private final Boolean`	`mPerformedCreateView`
`private final Integer`	`mBackStackNesting`
`private final FragmentManager`	`mFragmentManager`
`private final FragmentHostCallback<?>`	`mHost`
`private final FragmentManager`	`mChildFragmentManager`
`private final Fragment`	`mParentFragment`
`private final Integer`	`mFragmentId`
`private final Integer`	`mContainerId`
`private final String`	`mTag`
`private final Boolean`	`mHidden`
`private final Boolean`	`mDetached`
`private final Boolean`	`mRetainInstance`
`private final Boolean`	`mRetainInstanceChangedWhileDetached`
`private final Boolean`	`mHasMenu`
`private final Boolean`	`mMenuVisible`
`private final ViewGroup`	`mContainer`
`private final View`	`mView`
`private final Boolean`	`mDeferStart`
`private final Boolean`	`mUserVisibleHint`
`private final Fragment.AnimationInfo`	`mAnimationInfo`
`private final Runnable`	`mPostponedDurationRunnable`
`private final Boolean`	`mIsNewlyAdded`
`private final Boolean`	`mHiddenChanged`
`private final Float`	`mPostponedAlpha`
`private final LayoutInflater`	`mLayoutInflater`
`private final Boolean`	`mIsCreated`
`private final Lifecycle.State`	`mMaxState`
`private final LifecycleRegistry`	`mLifecycleRegistry`
`private final FragmentViewLifecycleOwner`	`mViewLifecycleOwner`
`private final MutableLiveData<LifecycleOwner>`	`mViewLifecycleOwnerLiveData`
`private final ViewModelProvider.Factory`	`mDefaultFactory`
`private final SavedStateRegistryController`	`mSavedStateRegistryController`

Constructor Summary

Constructors
Constructor	Description
`SheetFragment()`

Method Summary

Modifier and Type	Method	Description
`String`	`getDialogTag()`
`Context`	`getWindowContext()`
`Unit`	`setWindowContext(Context windowContext)`
`final Unit`	`style(SheetStyle style)`	Set sheet style.
`Unit`	`setStyle(Integer style, Integer theme)`	Override style to switch between sheet & dialog style.
`final Unit`	`cancelableOutside(Boolean cancelable)`	Set if sheet is cancelable outside.
`final Unit`	`navigationBarColor(@ColorInt() Integer color)`	Set the color of the navigation bar.
`final Unit`	`navigationBarColorRes(@ColorRes() Integer colorRes)`	Set the color of the navigation bar.
`final Unit`	`draggable(Boolean draggable)`	Set if bottom-sheet is draggable.
`final Unit`	`behavior(Integer behavior)`	Set the BottomSheetBehavior state.
`final Unit`	`peekHeight(Integer peekHeight)`	Set the peek height.
`final Unit`	`cornerFamily(Integer cornerFamily)`	Set the CornerFamily.
`final Unit`	`cornerRadius(Float cornerRadiusInDp)`	Set the corner radius in dp.
`final Unit`	`cornerRadius(@DimenRes() Integer cornerRadiusInDpRes)`	Set the corner radius in dp.
`final Unit`	`borderWidth(Float strokeWidthDp)`	Set the border stroke width
`final Unit`	`borderWidth(@DimenRes() Integer strokeWidthDpRes)`	Set the border stroke width
`final Unit`	`borderColor(Integer strokeColor)`	Set the border stroke color around the sheet.
`Integer`	`getTheme()`	Override theme to allow auto switch between day & night design.
`Unit`	`onViewCreated(View view, Bundle savedInstanceState)`
`final Integer`	`getActualCornerFamily()`
`final Float`	`getActualCornerRadius()`
`Dialog`	`onCreateDialog(Bundle savedInstanceState)`
`Unit`	`setupDialog(Dialog dialog, Integer style)`
`Unit`	`onStart()`
`Unit`	`onResume()`
`final Unit`	`show()`	Show the sheet.

Methods inherited from class com.maxkeppeler.sheets.core.SheetFragment
createFragmentContainer, dismiss, dismissAllowingStateLoss, getDialog, getShowsDialog, isCancelable, onAttach, onCancel, onCreate, onDestroyView, onDetach, onDismiss, onFindViewById, onGetLayoutInflater, onHasView, onSaveInstanceState, onStop, onViewStateRestored, performCreateView, requireDialog, setCancelable, setShowsDialog, show, show, showNow
Methods inherited from class androidx.fragment.app.DialogFragment
callStartTransitionListener, dump, equals, findFragmentByWho, generateActivityResultKey, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getAnimatingAway, getAnimator, getArguments, getChildFragmentManager, getContext, getDefaultViewModelProviderFactory, getEnterAnim, getEnterTransition, getEnterTransitionCallback, getExitAnim, getExitTransition, getExitTransitionCallback, getFocusedView, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getNextTransition, getParentFragment, getParentFragmentManager, getPopDirection, getPopEnterAnim, getPopExitAnim, getPostOnViewCreatedAlpha, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSavedStateRegistry, getSharedElementEnterTransition, getSharedElementReturnTransition, getSharedElementSourceNames, getSharedElementTargetNames, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hasOptionsMenu, hashCode, initState, isAdded, isDetached, isHidden, isHideReplaced, isInBackStack, isInLayout, isMenuVisible, isPostponed, isRemoving, isRemovingParent, isResumed, isStateSaved, isVisible, noteStateNotSaved, onActivityCreated, onActivityResult, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroy, onDestroyOptionsMenu, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, performActivityCreated, performAttach, performConfigurationChanged, performContextItemSelected, performCreate, performCreateOptionsMenu, performDestroy, performDestroyView, performDetach, performGetLayoutInflater, performLowMemory, performMultiWindowModeChanged, performOptionsItemSelected, performOptionsMenuClosed, performPause, performPictureInPictureModeChanged, performPrepareOptionsMenu, performPrimaryNavigationFragmentChanged, performResume, performSaveInstanceState, performStart, performStop, performViewCreated, postponeEnterTransition, postponeEnterTransition, registerForActivityResult, registerForActivityResult, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, restoreChildFragmentState, restoreViewState, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setAnimatingAway, setAnimations, setAnimator, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setFocusedView, setHasOptionsMenu, setHideReplaced, setInitialSavedState, setMenuVisibility, setNextTransition, setOnStartEnterTransitionListener, setPopDirection, setPostOnViewCreatedAlpha, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementNames, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SheetFragment
```
SheetFragment()
```

Method Detail

getDialogTag
```
 String getDialogTag()
```

getWindowContext
```
 Context getWindowContext()
```

setWindowContext

 Unit setWindowContext(Context windowContext)

style
```
 final Unit style(SheetStyle style)
```
Set sheet style.

setStyle
```
 Unit setStyle(Integer style, Integer theme)
```
Override style to switch between sheet & dialog style.

cancelableOutside

 final Unit cancelableOutside(Boolean cancelable)

Set if sheet is cancelable outside.

navigationBarColor

 final Unit navigationBarColor(@ColorInt() Integer color)

Set the color of the navigation bar.

navigationBarColorRes

 final Unit navigationBarColorRes(@ColorRes() Integer colorRes)

Set the color of the navigation bar.

draggable
```
 final Unit draggable(Boolean draggable)
```
Set if bottom-sheet is draggable. Only works with SheetStyle.BOTTOM_SHEET.

behavior
```
 final Unit behavior(Integer behavior)
```
Set the BottomSheetBehavior state.

peekHeight

 final Unit peekHeight(Integer peekHeight)

Set the peek height.

cornerFamily
```
 final Unit cornerFamily(Integer cornerFamily)
```
Set the CornerFamily. Overrides the style default.

cornerRadius
```
 final Unit cornerRadius(Float cornerRadiusInDp)
```
Set the corner radius in dp. Overrides the style default.

cornerRadius

 final Unit cornerRadius(@DimenRes() Integer cornerRadiusInDpRes)

Set the corner radius in dp. Overrides the style default.

borderWidth

 final Unit borderWidth(Float strokeWidthDp)

Set the border stroke width

borderWidth

 final Unit borderWidth(@DimenRes() Integer strokeWidthDpRes)

Set the border stroke width

borderColor
```
 final Unit borderColor(Integer strokeColor)
```
Set the border stroke color around the sheet. If no color is set, the primary color is used.

getTheme
```
 Integer getTheme()
```
Override theme to allow auto switch between day & night design.

onViewCreated

 Unit onViewCreated(View view, Bundle savedInstanceState)

getActualCornerFamily
```
 final Integer getActualCornerFamily()
```

getActualCornerRadius
```
 final Float getActualCornerRadius()
```

onCreateDialog

 Dialog onCreateDialog(Bundle savedInstanceState)

setupDialog

 Unit setupDialog(Dialog dialog, Integer style)

onStart
```
 Unit onStart()
```

onResume
```
 Unit onResume()
```

show
```
 final Unit show()
```
Show the sheet.

Class SheetFragment

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.maxkeppeler.sheets.core.SheetFragment

Methods inherited from class androidx.fragment.app.DialogFragment

Methods inherited from class java.lang.Object

Constructor Detail

SheetFragment

Method Detail

getDialogTag

getWindowContext

setWindowContext

style

setStyle

cancelableOutside

navigationBarColor

navigationBarColorRes

draggable

behavior

peekHeight

cornerFamily

cornerRadius

cornerRadius

borderWidth

borderWidth

borderColor

getTheme

onViewCreated

getActualCornerFamily

getActualCornerRadius

onCreateDialog

setupDialog

onStart

onResume

show