52 Commits

Author SHA1 Message Date
Jeff Verkoeyen
474affb1a6 [Dialogs] Delete all examples and tests.
PiperOrigin-RevId: 611482673
2024-02-29 08:36:39 -08:00
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
fb4d874f62 [Multiple components] Change component README ToCs to bold paragraph style
PiperOrigin-RevId: 346365613
2020-12-08 11:09:33 -08:00
Andrew Overton
62ccb5c72f [Multiple components] Audit recent docs changes, part 2
Closes https://github.com/material-components/material-components-ios/pull/10135

PiperOrigin-RevId: 345473101
2020-12-03 09:54:14 -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
0c7a12b0c7 [Multiple components] Miscellaneous doc fixes
PiperOrigin-RevId: 345013092
2020-12-01 07:11:52 -08:00
Andrew Overton
9806cab151 [Dialogs] Modify dialogs docs
PiperOrigin-RevId: 318135341
2020-06-24 13:59:57 -07:00
Andrew Overton
226596fd7d [Dialogs] Improve Dialogs docs
Improve alt text and use string literals in Dialogs README examples.

PiperOrigin-RevId: 314943340
2020-06-05 09:44:03 -07:00
Andrew Overton
112ea0d089 [Dialogs] Add additional theming screenshot to Dialogs docs
This PR adds a screenshot of a themed Dialog to the Dialogs README.

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

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/9997 from andrewoverton:add-theming-screenshot 03da851b3a5bcd4f696ea9ab84fbc35c3abf2f59
PiperOrigin-RevId: 312322585
2020-05-19 11:53:17 -07:00
Nobody
70716800b8 Internal change
PiperOrigin-RevId: 312085611
2020-05-18 16:41:12 +00:00
Bryan Oltman
511da587d4
[Dialogs] Delete deprecated DialogThemer (#9776)
DialogThemer (`MDCAlertControllerThemer` and `MDCAlertScheme`) is deprecated and has no internal use.
2020-02-24 14:03:29 -05:00
Andrew Overton
eaf2489303
[Dialogs, TextFields] Update docs (#7209)
#7187 and #7184 graduated Buttons and TextFields theming extensions to ready, but didn't update the docs. Similarly, #7190, which has not yet been merged in, is not updating the docs to reflect the graduation of the Dialogs theming extension to ready.

This PR updates docs for Dialogs and TextFields theming extensions to reflect them being marked ready. Once #7190 is merged in the Dialogs changes here will be accurate.

I will address the out-of-date Buttons docs once #7206 is merged in.
2019-04-22 14:12:04 -04:00
featherless
c8f3973d4a
[scripts] Fix relative link rewriting. (#7205)
Context is in the associated issue.

This affects the perl expression that prepends `docs/` to local urls. Specifically, it makes the perl expression only modify urls that link to a sibling markdown file composed of `\w` characters (e.g. `theming.md`). This is not perfect, but it addresses our needs for now. If/when we encounter other types of local urls that we can address them separately.

For now, this change fixes the incorrect behavior described in the associated bug.

Closes https://github.com/material-components/material-components-ios/issues/7203
2019-04-22 15:45:10 +03:00
Galia Kaufman
9eebe7a2e6
[Dialogs] Theming dialog actions doc (#6547)
Documenting action emphasis in Alert Controllers
2019-02-04 11:13:18 -05:00
featherless
49c5913b62
[Dialogs] Fix broken link to beta documentation. (#6506)
Fixes the following error in the website job:

```
Error:
Broken link docs/../../contributing/beta_components.md in /Volumes/BuildData/tmpfs/src/github/repo/docsite-generator/.stage/ios/catalog/dialogs/index.md
```

The readme was regenerated by running `./scripts/generate_readme Dialogs`
2019-01-29 10:32:09 -05:00
Cody Weaver
3f77bf5118
[Dialogs] Update theming docs for theming extension (#6496)
## 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 dialogs 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 dialogs.
## 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
- [ ] README updates for Dialogs using Material Theming Extensions
2019-01-28 13:59:33 -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
Cody Weaver
95fbb31946
[Dialogs] Update README for new themer
Context
We recently added an API for a DialogThemer but we are yet to update the README.

The problem
We are missing docs for the new API

The fix
Update the readme to have the new themer API

Related issues
b/116306933
2018-10-03 15:13:15 -04:00
ianegordon
20445a5d85
[Dialogs] Update A11y docs (#4509) 2018-07-11 17:49:33 -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
Jeff Verkoeyen
d16824c765 [Dialogs] Update the copy and make a gif. 2018-05-04 09:47:06 -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
Adrian Secord
14b9c1503f
Global replace of "utilize" vs "use". (#3662) 2018-05-02 16:51:59 -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
ce9f1e0bbf
[Dialogs] Split the documentation into separate articles and run the readme generator. (#3619) 2018-05-01 16:38:06 -04:00
Adrian Secord
7a7293883f
Remove space after triple-backtick Markdown syntax. (#3577) 2018-04-29 09:00:53 -04:00
Adrian Secord
72045ffd6d
[Docs] Updated known short link destination URLs to use short links. (#3575)
* Updated known shortlink destination URLs to use short links.

* Updated stray links in the CHANGELOG.md.

* Fixed FAB shortlink.

* Applied replacements to everything outside of components/.
2018-04-28 11:27:59 -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
ianegordon
49de50edae Consolidate installation requirements in the main README (#2809) 2018-01-05 13:50:38 -05:00
Yarden Eitan
6df22d2cd6
Update MaterialComponents podspec to separate extensions from component. Breaking change, please see description when sending out a new release (#2748)
* [Catalog] Update catalog readme to reflect podspec filename change

* upate podspec

* update spec to extension

* more specific dependency

* added documentation
2018-01-02 16:51:58 -05:00
Scott Hyndman
eed028eacb [Docs] Adds API documentation roots and tidies up here and there. (#1425)
* [Docs] Marks component files as API documentation roots.

Used by the site generator to determine where to build API docs. I
marked everything built by the previous version.

* [Docs] Adds a prefix to all Material guidelines links.

* [Docs] Adds API doc links to some components.
2017-05-12 16:03:56 -04:00
Scott Hyndman
1571a1b9ee [Docs] Nests components in the navigation as spec'd. (#1404)
Also took the opportunity to remove an unneeded liquid style
application.
2017-05-09 11:49:44 -04:00
Scott Hyndman
1bec0a903a [Docs] Misc. cleanup (#1403)
* [Docs] Changes an icon list class name.

* [Docs] Adds annotations to all installation code snippets.

* [Docs] Fixes screenshot sizes in PageControl README.

* [Docs] Fixes a broken link on the homepage.

* [Docs] Adds a stable repository branch field to the site metadata.

Used to link to the GitHub source tree.

* [Docs] Specify platform in docs root title.
2017-05-08 18:05:05 -04:00
ianegordon
0489e474e9 [Dialogs] Screenshot (#1376)
* [Dialogs] Screenshot

* Width to 375

* Update README.md

Alt text s/App Bar/Dialogs/
2017-05-05 16:36:36 -04:00
Scott Hyndman
4a011e75a5 [Docs] Docstravaganza (#1330)
* [Docs] Adds platform configuration for the doc site.

* [Docs] Adds path metadata for documentation site.

This field is used to determine where the file will appear in the
doc site.

* [Docs] Updates Material guideline links to latest URL.

material.google.com -> material.io/guidelines

* [Docs] Introduces a separate component index for the docsite.

* [Docs] Changes the directory used for site generation.

* [Docs] Moves documentation-site-only Markdown into its own directory.

* [Docs] Changes material.io links to use https.

* [Docs] Renames the howto and contributing docsite sections to docs.

* [Docs] Adds a navTitle field to the collection editing/styling pages.

* [Docs] Changes the FAQ heading to be one size bigger.

* [Docs] Changes the tutorial title.

* [Docs] Adds icons to three more components.

* [Docs] Introduces a root component directory called /catalog/.

* [Docs] Adds an icon to the AnimationTiming component.

* [Docs] Adds an icon for the typography component.

* [Docs] Reformats the docsite index.
2017-05-01 17:27:38 -04:00
Will Larche
3f99ed2dd9 [All] replacing ~~~ with ```. (#1324) 2017-04-17 17:06:37 -04:00
Scott Hyndman
0913aa9aaf [Docs]: Updated link list classes. (#1320)
Link lists now use BEM notation across the board. It's more verbose, but is
aligned with the conventions of MDC-web and the docs site.
2017-04-13 17:25:23 -04:00
Scott Hyndman
69533578ca [docs] Associated icons with components (#1315)
* Adds icon IDs to most component READMEs.

The ones without icon IDs will default to a generic icon.

* Removes a space from front matter.
2017-04-12 18:22:08 -04:00
Scott Hyndman
9ed1d4349d Gigantic documentation update. (#1305)
There are more changes to come, but it's time we merged back.

Changes:
* Re-introduces the doc site scripts and files that had been deleted previously.
* Updates contributing docs to reflect doc structure changes.
* Applies common header structure across all component documentation.
* Fixes a bunch of liquid syntax bugs.
* Inlines Front Matter metadata in README.md files as HTML comments. Any file prefixed with

  <!--docs:
  ...yaml
  -->

  Will be converted into Front Matter when generating the site.
* .jekyll_prefix files, which previously stored the data, have been removed.
2017-04-05 10:53:34 -04:00
Will Larche
3c4e905598 [Readmes] Snippets in Swift 3 (#1039)
* [ActivityIndicator] Snippets in Swift 3

* [AnimationTiming] Snippets in Swift 3.

* [AppBar] Snippets in Swift 3 and corrections to snippets.

* [ButtonBar] Snippets in Swift 3 and corrections to snippets.

* [ButtonBar] Removing TODO.

* [Buttons] Snippets in Swift 3.

* [Collections] Snippets in Swift 3 and snippet corrections.

* [CollectionLayoutAttributes] Snippets in Swift 3.

* [Dialogs] Snippets in Swift 3 and snippets corrections.

* [FeatureHighlight] Snippets in Swift 3 and snippets corrections.

* [FeatureHighlight] Missing import specification.

* [FlexibleHeader] Snippets in Swift 3 and snippet corrections.

* [Dialogs] Corrections to snippets.

* [HeaderStackView] Adding import specifier.

* [Ink] Snippets in Swift 3 and snippets corrections.

* [NavigationBar] Snippets in Swift 3.

* [NavigationBar] Removing TODO.

* [OverlayWindow] Snippets in Swift 3 and snippets corrections.

* [PageControl] Snippets in Swift 3 and snippet corrections.

* [OverlayWindow] Snippets in Swift 3 and snippet corrections.

* [Palettes] Snippets in Swift 3 and snippet corrections..

* [ProgressView] Snippets in Swift 3 and snippet corrections.

* [Readmes] Snippet alignment corrections.
2016-12-13 17:17:57 -05:00
ianegordon
e648cf3610 Update README.md (#1028)
Rename modalDialogViewController to myDialogViewController.
Update documentation for clarity.
2016-12-13 14:52:43 -05:00
Adrian Secord
e93a16ca02 Capitalize "Material" in documentation (#1014)
* s/material design/Material Design/g

* s/material components/Material Components/g

* s/material\([ \t\n]\)/Material\1/g

* s/aterial design/aterial Design/g
2016-12-13 08:06:55 -05:00
Will Larche
1080e89422 [Documentation] Putting Swift snippets before Objc (#960)
* [ActivityIndicator] Swift first in README

* [AnimationTiming] Swift first in readme.

* [AppBar] Swift first in readme.

* [ButtonBar] Swift first in readme.

* [Buttons] Swift first in readme.

* [CollectionLayoutAttributes] Swift first in readme

* [Collections] Swift first in readme.

* [Dialogs] Swift first in readme.

* [FeatureHighlight] Swift first in readme.

* [FlexibleHeader] Swift first in readme.

* [FontDiskLoader] Swift first in readme.

* [HeaderStackView] Swift first in readme.

* [Ink] Swift first in readme.

* [NavigationBar] Swift first in readme.

* [OverlayWindow] Adding missing site comments. Swift first in readme.

* [PageControl] Swift first in readme.

* [Palettes] Swift first in readme.

* [ProgressView] Swift first in readme.

* [RobotoFontLoader] Swift first in readme.

* [ShadowElevations] Swift first in readme.

* [ShadowLayer] Swift first in readme.

* [Slider] Swift first in readme.

* [Snackbar] Swift first in readme.

* [SpritedAnimationView] Swift first in readme.

* [Switch] Swift first in readme.

* [Typography] Swift first in readme.

* [ShadowLayer] Reducing font size in readme.

* [Switch] Reducing font size in readme.
2016-12-07 10:31:34 -05:00
Will Larche
5ca7c0bcf8 [Readme] Removing dead link in components. 2016-11-30 13:32:06 -05:00
Adrian Secord
2997e50c4c Updated refs to GitHub repo with new location. (#885)
* Updated refs to GitHub repo with new location.

* Reverted chagnes to JSON files.
2016-11-22 14:32:50 -05:00
Sam Morrison
386964baf2 Improve snackbar and dialogs docs (#785)
Improve snackbar and dialogs docs
2016-10-20 12:51:07 -04:00
Ian Gordon
f1b983465f Documentation Updates
Reviewers: O1 Material components iOS!, willlarche

Reviewed By: willlarche

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1714
2016-10-17 12:14:33 -04:00
Justin Shephard
f53506ea28 Site_Readme_Links - Added Jekyll conditional with links to site/github documentation
Summary:
Merge branch 'develop' into Site_Readme_Links

Site_Readme_Links - Change of variable name

Site_Readme_Links - Spelling correction on FontDiskLoader

Reviewers: O1 Material components iOS, randallli

Reviewed By: O1 Material components iOS, randallli

Subscribers: randallli

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1507
2016-08-23 10:54:23 -04:00
Justin Shephard
685ea43198 MDC_#546 - Start of separation of README.md and yaml
Summary: Created separate README.md and README.yaml files to remove the odd display of the md in GitHub.

Reviewers: O1 Material components iOS, ajsecord

Reviewed By: O1 Material components iOS, ajsecord

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1496
2016-08-18 16:55:20 -04:00
Ian Gordon
1fe4ac3f64 [Dialogs] Add Alert Controller
Summary: This is the initial import of the material spec'd alert controller.

Reviewers: O1 Material components iOS, ajsecord

Reviewed By: O1 Material components iOS, ajsecord

Subscribers: ajsecord

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1258
2016-07-25 17:12:33 -04:00