25 Commits

Author SHA1 Message Date
Yarden Eitan
d7f566994a
[Docs] Adds the shape themer API to the supporting components using the doc generation (#5464)
This PR adds the shape theming API documentation using the doc generation script improvements that were added in PR #5463 .

To achieve this, I added into the .vars files of the supported components the missing variables, and ran the script `scripts/apply_all_templates`. Then I ran `scripts/generate_readme component` for the components that have been added the `shape-theming.md` file, so it is seen in the actual README.md of the component.

Specifically, Bottom Sheet was using the old method of documentation, and wasn't using the right generation method, so it's doc content was just copied to the right location to allow its generation to work well as well.

Closes #5319
2018-10-19 17:05:50 -04:00
Louis Romero
30138a9082 Fix a typo around text vs contained button (#5367) 2018-10-10 18:13:14 +03:00
Randall Li
3d665a45b8
Removed internal links from docs. (#4559) 2018-07-17 10:35:56 -04:00
Cody Weaver
4e7db26ccb Fix button README (#4547)
Remove the duplicate heading for the accessibility section of the README and remove the {a11y} tag.
Closes #4545
2018-07-13 13:55:18 -04:00
Cody Weaver
88dabcfac9 [Buttons] Make accessibility docs match other components (#4501)
[Buttons] Make accessibility docs match other components
2018-07-11 16:45:16 -04:00
Randall Li
25b0ed9ea2
[Buttons] Updated accessibility documentation and examples (#4418)
Made copyedit improvements to the accessibility documentation.
Applied those instructions to the button examples.

Fixes: https://github.com/material-components/material-components-ios/issues/3874 and https://github.com/material-components/material-components-ios/issues/3873
2018-06-21 11:13:00 -04:00
Randall Li
1d692a8ab2 [Buttons] Added a11y minimum touch target size to Accessibility section in readme. (#4386)
* Added a11y minimum touch target size to Accessibility section in readme.
Catalog: added minimum size a11y to button example.

* Update README.md

* nit changes
2018-06-15 10:58:28 -04:00
Randall Li
5ec8aa0980
[Buttons] Adding Accessibility labels to README and fab example. (#4330)
https://github.com/material-components/material-components-ios/issues/3874
2018-06-01 10:08:58 -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
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
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
0666763935
[Buttons] Add outlined button gif. (#3639) 2018-05-01 23:41:37 -04:00
featherless
5ec3e78a50
[Buttons] Break the docs into separate articles and run the readme generator. (#3605) 2018-05-01 16:21:45 -04:00
John Detloff
045e93e669
Add documentation describing variants to buttons, chips and cards (#3600)
https://www.pivotaltracker.com/story/show/157164168
2018-05-01 16:15:12 -04:00
featherless
c061444df2
[Buttons] Add floating action button documentation. (#3592)
This change also updates the button gifs to match the catalog style.

Pivotal story: https://www.pivotaltracker.com/story/show/157199233
2018-04-30 16:02:12 -04:00
featherless
1766e1790f
[Buttons] Copy-edit pass of the readme. (#3587)
- Removes outdated documentation.
- Adds animations of text and contained buttons.
- Structures the documentation around "typical usage" and "customization".
- Theming is now documented as the most typical use.

Pivotal story: https://www.pivotaltracker.com/story/show/157119329
Closes https://github.com/material-components/material-components-ios/issues/3586
2018-04-30 13:42:57 -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
Randall Li
d7cf7999ed [Buttons, Page Control, Typography] Removed video demos (#1387)
* removed link to videos

* deleted videos
2017-05-05 16:58:17 -04:00
Randall Li
d48a3dae3e [Buttons, Page Control, Typography] Fixed screenshots (#1380)
* Fixed screenshots

* fixed readme.md files for 375 width images instead of 320
2017-05-05 16:37:19 -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
Jason Striegel
58279ee77d [Buttons] screen grab demo.
Trying to create a reasonable screengrab in the simulator.
This uses Quicktime and a tool called Mousescape to hack the
cursor into a circle in OS X.
2016-04-07 18:37:58 -04:00
Jason Striegel
1269fbfb4d [Buttons] Layout design updates for buttons demo.
Summary:
  - added labels
  - two column alignment

Screenshot:
http://codereview.cc/D503

Reviewers: junius, ajsecord, #mdc_ios_owners

Reviewed By: junius, ajsecord, #mdc_ios_owners

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D503
2016-04-07 12:50:54 -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
Jason Striegel
222acfb503 New formatting for Buttons documentation. 2016-03-21 12:10:19 -04:00