FBSDKTooltipView Class Reference
Inherits from | UIView |
Declared in | FBSDKTooltipView.h |
Overview
Tooltip bubble with text in it used to display tips for UI elements, with a pointed arrow (to refer to the UI element).
The tooltip fades in and will automatically fade out. See displayDuration
.
Tasks
-
displayDuration
property -
colorStyle
property -
message
property -
tagline
property -
– initWithTagline:message:colorStyle:
-
– presentFromView:
-
– presentInView:withArrowPosition:direction:
-
– dismiss
Properties
colorStyle
Gets or sets the color style after initialization. Defaults to value passed to -initWithTagline:message:colorStyle:.
@property (nonatomic, assign) FBSDKTooltipColorStyle colorStyle
Declared In
FBSDKTooltipView.h
displayDuration
Gets or sets the amount of time in seconds the tooltip should be displayed. Set this to zero to make the display permanent until explicitly dismissed. Defaults to six seconds.
@property (nonatomic, assign) CFTimeInterval displayDuration
Declared In
FBSDKTooltipView.h
Instance Methods
dismiss
Remove tooltip manually.
- (void)dismiss
Discussion
Calling this method isn’t necessary - tooltip will dismiss itself automatically after the displayDuration
.
Declared In
FBSDKTooltipView.h
initWithTagline:message:colorStyle:
Designated initializer.
- (instancetype)initWithTagline:(NSString *)tagline message:(NSString *)message colorStyle:(FBSDKTooltipColorStyle)colorStyle
Discussion
Parameter tagline: First part of the label, that will be highlighted with different color. Can be nil.
Parameter message: Main message to display.
Parameter colorStyle: Color style to use for tooltip.
If you need to show a tooltip for login, consider using the FBSDKLoginTooltipView
view.
- See:FBSDKLoginTooltipView
Declared In
FBSDKTooltipView.h
presentFromView:
Show tooltip at the top or at the bottom of given view. Tooltip will be added to anchorView.window.rootViewController.view
- (void)presentFromView:(UIView *)anchorView
Discussion
- Parameter anchorView: view to show at, must be already added to window view hierarchy, in order to decide where tooltip will be shown. (If there’s not enough space at the top of the anchorView in window bounds - tooltip will be shown at the bottom of it)
Use this method to present the tooltip with automatic positioning or use -presentInView:withArrowPosition:direction: for manual positioning If anchorView is nil or has no window - this method does nothing.
Declared In
FBSDKTooltipView.h
presentInView:withArrowPosition:direction:
Adds tooltip to given view, with given position and arrow direction.
- (void)presentInView:(UIView *)view withArrowPosition:(CGPoint)arrowPosition direction:(FBSDKTooltipViewArrowDirection)arrowDirection
Discussion
Parameter view: View to be used as superview.
Parameter arrowPosition: Point in view’s cordinates, where arrow will be pointing
Parameter arrowDirection: whenever arrow should be pointing up (message bubble is below the arrow) or down (message bubble is above the arrow).
Declared In
FBSDKTooltipView.h