components/Snackbar/src/private/MDCSnackbarOverlayView.h

// Copyright 2016-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 "MDCSnackbarAlignment.h"

@class MDCSnackbarMessageView;

/** The identifier reported for the Snackbar. */
OBJC_EXTERN NSString *const MDCSnackbarOverlayIdentifier;

/** The time it takes to show or hide the Snackbar. */
OBJC_EXTERN NSTimeInterval const MDCSnackbarLegacyTransitionDuration;

/**
 Custom overlay view for displaying Snackbars.
 */
@interface MDCSnackbarOverlayView : UIView

/**
 Designated initializer.

 Creates an overlay view which uses @c watcher to get its keyboard position information.
 */
- (instancetype)initWithFrame:(CGRect)frame;

/**
 Shows the Snackbar view with the most appropriate animation.

 @param snackbarView The Snackbar view to display.
 @param animated Whether or not the show should be animated.
 @param completion A block to execute when the presentation is finished.
 */
- (void)showSnackbarView:(MDCSnackbarMessageView *)snackbarView
                animated:(BOOL)animated
              completion:(void (^)(void))completion;

/**
 Dismisses the currently showing Snackbar view.

 @param animated Whether or not the dismiss should be animated.
 @param completion A block to execute when the dismissal is finished.
 */
- (void)dismissSnackbarViewAnimated:(BOOL)animated completion:(void (^)(void))completion;

/**
 How far from the bottom of the screen Snackbars should be presented when @c verticalAlignment is @c
 MDCSnackbarHorizontalAlignmentBottom.

 If set inside of an animation block, the change will animate.
 */
@property(nonatomic) CGFloat bottomOffset;

/**
 Determines the horizontal alignment of the Snackbar on the screen (iPad only).

 If called within an animation block, the change will be animated.

 @note This method must be called from the main thread.
*/
@property(nonatomic) MDCSnackbarHorizontalAlignment horizontalAlignment;

/**
 Determines the vertical alignment of the Snackbar on the screen.

 @note This method must be called from the main thread.
*/
@property(nonatomic) MDCSnackbarVerticalAlignment verticalAlignment;

/**
 Determines the Snackbar's leading margin to the safe area of the screen.

 Defaults to 8 when the traitCollection horizontal size class is compact.

 Defaults to 24 when the traitCollection horizontal size class is regular.
 */
@property(nonatomic, assign) CGFloat leadingMargin;

/**
 Determines the Snackbar's trailing margin to the safe area of the screen.

 Defaults to 8 when the traitCollection horizontal size class is compact.

 Defaults to 24 when the traitCollection horizontal size class is regular.
 */
@property(nonatomic, assign) CGFloat trailingMargin;

/**
 Determines the Snackbar's top margin to the safe area of the screen.

 Defaults to 8.
 */
@property(nonatomic, assign) CGFloat topMargin;

@end