10 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
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
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