Skip to content

Commit

Permalink
[Typography] Add deprecation notice to the MDCTypography APIs and REA…
Browse files Browse the repository at this point in the history
…DME (#3633)

This adds deprecation notices to the component's README.md and the individual APIs.

Pivotal story: https://www.pivotaltracker.com/story/show/157238605
  • Loading branch information
jverkoey committed May 2, 2018
1 parent ed19233 commit fa155e0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 10 deletions.
16 changes: 6 additions & 10 deletions components/Typography/README.md
@@ -1,15 +1,11 @@
<!--docs:
title: "Typography"
layout: detail
section: components
excerpt: "The Typography component provides methods for displaying text using the type sizes and opacities from the Material Design specifications."
iconId: typography
path: /catalog/typography/
api_doc_root: true
-->

# Typography

*Notice*: Much of this component, with exception of the UIFont and UIFontDescriptor APIs, will soon
be deprecated. Please consider using the [schemes/Typography](../schemes/Typography) component and
the [Material Theming](../../docs/theming) APIs instead.

---

<div class="article__asset article__asset--screenshot">
<img src="docs/assets/typography.png" alt="Typography" width="375">
</div>
Expand Down
11 changes: 11 additions & 0 deletions components/Typography/src/MDCTypography.h
Expand Up @@ -16,12 +16,17 @@

#import <UIKit/UIKit.h>

#pragma mark - Soon to be deprecated

/**
MDCTypography uses this protocol to delegate responsibility of loading the custom fonts.
The spec defines the Roboto font family and uses three fonts in the named styles. Use this
protocol to define your own fonts if there is a brand need.
@warning This protocol will soon be deprecated. Consider using MDCTypographyScheme from the
schemes/Typography component instead.
@see https://material.io/go/design-typography#typography-styles
*/
@protocol MDCTypographyFontLoading <NSObject>
Expand Down Expand Up @@ -71,6 +76,9 @@
To use these fonts, you must add MaterialTypography.bundle to your target.
@warning This class will soon be deprecated. Consider using MDCTypographyScheme from the
schemes/Typography component instead.
@see https://material.io/go/design-typography#typography-styles
*/
@interface MDCTypography : NSObject
Expand Down Expand Up @@ -177,6 +185,9 @@
/**
MDCSystemFontLoader allows you to use the system font for @c MDCTypography.
@warning This class will soon be deprecated. Consider using MDCTypographyScheme from the
schemes/Typography component instead.
#### Example
```
Expand Down

0 comments on commit fa155e0

Please sign in to comment.