Andrew Overton 07c46757cc Replace material.io API doc links with links to the relevant header f…
This PR replaces API links containing "/api-docs/" with links to suitable header files in GitHub because the site previously linked to is being taken down and replaced with something that won't handle API docs.

Closes https://github.com/material-components/material-components-ios/pull/10045

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/10045 from andrewoverton:replace-mio-api-docs-with-github-links 0d6e56cc11d0c147366a4f6cde829d8b51567ecc
PiperOrigin-RevId: 323424362
2020-07-27 13:09:23 -07:00
..

Header stack view

The header stack view component is a view that coordinates the layout of two vertically stacked bar views.

Header Stack View

Design & API Documentation


Installation

Installation with CocoaPods

To add this component to your Xcode project using CocoaPods, add the following to your Podfile:

pod 'MaterialComponents/HeaderStackView'

Then, run the following command:

pod install

Overview

This view's sole purpose is to facilitate the relative layout of two horizontal bars. The bottom bar will bottom align and be of fixed height. The top bar will stretch to fill the remaining space if there is any.

The top bar is typically a navigation bar. The bottom bar, when provided, is typically a tab bar.


Usage

Importing

Before using header stack view, you'll need to import it:

Swift

import MaterialComponents.MaterialHeaderStackView

Objective-C

#import "MaterialHeaderStackView.h"

Header stack view provides MDCHeaderStackView, which is a UIView subclass.

Swift

let headerStackView = MDCHeaderStackView()

Objective-C

MDCHeaderStackView *headerStackView = [[MDCHeaderStackView alloc] init];

You may provide a top bar:

Swift

headerStackView.topBar = navigationBar

Objective-C

headerStackView.topBar = navigationBar;

You may provide a bottom bar:

Swift

headerStackView.bottomBar = tabBar

Objective-C

headerStackView.bottomBar = tabBar;