28 Commits

Author SHA1 Message Date
Andrew Overton
b42de42c87 Additional requested docs changes
Closes https://github.com/material-components/material-components-ios/pull/10147

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/10147 from andrewoverton:material-io-bugs-2 d0e70d8a8c4b66e6d3b22c2fbe3408a60d8771ee
PiperOrigin-RevId: 348026588
2020-12-17 08:33:58 -08:00
Andrew Overton
8d8763ef71 [Multiple components] Audit recent docs changes, part 1
Closes https://github.com/material-components/material-components-ios/pull/10132

PiperOrigin-RevId: 345256835
2020-12-02 10:10:55 -08:00
Andrew Overton
b205164477 Delete obsolete markdown files
As I've gone through and replaced all the READMEs I haven't always been good at deleting the markdown files that were stitched together to make the old READMEs. This PR removes all the ones I forgot to remove. All the relevant material in these files is already in the new READMEs, so we're not losing anything by doing this.

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

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/10029 from andrewoverton:delete-unused-docs 65ea55253af300ea7a4c13ea4ce14976097a6253
PiperOrigin-RevId: 318079032
2020-06-24 09:31:01 -07:00
Andrew Overton
7814b0c460 Replace App Bar docs
This PR replaces the AppBar README. The content is mostly the same, I just had to restructure it in order to fit the new template.

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

PiperOrigin-RevId: 309097690
2020-04-29 14:32:52 -07:00
Cody Weaver
f46357b1fc
[Docs] Fix links within documenation (#7208)
This change fixes the broken links in MDCActionSheet and MDCAppBar components. This also moves the Themer documentation to an "unsupported" section.
2019-04-22 13:17:41 -04:00
Cody Weaver
adf4b7e31f
[AppBar] Update documentation around theming (#7197)
As part of our move to theming extensions away from themers we need to update our documentation as well. This change removes all mention of "beta" within the theming-extension.md file as this extension is soon to go to the ready podspec. This also updates the older themer docs with the annotation "(To Be Deprecated)" as these are soon to be deprecated then removed. This work is related to #7159.
2019-04-22 08:37:17 -04:00
Wenyu Zhang
3adbf4ed9a
Update AppBar theming extension docs. (#7125) 2019-04-11 17:08:54 -04:00
Robert Moore
b62e576b9c
[AppBar] Fix README code snippet (#6969)
The code snippet for Theming Extensions never terminated and caused
rendering issues when previewing the deployment to material.io.

Closes #6968
2019-03-21 20:17:51 -04:00
Robert Moore
61e6c07f6a
[AppBar] Add theming extension for MDCAppBarViewController (#6903)
Creates a Theming Extension for MDCAppBarViewController for both Primary and Surface variants.

Closes #6866
2019-03-14 21:15:01 -04:00
Robert Moore
372d6b24f9
No longer using -init for Color Scheme. (#5734)
{MDC iOS} No longer using `-init` for Color Scheme.

Based on the discussions in go/mdc-ios-theming, we should not use the `-init` default initializer. Instead, we should use an explicit set of defaults.

Search regex: '\[\[MDCSemanticColorScheme alloc\] init\]'
2018-11-12 12:54:47 -05:00
featherless
eebbe49e2f
[AppBar] Add frame setting recommendation to app bar view controller migration guide. (#5180)
Setting the view's frame is an important part of migrating from MDCAppBar to MDCAppBarViewController. Failure to do so can result in the app bar's width not matching the parent view's width.
2018-09-20 14:19:55 +03:00
featherless
7cfd859f19
[AppBar] Add deprecation schedule to the MDCAppBar migration guide. (#4802) 2018-08-15 09:46:10 -04:00
featherless
afca8fa6aa
[AppBar] Add MDCAppBar migration guide. (#4762) 2018-08-14 09:20:24 -04:00
featherless
4f181203ad
[AppBar] Complete pass at documentation modernization. (#4708)
This is a complete overhaul of the App Bar documentation, fully reflecting the most modern set of APIs that we encourage and expect clients to adopt.

As part of this work, I've also written up the documentation for the various behavioral flags.

Preview the App Bar docs: 007a738fa5/components/AppBar/README.md

Preview the Flexible Header docs: 007a738fa5/components/FlexibleHeader/README.md

Closes https://github.com/material-components/material-components-ios/issues/4653
2018-08-08 09:52:12 -04:00
Andrew Overton
0a0db27c91
Add docs on making navigationItems accessible with MDCAppBars (#4540) 2018-07-12 16:10:52 -04:00
featherless
e1e6d249a4
[Docs] Add badges to all components. (#4278)
As part of our readme generator, components can now opt in to displaying badges in their readme.

The badges are generated from https://shields.io/ and are focused on an individual component. We're currently generating the following badges:

- Open bug count.
2018-05-25 11:12:48 -04:00
featherless
c166652ae6
Update site naming for top and bottom app bars to match spec. (#3680) 2018-05-03 10:26:04 -04:00
featherless
8d7dda64e3
[AppBar] Add animated gif to the readme. (#3677) 2018-05-03 08:15:40 -04:00
featherless
da21941afa
Regenerate component docs with automatic API links. (#3673)
Example output:

<img width="468" alt="screen shot 2018-05-02 at 10 33 23 pm" src="https://user-images.githubusercontent.com/45670/39557914-d9512f38-4e58-11e8-824d-60f03bcd1b76.png">
2018-05-02 22:33:55 -04:00
featherless
a312ab1b30
[AppBar] Make the App Bar appear as "Top App Bar" in the docsite. (#3670) 2018-05-02 20:02:20 -04:00
featherless
037bf7d0f0
Flatten all +Extensions CocoaPods targets into standalone targets. (#3572)
This discourages depending on all of a component's extensions and aligns our targets more closely with how we expect them to be imported and depended upon.

This is a breaking change.

Pivotal story: https://www.pivotaltracker.com/story/show/157118721
2018-05-02 10:20:01 -04:00
featherless
1e80136d29
[AppBar] Split the documentation into separate articles and run the readme generator. (#3634) 2018-05-01 22:17:16 -04:00
Adrian Secord
7a7293883f
Remove space after triple-backtick Markdown syntax. (#3577) 2018-04-29 09:00:53 -04:00
featherless
d3c5316db0 Generate all themer documentation. (#3562)
* Generate all themer documentation.

* Fix Snackbar vars.

* Fix textfields vars.

* Fix link.

* Fix bottom app bar vars.

* Fix more vars.

* Add home page links.

* Fix typos.

* Fix more links.

* Add ink.

* Tabs.

* Cleanup.
2018-04-27 16:59:03 -04:00
Justin Shephard
4a879d3634 [AppBar] - Removed Video from Readme (#1390)
* [AppBar] - Update readme docs

* [AppBar] - Remove video

* [AppBar] - Removed video file and if clause
2017-05-05 17:23:23 -04:00
Justin Shephard
94ed673c2a [AppBar] - Update docs photo (#1374) 2017-05-05 16:16:36 -04:00
Adrian Secord
4b3b06d2ce [Website] Added hero videos to component README.md files.
Part of https://github.com/google/material-components-ios/issues/365.

Summary:
Part of https://github.com/google/material-components-ios/issues/365.

Added new files, removed old screenshots and videos.
Updated README.md references to videos/screenshots.

Reviewers: #mdc_ios_owners, junius

Reviewed By: #mdc_ios_owners, junius

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D835
2016-05-05 16:40:48 -04:00
Junius Gunaratne
03a480e591 Adding component screenshots from catalog for website
Reviewers: ajsecord, #mdc_ios_owners, jstriegel

Reviewed By: ajsecord, #mdc_ios_owners, jstriegel

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D406
2016-03-29 14:53:47 -04:00