blob: 6e785f6cf51e3723f6bada3c00ca92694c69b4f3 [file] [log] [blame]
// Copyright 2017-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 "MDCMinimumOS.h" // IWYU pragma: keep
@class MDCBadgeAppearance;
/**
An indication of the actions that might be required in a given context.
Common uses include showing the number of unread emails in an inbox or the number of unread
messages in a chat room.
*/
__attribute__((objc_subclassing_restricted))
@interface MDCBadgeView : UIView
#pragma mark - Displaying a value in the badge
/** The human-readable value, typically numerical, that will be shown for this badge. */
@property(nonatomic, copy, nullable) NSString *text;
#pragma mark - Configuring the badge's visual appearance
/** The appearance attributes for this badge. */
@property(nonatomic, copy, nonnull) MDCBadgeAppearance *appearance;
#pragma mark - Unsupported APIs
// Interface builder is not supported.
- (nullable instancetype)initWithCoder:(nonnull NSCoder *)aDecoder NS_UNAVAILABLE;
@end