[Tabs] Update README for MDCTabBarView. (#7673)

Adds a small section about MDCTabBarView so it can be updated over time as changes are made. Closes #7672
material-components · Jun 21, 2019 · 2dea42f · 2dea42f
1 parent d0f3843
commit 2dea42f
Show file tree

Hide file tree

Showing 3 changed files with 106 additions and 0 deletions.
diff --git a/components/Tabs/README.md b/components/Tabs/README.md
@@ -59,6 +59,10 @@ Tabs are bars of buttons used to navigate between groups of content.
   - [Color Theming](#color-theming)
   - [Typography Theming](#typography-theming)
   - [Theming Extensions](#theming-extensions)
+- [MDCTabBarView](#mdctabbarview)
+  - [Importing MDCTabBarView](#importing-mdctabbarview)
+  - [Typical Use of MDCTabBarView](#typical-use-of-mdctabbarview)
+  - [Migrating from MDCTabBar](#migrating-from-mdctabbar)
 
 - - -
 
@@ -333,3 +337,55 @@ MDCContainerScheme *containerScheme = [[MDCContainerScheme alloc] init];
 
 <!--</div>-->
 
+
+## MDCTabBarView
+
+<!-- Extracted from docs/tabbarview.md -->
+
+> **_NOTE:_** This is currently in Beta. Features may change without warning and without a change in the Material 
+> Components for iOS version number.
+
+### Importing MDCTabBarView
+
+`MDCTabBarView` is currently part of the MaterialComponentsBeta podspec. You may need to follow the [Material Components for iOS
+Beta integration guide](https://github.com/material-components/material-components-ios/blob/develop/contributing/beta_components.md) to configure
+your project to use `MDCTabBarView`.
+
+<!--<div class="material-code-render" markdown="1">-->
+#### Swift
+```swift
+import MaterialComponentsBeta.MaterialTabs_TabBarView
+```
+
+#### Objective-C
+
+```objc
+#import "MaterialTabs+TabBarView.h"
+```
+<!--</div>-->
+
+### Typical Use of MDCTabBarView
+
+<!--<div class="material-code-render" markdown="1">-->
+#### Swift
+```swift
+let tabBarView = MDCTabBarView()
+addSubview(tabBarView)
+
+// Configure constraints
+```
+
+#### Objective-C
+
+```objc
+MDCTabBarView *tabBarView = [[MDCTabBarView alloc] init];
+[self.view addSubview:tabBarView];
+
+// Configure constraints
+```
+<!--</div>-->
+
+### Migrating from MDCTabBar
+
+> **_NOTE:_** This will be updated as APIs are added and migrations are defined.
+
diff --git a/components/Tabs/docs/README.md b/components/Tabs/docs/README.md
@@ -42,3 +42,7 @@ Tabs can also show a badge (usually a number) like UITabBar.
 - [Typography Theming](typography-theming.md)
 
 - [Theming Extensions](theming-extensions.md)
+
+## MDCTabBarView
+
+- [MDCTabBarView](tabbarview.md)
diff --git a/components/Tabs/docs/tabbarview.md b/components/Tabs/docs/tabbarview.md
@@ -0,0 +1,46 @@
+> **_NOTE:_** This is currently in Beta. Features may change without warning and without a change in the Material 
+> Components for iOS version number.
+
+### Importing MDCTabBarView
+
+`MDCTabBarView` is currently part of the MaterialComponentsBeta podspec. You may need to follow the [Material Components for iOS
+Beta integration guide](https://github.com/material-components/material-components-ios/blob/develop/contributing/beta_components.md) to configure
+your project to use `MDCTabBarView`.
+
+<!--<div class="material-code-render" markdown="1">-->
+#### Swift
+```swift
+import MaterialComponentsBeta.MaterialTabs_TabBarView
+```
+
+#### Objective-C
+
+```objc
+#import "MaterialTabs+TabBarView.h"
+```
+<!--</div>-->
+
+### Typical Use of MDCTabBarView
+
+<!--<div class="material-code-render" markdown="1">-->
+#### Swift
+```swift
+let tabBarView = MDCTabBarView()
+addSubview(tabBarView)
+
+// Configure constraints
+```
+
+#### Objective-C
+
+```objc
+MDCTabBarView *tabBarView = [[MDCTabBarView alloc] init];
+[self.view addSubview:tabBarView];
+
+// Configure constraints
+```
+<!--</div>-->
+
+### Migrating from MDCTabBar
+
+> **_NOTE:_** This will be updated as APIs are added and migrations are defined.