components/NavigationDrawer/src/private/MDCBottomDrawerContainerViewController.h - external/github.com/material-components/material-components-ios.git - Git at Google

 // Copyright 2018-present the Material Components for iOS authors. All Rights Reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 // http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.

 #import <UIKit/UIKit.h>
 #import "MDCBottomDrawerState.h"
 // TODO(b/151929968): Delete import of delegate headers when client code has been migrated to no
 // longer import delegates as transitive dependencies.
 #import "MDCBottomDrawerContainerViewControllerDelegate.h"
 #import "MaterialShadowElevations.h"

 @class MDCBottomDrawerContainerViewController;
 @protocol MDCBottomDrawerHeader;
 @protocol MDCBottomDrawerContainerViewControllerDelegate;

 /**
  View controller for containing a Material bottom drawer. Used internally only.
  */
 @interface MDCBottomDrawerContainerViewController : UIViewController <UIGestureRecognizerDelegate>

 /**
  Designated initializer.

  @param originalPresentingViewController The original presenting view controller.
  */
 - (nonnull instancetype)initWithOriginalPresentingViewController:
                             (nonnull UIViewController *)originalPresentingViewController
                                               trackingScrollView:
                                                   (nullable UIScrollView *)trackingScrollView
     NS_DESIGNATED_INITIALIZER;

 - (nonnull instancetype)init NS_UNAVAILABLE;
 - (nonnull instancetype)initWithCoder:(nonnull NSCoder *)aDecoder NS_UNAVAILABLE;
 - (nonnull instancetype)initWithNibName:(nullable NSString *)nibNameOrNil
                                  bundle:(nullable NSBundle *)nibBundleOrNil NS_UNAVAILABLE;

 /**
  The content displayed by the drawer.
  Its height is determined by the returned preferred content size.
  */
 @property(nonatomic, nullable) UIViewController *contentViewController;

 /**
  A header to display above the drawer's main content.
  Its height is determined by the returned preferred content size.
  */
 @property(nonatomic, nullable) UIViewController<MDCBottomDrawerHeader> *headerViewController;

 /**
  The header's shadow color. Defaults to black with 20% opacity.
  */
 @property(nonatomic, strong, nullable) UIColor *headerShadowColor;

 /**
  The drawer's top shadow color. Defaults to black with 20% opacity.
  */
 @property(nonatomic, strong, nullable) UIColor *drawerShadowColor;

 /**
  The drawer's elevation. Defaults to MDCShadowElevationNavDrawer.
  */
 @property(nonatomic, assign) MDCShadowElevation elevation;

 // The original presenting view controller.
 @property(nonatomic, readonly, nonnull) UIViewController *originalPresentingViewController;

 /**
  Setting the tracking scroll view allows the drawer scroll the content seamlessly as part of
  the drawer movement. This allows the provided scroll view to load the visible
  content as the drawer moves, and therefore not load all the content at once
  and allow to reuse the cells when using a UICollectionView or UITableView.
  */
 @property(nonatomic, weak, nullable) UIScrollView *trackingScrollView;

 // Whether the drawer is currently animating its presentation.
 @property(nonatomic) BOOL animatingPresentation;

 // Whether the drawer is currently animating its dismissal.
 @property(nonatomic) BOOL animatingDismissal;
 /**
  Delegate to tell the presentation controller when the drawer will change state.
  */
 @property(nonatomic, weak, nullable) id<MDCBottomDrawerContainerViewControllerDelegate> delegate;

 /**
  The current state of the bottom drawer.
  */
 @property(nonatomic, readonly) MDCBottomDrawerState drawerState;

 /**
  A boolean value that indicates whether the drawer is currently the full height of the window.
  */
 @property(nonatomic, readonly) BOOL contentReachesFullscreen;

 /**
  The height added to the bottom of the navigation drawer to hide the scrim.
  Defaults to 0.
  */
 @property(nonatomic, assign) CGFloat addedHeight;

 /**
  The height of the drawer at initial layout. This is an absolute point-based value.

  Defaults to 50% of the screens height.

  @note In VoiceOver, SwitchControl, and UIUserInterfaceSizeClassCompact (mobile landscape) the
  value will equal to 100% of the screens height.
  */
 @property(nonatomic, assign) CGFloat maximumInitialDrawerHeight;

 /**
  The absolute height in points to which the drawer may expand when a user scrolls.

  Defaults to 0, indicating no value has been set and it should use the default behavior of 100% of
  the screen's height.

  If the value is larger than the container's height, this will allow the drawer to be scrolled to
  the full height of the container.
  */
 @property(nonatomic, assign) CGFloat maximumDrawerHeight;

 /**
  A flag allowing clients to opt-in to the drawer adding additional height to the content to include
  the bottom safe area inset. This will remove the need for clients to calculate their content size
  with the bottom safe area when setting the preferredContentSize of the contentViewController.
  Defaults to NO.
  */
 @property(nonatomic, assign) BOOL shouldIncludeSafeAreaInContentHeight;

 /**
  A flag allowing clients to opt-in to adding additional height to the initial presentation of the
  drawer to include the bottom safe area inset. This will remove the need for clients to calculate
  their desired maximum height with the bottom safe area when setting the maximumInitialDrawerHeight.
  Defaults to NO.
  */
 @property(nonatomic, assign) BOOL shouldIncludeSafeAreaInInitialDrawerHeight;

 /**
  This flag allows clients to have the drawer content scroll below the status bar when no header is
  provided.

  Note: This flag is only applicable when @c headerViewController` is nil. If @c headerViewController
  is non-nil, setting this flag to YES will have no effect.

  Defaults to NO.
  */
 @property(nonatomic, assign) BOOL shouldUseStickyStatusBar;

 /**
  Determines if the header should always expand as it approaches the top of the screen.
  If the content height is smaller than the screen height then the header will not expand unless this
  flag is enabled.
  Defaults to NO.
  */
 @property(nonatomic, assign) BOOL shouldAlwaysExpandHeader;

 /**
  Determines the behavior of the drawer when the content size changes.
  If enabled, the drawer will automatically adjust the visible height as needed, otherwise the
  visible height will not be changed to reflect the updated content height.
  Defaults to NO.
  */
 @property(nonatomic, assign) BOOL shouldAdjustOnContentSizeChange;

 /**
  Whether layout adjustments should be made to support iPad Slide Over.

  Defaults to NO to maintain the same behavior that existed before this property
  was added and to allow apps to migrate on their own schedule.
  */
 @property(nonatomic) BOOL adjustLayoutForIPadSlideOver;

 /**
  Whether to display mobile landscape view as fullscreen.

  When enabled, the drawer will fill the screen in landscape on mobile devices.

  Defaults to YES.
 */
 @property(nonatomic, assign) BOOL shouldDisplayMobileLandscapeFullscreen;

 /** Whether the drawer allows the user to drag it or not. */
 @property(nonatomic) BOOL userDraggingEnabled;

 /**
  Sets the content offset Y of the drawer's content. If contentOffsetY is set to 0, the
  drawer will scroll to the start of its content.

  @param contentOffsetY the content offset Y of the scroll view.
  @param animated a bool if to animate the scrolling.
  */
 - (void)setContentOffsetY:(CGFloat)contentOffsetY animated:(BOOL)animated;

 /**
  Expands the drawer to fullscreen with animation.

  note: If the drawer has less content than the full screen,
  this method will still expand the drawer to fullscreen.

  @param duration The total duration of the animations, measured in seconds. If you specify a
  negative value or 0, the changes are made without animating them.

  @param completion A block object to be executed when the animation sequence ends. This block has
  no return value and takes a single Boolean argument that indicates whether or not the animations
  actually finished before the completion handler was called. If the duration of the animation is 0,
  this block is performed at the beginning of the next run loop cycle. This parameter may be NULL.
  */
 - (void)expandToFullscreenWithDuration:(CGFloat)duration
                             completion:(void (^__nullable)(BOOL finished))completion;

 @end
	// Copyright 2018-present the Material Components for iOS authors. All Rights Reserved.
	//
	// Licensed under the Apache License, Version 2.0 (the "License");
	// you may not use this file except in compliance with the License.
	// You may obtain a copy of the License at
	//
	// http://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing, software
	// distributed under the License is distributed on an "AS IS" BASIS,
	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	// See the License for the specific language governing permissions and
	// limitations under the License.

	#import <UIKit/UIKit.h>
	#import "MDCBottomDrawerState.h"
	// TODO(b/151929968): Delete import of delegate headers when client code has been migrated to no
	// longer import delegates as transitive dependencies.
	#import "MDCBottomDrawerContainerViewControllerDelegate.h"
	#import "MaterialShadowElevations.h"

	@class MDCBottomDrawerContainerViewController;
	@protocol MDCBottomDrawerHeader;
	@protocol MDCBottomDrawerContainerViewControllerDelegate;

	/**
	View controller for containing a Material bottom drawer. Used internally only.
	*/
	@interface MDCBottomDrawerContainerViewController : UIViewController <UIGestureRecognizerDelegate>

	/**
	Designated initializer.

	@param originalPresentingViewController The original presenting view controller.
	*/
	- (nonnull instancetype)initWithOriginalPresentingViewController:
	(nonnull UIViewController *)originalPresentingViewController
	trackingScrollView:
	(nullable UIScrollView *)trackingScrollView
	NS_DESIGNATED_INITIALIZER;

	- (nonnull instancetype)init NS_UNAVAILABLE;
	- (nonnull instancetype)initWithCoder:(nonnull NSCoder *)aDecoder NS_UNAVAILABLE;
	- (nonnull instancetype)initWithNibName:(nullable NSString *)nibNameOrNil
	bundle:(nullable NSBundle *)nibBundleOrNil NS_UNAVAILABLE;

	/**
	The content displayed by the drawer.
	Its height is determined by the returned preferred content size.
	*/
	@property(nonatomic, nullable) UIViewController *contentViewController;

	/**
	A header to display above the drawer's main content.
	Its height is determined by the returned preferred content size.
	*/
	@property(nonatomic, nullable) UIViewController<MDCBottomDrawerHeader> *headerViewController;

	/**
	The header's shadow color. Defaults to black with 20% opacity.
	*/
	@property(nonatomic, strong, nullable) UIColor *headerShadowColor;

	/**
	The drawer's top shadow color. Defaults to black with 20% opacity.
	*/
	@property(nonatomic, strong, nullable) UIColor *drawerShadowColor;

	/**
	The drawer's elevation. Defaults to MDCShadowElevationNavDrawer.
	*/
	@property(nonatomic, assign) MDCShadowElevation elevation;

	// The original presenting view controller.
	@property(nonatomic, readonly, nonnull) UIViewController *originalPresentingViewController;

	/**
	Setting the tracking scroll view allows the drawer scroll the content seamlessly as part of
	the drawer movement. This allows the provided scroll view to load the visible
	content as the drawer moves, and therefore not load all the content at once
	and allow to reuse the cells when using a UICollectionView or UITableView.
	*/
	@property(nonatomic, weak, nullable) UIScrollView *trackingScrollView;

	// Whether the drawer is currently animating its presentation.
	@property(nonatomic) BOOL animatingPresentation;

	// Whether the drawer is currently animating its dismissal.
	@property(nonatomic) BOOL animatingDismissal;
	/**
	Delegate to tell the presentation controller when the drawer will change state.
	*/
	@property(nonatomic, weak, nullable) id<MDCBottomDrawerContainerViewControllerDelegate> delegate;

	/**
	The current state of the bottom drawer.
	*/
	@property(nonatomic, readonly) MDCBottomDrawerState drawerState;

	/**
	A boolean value that indicates whether the drawer is currently the full height of the window.
	*/
	@property(nonatomic, readonly) BOOL contentReachesFullscreen;

	/**
	The height added to the bottom of the navigation drawer to hide the scrim.
	Defaults to 0.
	*/
	@property(nonatomic, assign) CGFloat addedHeight;

	/**
	The height of the drawer at initial layout. This is an absolute point-based value.

	Defaults to 50% of the screens height.

	@note In VoiceOver, SwitchControl, and UIUserInterfaceSizeClassCompact (mobile landscape) the
	value will equal to 100% of the screens height.
	*/
	@property(nonatomic, assign) CGFloat maximumInitialDrawerHeight;

	/**
	The absolute height in points to which the drawer may expand when a user scrolls.

	Defaults to 0, indicating no value has been set and it should use the default behavior of 100% of
	the screen's height.

	If the value is larger than the container's height, this will allow the drawer to be scrolled to
	the full height of the container.
	*/
	@property(nonatomic, assign) CGFloat maximumDrawerHeight;

	/**
	A flag allowing clients to opt-in to the drawer adding additional height to the content to include
	the bottom safe area inset. This will remove the need for clients to calculate their content size
	with the bottom safe area when setting the preferredContentSize of the contentViewController.
	Defaults to NO.
	*/
	@property(nonatomic, assign) BOOL shouldIncludeSafeAreaInContentHeight;

	/**
	A flag allowing clients to opt-in to adding additional height to the initial presentation of the
	drawer to include the bottom safe area inset. This will remove the need for clients to calculate
	their desired maximum height with the bottom safe area when setting the maximumInitialDrawerHeight.
	Defaults to NO.
	*/
	@property(nonatomic, assign) BOOL shouldIncludeSafeAreaInInitialDrawerHeight;

	/**
	This flag allows clients to have the drawer content scroll below the status bar when no header is
	provided.

	Note: This flag is only applicable when @c headerViewController` is nil. If @c headerViewController
	is non-nil, setting this flag to YES will have no effect.

	Defaults to NO.
	*/
	@property(nonatomic, assign) BOOL shouldUseStickyStatusBar;

	/**
	Determines if the header should always expand as it approaches the top of the screen.
	If the content height is smaller than the screen height then the header will not expand unless this
	flag is enabled.
	Defaults to NO.
	*/
	@property(nonatomic, assign) BOOL shouldAlwaysExpandHeader;

	/**
	Determines the behavior of the drawer when the content size changes.
	If enabled, the drawer will automatically adjust the visible height as needed, otherwise the
	visible height will not be changed to reflect the updated content height.
	Defaults to NO.
	*/
	@property(nonatomic, assign) BOOL shouldAdjustOnContentSizeChange;

	/**
	Whether layout adjustments should be made to support iPad Slide Over.

	Defaults to NO to maintain the same behavior that existed before this property
	was added and to allow apps to migrate on their own schedule.
	*/
	@property(nonatomic) BOOL adjustLayoutForIPadSlideOver;

	/**
	Whether to display mobile landscape view as fullscreen.

	When enabled, the drawer will fill the screen in landscape on mobile devices.

	Defaults to YES.
	*/
	@property(nonatomic, assign) BOOL shouldDisplayMobileLandscapeFullscreen;

	/** Whether the drawer allows the user to drag it or not. */
	@property(nonatomic) BOOL userDraggingEnabled;

	/**
	Sets the content offset Y of the drawer's content. If contentOffsetY is set to 0, the
	drawer will scroll to the start of its content.

	@param contentOffsetY the content offset Y of the scroll view.
	@param animated a bool if to animate the scrolling.
	*/
	- (void)setContentOffsetY:(CGFloat)contentOffsetY animated:(BOOL)animated;

	/**
	Expands the drawer to fullscreen with animation.

	note: If the drawer has less content than the full screen,
	this method will still expand the drawer to fullscreen.

	@param duration The total duration of the animations, measured in seconds. If you specify a
	negative value or 0, the changes are made without animating them.

	@param completion A block object to be executed when the animation sequence ends. This block has
	no return value and takes a single Boolean argument that indicates whether or not the animations
	actually finished before the completion handler was called. If the duration of the animation is 0,
	this block is performed at the beginning of the next run loop cycle. This parameter may be NULL.
	*/
	- (void)expandToFullscreenWithDuration:(CGFloat)duration
	completion:(void (^__nullable)(BOOL finished))completion;

	@end