Customize¶

1. Create a UIView subclass that follows the YSLHeaderProtocol:

// Objective-C
@interface CustomHeaderView : UIView <YSLHeaderProtocol>
...
@end

// Swift
class CustomHeaderView: UIView, YSLHeaderProtocol

2. Set your Search View Controller’s headerView property to an instance of your CustomHeader class:

// Objective-C
searchViewController.headerView = [CustomHeaderView new];

// Swift
var headerView: CustomHeaderView! = CustomHeaderView()
searchViewController.headerView = headerView

You can view more details regarding YSLHeaderProtocol and a working Custom HeaderView demo in the DemoApp.

1. Create a UIView subclass that follows the YSLVerticalSelector protocol:

// Objective-C
@interface CustomFooterView : UIView <YSLVerticalSelector>
...
@end

// Swift
class CustomFooterView: UIView, YSLVerticalSelector

2. Set your Search View Controller’s footerView property to an instance of your CustomFooter class:

// Objective-C
searchViewController.footerView = [CustomFooterView new];

// Swift
var footerView: CustomFooterView! = CustomFooterView()
searchViewController.footerView = footerView

You can view more details about the YSLVerticalSelector protocol and a working Custom FooterView demo in the DemoApp.

1. Create a new UIViewController that will serve as the background:

//Objective-C
@interface BackgroundViewController : UIViewController

// Swift
class BackgroundViewController: UIViewController

2. Set your Search View Controller’s landingViewController property to an instance of your BackgroundViewController class, and disable hiding of the landing page (by default, the landing page is hidden):

// Objective-C
searchViewController.landingPageViewController = [BackgroundViewController new];
searchViewController.hideLandingPage = NO;

// Swift
var backgroundViewController: BackgroundViewController! = BackgroundViewController()
searchViewController.landingPageViewController = backgroundViewController
searchViewController.hideLandingPage = false

1. Register a custom vertical class that complies to the YSLSearchProtocol with the search result type. This registration is saved in YSLSetting. So you don’t need to re-register for multiple YSLSearchViewController instances. Registering more than once or registering for the pre-defined search result type Web, Image, Video will throw a NSInvalidArgumentException exception.

   @interface MyCustomTab : UIViewController <YSLSearchProtocol>
   @end
   

   [[YSLSetting sharedSetting] registerSearchResultClass:[MyCustomTab class] forType:@"myTabResultType"];
   

2. Registration alone does not present the custom search tab. You need to include that searchResultType in setSearchResultTypes API. You can decide the order in which the searchResultTypes have to be shown before the searchViewController is presented.

   YSLSearchViewController *searchViewController = [YSLSearchViewController new];
   [searchViewController setSearchResultTypes:@[@"myTabResultType",YSLSearchResultTypeWeb,YSLSearchResultTypeImage,YSLSearchResultTypeVideo]];
   

3. You can optionally choose to deregister the custom tab class. But, de-registration does not remove the custom tab from the presentation. After de-registration, setSearchResultTypes has to be called without the custom search result type to remove it from the presentation.

   [[YSLSetting sharedSetting] deregisterSearchResultType:@"myTabResultType"];