diff --git a/components/AppBar/README.md b/components/AppBar/README.md index d95838cedb5..b6b0fd75f50 100644 --- a/components/AppBar/README.md +++ b/components/AppBar/README.md @@ -21,7 +21,6 @@ information and actions relating to the current screen. * [Using top app bars](#using-top-app-bars) * [Regular top app bar](#regular-top-app-bar) -* [Contextual action bar](#contextual-action-bar) * [Theming](#theming) * [Migration guides](#migration-guides) * [Unsupported](#unsupported) @@ -104,16 +103,10 @@ NSLog(@"accessibilityLabel: %@",self.navigationItem.rightBarButtonItem.accessibi ``` -## Types - -There are two types of top app bar: -1. [Regular top app bar](#regular-top-app-bar) -1. [Contextual action bar](#contextual-action-bar) - -![Regular top app bar and contextual action bars](docs/assets/appbar-types.png) - ## Regular top app bar +![Example of an iOS regular top app bar](docs/assets/app-bar-example.png) + Regular top app bars are the only top app bars supported on iOS. ### Top app bar examples @@ -641,10 +634,6 @@ See the [FlexibleHeader](../FlexibleHeader) documentation for additional usage g -------------------------------- | -------------------- | ------------------------------------------ | ------------- **Icons** | `-[UIViewController navigationItem]` | `-setLeftBarButtonItems:`
`-leftBarButtonItems`
`-setRightBarButtonItems:`
`-rightBarButtonItems` | `nil` -## Contextual action bar - -Contextual action bars are not implemented on iOS. - ## Theming `MDCAppBarViewController` supports Material Theming using a Container Scheme. To theme your app bar, add the `AppBar+Theming` subspec to your `Podfile`: diff --git a/components/AppBar/docs/assets/app-bar-example.png b/components/AppBar/docs/assets/app-bar-example.png new file mode 100644 index 00000000000..30b0040c9e9 Binary files /dev/null and b/components/AppBar/docs/assets/app-bar-example.png differ diff --git a/components/AppBar/docs/assets/appbar-types.png b/components/AppBar/docs/assets/appbar-types.png deleted file mode 100644 index e754eb3766a..00000000000 Binary files a/components/AppBar/docs/assets/appbar-types.png and /dev/null differ diff --git a/components/BottomAppBar/README.md b/components/BottomAppBar/README.md index 132ace98bf0..5d0aaf896f5 100644 --- a/components/BottomAppBar/README.md +++ b/components/BottomAppBar/README.md @@ -121,10 +121,6 @@ trailingButton.accessibilityHint = @"Purchase the item"; ``` -## Types - -There is only one type of bottom app bar. - ## Bottom app bar Bottom app bars group primary and secondary actions at the bottom of the screen, where they are easily reachable by the user's thumb. diff --git a/components/BottomNavigation/README.md b/components/BottomNavigation/README.md index 1e5a6d0965f..9f262f883e2 100644 --- a/components/BottomNavigation/README.md +++ b/components/BottomNavigation/README.md @@ -135,10 +135,6 @@ override func viewWillLayoutSubviews() { ``` -## Types - -There is only one type of bottom navigation bar. - ## Bottom navigation bar ![A bottom navigation item with home, mail, favorites, reader, and birthday sections](docs/assets/bottom-nav-example.png) diff --git a/components/Buttons/docs/buttons.md b/components/Buttons/docs/buttons.md index 8da511c0e77..7c65002393b 100644 --- a/components/Buttons/docs/buttons.md +++ b/components/Buttons/docs/buttons.md @@ -20,7 +20,6 @@ api_doc_root: true * [Text button](#text-button) * [Outlined button](#outlined-button) * [Contained button](#contained-button) -* [Toggle button](#toggle-button) * [Theming](#theming) - - - @@ -163,12 +162,7 @@ this day." ## Types -There are four types of buttons: - -1. [Text button](#text-button) -2. [Outlined button](#outlined-button) -3. [Contained button](#contained-button) -4. [Toggle button](#toggle-button) (*not supported in iOS*) +There are four types of buttons: 1. [Text button](#text-button) 2. [Outlined button](#outlined-button) 3. [Contained button](#contained-button) 4. Toggle button (*not supported in iOS*)" ![Example of the four button types](assets/buttons_types.png) @@ -344,10 +338,6 @@ A contained button has a text label, a container, and an optional icon. **Icon** | `imageView` | `setImage:forState:`
`imageForState:` | `nil` **Color** | `imageView.tintColor` | `setImageViewTintColor:forState:`
`imageViewTintColorForState:` | `nil` -## Toggle button - -[Toggle buttons](https://material.io/components/buttons/#toggle-button) can be used to select from a group of choices. They are not supported on iOS. - ## Theming You can theme an `MDCButton` to match any of the Material Button styles using theming diff --git a/components/Buttons/docs/fabs.md b/components/Buttons/docs/fabs.md index ac352590fd6..7829a0f8e2d 100644 --- a/components/Buttons/docs/fabs.md +++ b/components/Buttons/docs/fabs.md @@ -142,11 +142,7 @@ this day." ## Types -There are three types of FABs: - -1. [Regular FABs](#regular-fabs) -2. [Mini FABs](#mini-fabs) -3. [Extended FABs](#extended-fabs) +There are three types of FABs: 1\. [Regular FABs](#regular-fab) 2\. [Mini FABs](#mini-fab) 3\. [Extended FABs](#extended-fab) ![Three FABs, one of each type.](assets/fab-types.png) diff --git a/components/Cards/README.md b/components/Cards/README.md index e6239dd7d0d..bf65a612160 100644 --- a/components/Cards/README.md +++ b/components/Cards/README.md @@ -175,8 +175,6 @@ card.accessibilityLabel = [NSString ``` -## Types - ## Card ![Card with sample image and buttons](docs/assets/custom-card.png) @@ -299,7 +297,7 @@ _**Note:** All the optional elements of a card's content are implemented through **Elevation** | N/A | `-setShadowElevation:forState:`
`-shadowElevationForState:` | 1 **Ripple color** | `rippleView.rippleColor` | N/A | `nil` -### Theming +## Theming Cards supports Material Theming using a Container Scheme. `MDCCard` and `MDCCardCollectionCell` have both default and outlined theming methods. Learn more about theming extensions [here](../../docs/theming.md). Below is a screenshot of an `MDCCard` with the Material Design Shrine theme: diff --git a/components/Dialogs/README.md b/components/Dialogs/README.md index f2f6523fe10..229ea068ffb 100644 --- a/components/Dialogs/README.md +++ b/components/Dialogs/README.md @@ -86,20 +86,11 @@ the `-performAccessibilityEscape` method in your custom dialog view controller c } ``` -## Types - -There are four types of dialogs: - -1. [Alert](#alert-dialog) -1. Simple -1. Confirmation -1. Full-screen - -![Examples of the four types of dialogs.](docs/assets/dialogs-types.png) - ## Alert dialog -The alert style is the only style supported on iOS. Consider using the [ActionSheet](https://github.com/material-components/material-components-ios/blob/develop/components/ActionSheet/README.md) component in situations where one of the unsupported dialog types would have been appropriate. +![Example alert dialog with lorem ipsum sample text.](docs/assets/alert-example.png) + +Alerts are the only type of dialog supported on iOS. Consider using the [ActionSheet](https://github.com/material-components/material-components-ios/blob/develop/components/ActionSheet/README.md) component in situations where one of the unsupported dialog types would have been appropriate. To present either an `MDCAlertController` or a custom dialog view controller, set its `modalPresentationStyle` property to `UIModalPresentationCustom` and its `transitioningDelegate` property to an diff --git a/components/Dialogs/docs/assets/alert-example.png b/components/Dialogs/docs/assets/alert-example.png new file mode 100644 index 00000000000..b41ecefa4b7 Binary files /dev/null and b/components/Dialogs/docs/assets/alert-example.png differ