DEV/material-components_material-components-ios
1
0
Fork 0
mirror of https://github.com/material-components/material-components-ios.git synced 2026-02-20 08:27:32 +08:00
Code Issues Packages Projects Releases Wiki Activity
8,949 Commits 96 Branches 378 Tags
Commit Graph

45 Commits

Author SHA1 Message Date
Andrew Overton
07c46757cc Replace material.io API doc links with links to the relevant header f… 
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 https://github.com/material-components/material-components-ios/pull/10045

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/10045 from andrewoverton:replace-mio-api-docs-with-github-links 0d6e56cc11d0c147366a4f6cde829d8b51567ecc
PiperOrigin-RevId: 323424362
 2020-07-27 13:09:23 -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
Andrew Overton
512d6a0049 Replace TextControls documentation 
This PR primarily replaces the TextControls README with a different README. It also makes the TextControls README the source of the default TextField docs on material.io.

Preview the changes at: https://github.com/andrewoverton/material-components-ios/tree/material-io-text-field/components/TextControls

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

PiperOrigin-RevId: 306473798
 2020-04-14 11:05:09 -07:00
Andrew Overton
f9a72c3df8 [Buttons] Fix a lot of formatting issues with material.io and some broken links 
TL;DR -  This PR consists of fixes for broken links, broken image links, and broken Swift/Objective-C code snippets on material.io, and also adds some small copy edits.

Sometimes our documentation renders okay on GitHub, but breaks in the conversion of markdown to HTML/CSS that takes place during material.io deploys. As of yesterday, I'm able to build material.io locally, which allows me _validate_ the documentation changes I will keep making for the material.io work. It also allows me to catch broken links elsewhere, in totally unrelated files. For example, there were broken links in some Shapes documentation that were already blocking the deployment of our docs unbeknownst to us.

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

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/9963 from andrewoverton:fix-formatting-issues cd54e90863274a49068e016547b1bf0b1af3afcb
PiperOrigin-RevId: 305770167
 2020-04-09 15:16:14 -07:00
Andrew Overton
8c27dcf2e5 Fix broken link in Buttons docs 
PiperOrigin-RevId: 305561023
 2020-04-08 15:00:07 -07:00
Andrew Overton
40a62dc328 Update images again because they weren't using secondary theming before 
The FABs anatomy assets changed, this time to use secondary theming. This PR updates them in the iOS docs.

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

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/9960 from andrewoverton:update-fab-anatomy-images-again a54d18f76bb0e4175f513808bc0ae3e2cf0abc35
PiperOrigin-RevId: 305064142
 2020-04-06 10:42:55 -07:00
Andrew Overton
7fa3ffc105 [Buttons] Add new fab anatomy pngs 
This PR adds some new FAB anatomy PNGs.

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

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/9959 from andrewoverton:update-fab-anatomy-pngs 5964c875e65d84ddbc63f7ac0401dd609a2bde4d
PiperOrigin-RevId: 305013702
 2020-04-06 06:21:04 -07:00
Andrew Overton
12bc8b628a [Buttons] Fix broken links in README 
This PR fixes broken links in the FABs README.

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

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/9957 from andrewoverton:fix-broken-links de01f5647fcc9c8cf93857e61b54e708a693f0c9
PiperOrigin-RevId: 303951023
 2020-03-31 06:22:02 -07:00
Andrew Overton
91595a819a [Buttons] Replace Buttons documentation 
This PR replaces the existing Buttons documentation with different Buttons documentation.

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

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/9952 from andrewoverton:buttons-docs 4f0b6761428a5efbb8676f71d49e5f8ed21b996b
PiperOrigin-RevId: 303727221
 2020-03-30 06:28:59 -07:00
Jeff Verkoeyen
d11159f59c Internal change. 
PiperOrigin-RevId: 303172030
 2020-03-26 12:56:17 -07:00
Bryan Oltman
14c9d903cf
[Buttons] Deletes deprecated MDCFloatingButtonShapeThemer (#9746) 
* [Buttons] Deletes deprecated MDCFloatingButtonShapeThemer

* Remove MDCFloatingButtonShapeThemer from tests

* Update docs

* clang
 2020-02-18 10:12:36 -05:00
Bryan Oltman
1118f14124
[Buttons] Delete deprecated MDCOutlinedButtonThemer (#9688) 
MDCOutlinedButtonThemer is deprecated and has no internal usage.

Fixes #9687
 2020-02-11 18:20:18 -05:00
featherless
172cf73a40
[Buttons] Fix theming headers and copy. (#7236) 
Fixed the headers throughout the content.

Adjusted the "typical use" copy to call out that MDCButtons should be initialized with alloc/init.

Follow-up to https://github.com/material-components/material-components-ios/issues/6592
 2019-04-22 21:32:44 +03:00
featherless
0c175b46a3
[Buttons] Copy-edit the documentation. (#7206) 
This change annotates the button Themer documentation as "to be deleted" and edits the copy for conciseness.

Closes https://github.com/material-components/material-components-ios/issues/6592
 2019-04-22 18:56:32 +03:00
Cody Weaver
59541affa2
[Buttons] Fix broken link (#7198) 
The link within the buttons theming extension documentation was broken, this resulted in a 404 error. The doc link was off by 1 directory, this changes updates the link to go up one level.
 2019-04-22 07:59:47 -04:00
featherless
8a8ddc94d7
[Buttons] Copy-edits on the theming documentation for clarity. (#7192) 
Specifically:

- Removed a fair amount of duplicated text.
- Link to other articles where applicable.

Part of https://github.com/material-components/material-components-ios/issues/6592
 2019-04-20 00:12:47 +03:00
Robert Moore
af00416ce3 [Buttons] Remove broken link. (#6518) 
Fix the website job by removing a broken link.
 2019-01-29 16:13:25 -05:00
Cody Weaver
2248b33aeb [Buttons] Update theming docs for theming extensions (#6467) 
## Related links
* Related bug: #5772 
* Blocking PR: #6460 

## Introduction
The team has decided to pivot to theming extensions instead of _Themer_ objects. As we pivot we need to document how these new extensions work, for clients to use them.  This adds documentation for buttons with the new theming extensions.

_Note_ This is blocked by #6460 until that is resolved and merged then some of these links will not work.

## The problem
We don't have documentation on theming extensions for buttons.

## The fix
Add theming extension documentation for clients to see how we intend for them to use our new theming extensions within the button component.

## Remaining work
- [x] Add documentation for container scheme
- [ ] README updates for Buttons using Material Theming Extensions
- [x] README updates for Dialogs using Material Theming Extensions
 2019-01-29 15:22:11 -05: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
Robert Moore
74a27253e8
Global replace of integral single-precision literals with integer literals. (#5709) 
Global replace of integral single-precision literals with integer literals.

Regular expression used:
```perl
/[^\w]([0-9]+)\.[0]*[fF]/$1/
```
 2018-11-08 14:02:04 -05:00
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