Skip to content

Commit

Permalink
Replace material.io API doc links with links to the relevant header f…
Browse files Browse the repository at this point in the history
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 #10045

COPYBARA_INTEGRATE_REVIEW=#10045 from andrewoverton:replace-mio-api-docs-with-github-links 0d6e56c
PiperOrigin-RevId: 323424362
  • Loading branch information
andrewoverton authored and material-automation committed Jul 27, 2020
1 parent 8a509d5 commit 07c4675
Show file tree
Hide file tree
Showing 31 changed files with 119 additions and 470 deletions.
6 changes: 3 additions & 3 deletions components/ActionSheet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ the screen and displays actions a user can take.
## Design & API documentation

<ul class="icon-list">
<li class="icon-list-item icon-list-item--link">Class: <a href="https://material.io/components/ios/catalog/action-sheet/api-docs/Classes/MDCActionSheetAction.html">MDCActionSheetAction</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://material.io/components/ios/catalog/action-sheet/api-docs/Classes/MDCActionSheetController.html">MDCActionSheetController</a></li>
<li class="icon-list-item icon-list-item--link">Protocol: <a href="https://material.io/components/ios/catalog/action-sheet/api-docs/Protocols/MDCActionSheetControllerDelegate.html">MDCActionSheetControllerDelegate</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/ActionSheet/src/MDCActionSheetAction.h">MDCActionSheetAction</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/ActionSheet/src/MDCActionSheetController.h">MDCActionSheetController</a></li>
<li class="icon-list-item icon-list-item--link">Protocol: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/ActionSheet/src/MDCActionSheetControllerDelegate.h">MDCActionSheetControllerDelegate</a></li>
</ul>

## Table of contents
Expand Down
9 changes: 4 additions & 5 deletions components/ActivityIndicator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,10 @@ This component only provides the circular implementation. See

<ul class="icon-list">
<li class="icon-list-item icon-list-item--spec"><a href="https://material.io/go/design-progress-indicators">Material Design guidelines: Progress & activity</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://material.io/components/ios/catalog/progress-indicators/activity-indicators/api-docs/Classes/MDCActivityIndicator.html">MDCActivityIndicator</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://material.io/components/ios/catalog/progress-indicators/activity-indicators/api-docs/Classes/MDCActivityIndicatorTransition.html">MDCActivityIndicatorTransition</a></li>
<li class="icon-list-item icon-list-item--link">Protocol: <a href="https://material.io/components/ios/catalog/progress-indicators/activity-indicators/api-docs/Protocols/MDCActivityIndicatorDelegate.html">MDCActivityIndicatorDelegate</a></li>
<li class="icon-list-item icon-list-item--link">Enumeration: <a href="https://material.io/components/ios/catalog/progress-indicators/activity-indicators/api-docs/Enums.html">Enumerations</a></li>
<li class="icon-list-item icon-list-item--link">Enumeration: <a href="https://material.io/components/ios/catalog/progress-indicators/activity-indicators/api-docs/Enums/MDCActivityIndicatorMode.html">MDCActivityIndicatorMode</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/ActivityIndicator/src/MDCActivityIndicator.h">MDCActivityIndicator</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/ActivityIndicator/src/MDCActivityIndicator.h">MDCActivityIndicatorTransition</a></li>
<li class="icon-list-item icon-list-item--link">Protocol: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/ActivityIndicator/src/MDCActivityIndicatorDelegate.h">MDCActivityIndicatorDelegate</a></li>
<li class="icon-list-item icon-list-item--link">Enumeration: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/ActivityIndicator/src/MDCActivityIndicator.h">MDCActivityIndicatorMode</a></li>
</ul>

## Related components
Expand Down
2 changes: 1 addition & 1 deletion components/BottomAppBar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ api_doc_root: true

Bottom app bars group primary and secondary actions at the bottom of the screen, where they are easily reachable by the user's thumb.

Use the `UIView` subclass `MDCBottomAppBarView` to add a bottom app bar to your app. `MDCBottomAppBarView` contains a horizontally centered [floating action button](https://material.io/components/ios/catalog/buttons/api-docs/Classes/MDCFloatingButton.html) for primary actions and a customizable [navigation bar](https://material.io/components/ios/catalog/flexible-headers/navigation-bars/) for secondary actions. The `MDCBottomAppBarView` API includes properties that allow changes in elevation, position, and visibility of the embedded floating action button.
Use the `UIView` subclass `MDCBottomAppBarView` to add a bottom app bar to your app. `MDCBottomAppBarView` contains a horizontally centered [floating action button](https://github.com/material-components/material-components-ios/blob/stable/components/Buttons/src/MDCFloatingButton.h) for primary actions and a customizable [navigation bar](https://material.io/components/ios/catalog/flexible-headers/navigation-bars/) for secondary actions. The `MDCBottomAppBarView` API includes properties that allow changes in elevation, position, and visibility of the embedded floating action button.

Instances of `UIBarButtonItem` can be added to a `MDCBottomAppBarView`'s navigation bar. Leading and trailing navigation items will be shown and hidden based on the position of the floating action button.

Expand Down
1 change: 0 additions & 1 deletion components/BottomNavigation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,6 @@ bottomNavBar.frame = bottomNavBarFrame
API and source code:

* `MDCBottomNavigationBar`
* [Class reference](https://material.io/components/ios/catalog/bottomnavigation/api-docs/Classes/MDCBottomNavigationBar.html)
* [Class source](https://github.com/material-components/material-components-ios/blob/develop/components/BottomNavigation/src/MDCBottomNavigationBar.h)

To achieve something like the example image above, add the following code to your view controller:
Expand Down
3 changes: 1 addition & 2 deletions components/Buttons/docs/buttons.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ There are four types of buttons:
## Using buttons

All Material buttons are implemented by `MDCButton`, a subclass of [UIButton](https://developer.apple.com/documentation/uikit/uibutton).
* [API documentation](https://material.io/develop/ios/components/buttons/api-docs/Classes/MDCButton.html)
* [GitHub source](https://github.com/material-components/material-components-ios/blob/develop/components/Buttons/src/MDCButton.h)

### Install `MDCButton`
Expand Down Expand Up @@ -295,7 +294,7 @@ An outlined button has a text label, a container, and an optional icon.

### Contained button example

Contained buttons are implemented by [MDCButton](https://material.io/develop/ios/components/buttons/api-docs/Classes/MDCButton.html). To achieve a contained button use the contained button theming method on the MDCButton theming extension. To access the theming extension see the [Theming section](#theming).
Contained buttons are implemented by [MDCButton](https://github.com/material-components/material-components-ios/blob/stable/components/Buttons/src/MDCButton.h). To achieve a contained button use the contained button theming method on the MDCButton theming extension. To access the theming extension see the [Theming section](#theming).

<!--<div class="material-code-render" markdown="1">-->
#### Objective-C
Expand Down
3 changes: 1 addition & 2 deletions components/Buttons/docs/fabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ There are three types of FABs:

A FAB performs the primary, or most common, action on a screen. It appears in front of all screen content, typically as a circular shape with an icon in its center.

FABs are implemented by `MDCFloatingButton`, a subclass of [MDCButton](https://material.io/develop/ios/components/buttons/api-docs/Classes/MDCButton.html).
* [API documentation](https://material.io/develop/ios/components/buttons/api-docs/Classes/MDCFloatingButton.html)
FABs are implemented by `MDCFloatingButton`, a subclass of [MDCButton](https://github.com/material-components/material-components-ios/blob/stable/components/Buttons/src/MDCButton.h).
* [GitHub source](https://github.com/material-components/material-components-ios/blob/develop/components/Buttons/src/MDCFloatingButton.h)

Only use a FAB if it is the most suitable way to present a screen’s primary action.
Expand Down
2 changes: 0 additions & 2 deletions components/Cards/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,11 +193,9 @@ Cards can be used to build custom UIs, like the one shown above, from [CardWithI
MDCCard and MDCCardCollectionCell inherit from UIControl and UICollectionViewCell, respectively.
* MDCCard
* [API documentation](https://material.io/develop/ios/components/cards/api-docs/Classes/MDCCard.html)
* [GitHub source](https://github.com/material-components/material-components-ios/blob/develop/components/Cards/src/MDCCard.h)
* MDCCardCollectionCell
* [API documentation](https://material.io/develop/ios/components/cards/api-docs/Classes/MDCCardCollectionCell.html)
* [GitHub source](https://github.com/material-components/material-components-ios/blob/develop/components/Cards/src/MDCCardCollectionCell.h)
### Card examples using MDCCard
Expand Down
13 changes: 6 additions & 7 deletions components/Chips/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,12 @@ Chips are compact elements that represent an input, attribute, or action.

<ul class="icon-list">
<li class="icon-list-item icon-list-item--spec"><a href="https://material.io/go/design-chips">Material Design guidelines: Chips</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://material.io/components/ios/catalog/chips/api-docs/Classes.html#/c:objc(cs)MDCChipCollectionViewFlowLayout">MDCChipCollectionViewFlowLayout</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://material.io/components/ios/catalog/chips/api-docs/Classes/MDCChipCollectionViewCell.html">MDCChipCollectionViewCell</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://material.io/components/ios/catalog/chips/api-docs/Classes/MDCChipField.html">MDCChipField</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://material.io/components/ios/catalog/chips/api-docs/Classes/MDCChipView.html">MDCChipView</a></li>
<li class="icon-list-item icon-list-item--link">Protocol: <a href="https://material.io/components/ios/catalog/chips/api-docs/Protocols/MDCChipFieldDelegate.html">MDCChipFieldDelegate</a></li>
<li class="icon-list-item icon-list-item--link">Enumeration: <a href="https://material.io/components/ios/catalog/chips/api-docs/Enums.html">Enumerations</a></li>
<li class="icon-list-item icon-list-item--link">Enumeration: <a href="https://material.io/components/ios/catalog/chips/api-docs/Enums/MDCChipFieldDelimiter.html">MDCChipFieldDelimiter</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/Chips/src/MDCChipCollectionViewFlowLayout.h">MDCChipCollectionViewFlowLayout</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/Chips/src/MDCChipCollectionViewCell.h">MDCChipCollectionViewCell</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/Chips/src/MDCChipField.h">MDCChipField</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/Chips/src/MDCChipView.h">MDCChipView</a></li>
<li class="icon-list-item icon-list-item--link">Protocol: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/Chips/src/MDCChipFieldDelegate.h">MDCChipFieldDelegate</a></li>
<li class="icon-list-item icon-list-item--link">Enumeration: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/Chips/src/MDCChipField.h">MDCChipFieldDelimiter</a></li>
</ul>

## Table of contents
Expand Down
4 changes: 2 additions & 2 deletions components/CollectionCells/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Collection view cell classes that adhere to Material Design layout and styling.

<ul class="icon-list">
<li class="icon-list-item icon-list-item--spec"><a href="https://material.io/go/design-lists#lists-specs">Material Design guidelines: Collection List Specs</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://material.io/components/ios/catalog/collections/collection-cells/api-docs/Classes/MDCCollectionViewCell.html">API: MDCCollectionViewCell</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://material.io/components/ios/catalog/collections/collection-cells/api-docs/Classes/MDCCollectionViewTextCell.html">API: MDCCollectionViewTextCell</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://github.com/material-components/material-components-ios/blob/develop/components/CollectionCells/src/MDCCollectionViewCell.h">API: MDCCollectionViewCell</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://github.com/material-components/material-components-ios/blob/develop/components/CollectionCells/src/MDCCollectionViewTextCell.h">API: MDCCollectionViewTextCell</a></li>
</ul>

- - -
Expand Down
2 changes: 1 addition & 1 deletion components/CollectionLayoutAttributes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Allows passing layout attributes to the cells and supplementary views.
## Design & API Documentation

<ul class="icon-list">
<li class="icon-list-item icon-list-item--link"><a href="https://material.io/components/ios/catalog/collections/collection-layout-attributes/api-docs/Classes/MDCCollectionViewLayoutAttributes.html">API: MDCCollectionViewLayoutAttributes</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://github.com/material-components/material-components-ios/blob/develop/components/CollectionLayoutAttributes/src/MDCCollectionViewLayoutAttributes.h">API: MDCCollectionViewLayoutAttributes</a></li>
</ul>

- - -
Expand Down
10 changes: 5 additions & 5 deletions components/Collections/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ Collection view classes that adhere to Material Design layout and styling.

<ul class="icon-list">
<li class="icon-list-item icon-list-item--spec"><a href="https://material.io/go/design-lists#lists-specs">Material Design guidelines: Collection List Specs</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://material.io/components/ios/catalog/collections/api-docs/Classes/MDCCollectionViewController.html">API: MDCCollectionViewController</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://material.io/components/ios/catalog/collections/api-docs/Protocols/MDCCollectionViewEditing.html">API: MDCCollectionViewEditing</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://material.io/components/ios/catalog/collections/api-docs/Protocols/MDCCollectionViewEditingDelegate.html">API: MDCCollectionViewEditingDelegate</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://material.io/components/ios/catalog/collections/api-docs/Protocols/MDCCollectionViewStyling.html">API: MDCCollectionViewStyling</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://material.io/components/ios/catalog/collections/api-docs/Protocols/MDCCollectionViewStylingDelegate.html">API: MDCCollectionViewStylingDelegate</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://github.com/material-components/material-components-ios/blob/develop/components/Collections/src/MDCCollectionViewController.h">API: MDCCollectionViewController</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://github.com/material-components/material-components-ios/blob/develop/components/Collections/src/MDCCollectionViewEditing.h">API: MDCCollectionViewEditing</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://github.com/material-components/material-components-ios/blob/develop/components/Collections/src/MDCCollectionViewEditing.h">API: MDCCollectionViewEditingDelegate</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://github.com/material-components/material-components-ios/blob/develop/components/Collections/src/MDCCollectionViewStyling.h">API: MDCCollectionViewStyling</a></li>
<li class="icon-list-item icon-list-item--link"><a href="https://github.com/material-components/material-components-ios/blob/develop/components/Collections/src/MDCCollectionViewStylingDelegate.h">API: MDCCollectionViewStylingDelegate</a></li>
</ul>

- - -
Expand Down
4 changes: 2 additions & 2 deletions components/FeatureHighlight/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ The Feature Highlight component is a way to visually highlight a part of the scr
## Design & API documentation

<ul class="icon-list">
<li class="icon-list-item icon-list-item--link">Class: <a href="https://material.io/components/ios/catalog/feature-highlights/api-docs/Classes/MDCFeatureHighlightView.html">MDCFeatureHighlightView</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://material.io/components/ios/catalog/feature-highlights/api-docs/Classes/MDCFeatureHighlightViewController.html">MDCFeatureHighlightViewController</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/FeatureHighlight/src/MDCFeatureHighlightView.h">MDCFeatureHighlightView</a></li>
<li class="icon-list-item icon-list-item--link">Class: <a href="https://github.com/material-components/material-components-ios/blob/develop/components/FeatureHighlight/src/MDCFeatureHighlightViewController.h">MDCFeatureHighlightViewController</a></li>
</ul>

## Table of contents
Expand Down
Loading

0 comments on commit 07c4675

Please sign in to comment.