32 Commits

Author SHA1 Message Date
Nobody
39911e5e75 [Material-iOS/FeatureHighlight, Material-iOS/FlexibleHeader, Material-iOS/HeaderStackView, Material-iOS/PageControl, Material-iOS/ShadowElevation] Fix broken images in iOS/Supporting APIs dev docs
PiperOrigin-RevId: 368295102
2021-04-13 14:30:45 -07:00
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
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
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
4272dc0074 Reorder image assets. 2018-05-04 12:49:34 -04:00
featherless
a078a9722d
Standardize the casing for all components to match spec. (#3693) 2018-05-03 15:02:36 -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
de2bd52da6
[FeatureHighlight] Remove theming preambles and regenerate root readme. (#3635) 2018-05-01 22:20:27 -04:00
featherless
c1fc4e728b
[FeatureHighlight] Split the documentation into separate articles and run the readme generator. (#3620) 2018-05-01 16:44:30 -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
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
Sam Morrison
b30161df41 [Feature Highlight] Updated screenshot (#1385)
* Update feature highlight screenshot

* Remove feature highlight video
2017-05-05 16:57:50 -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
Justin Shephard
7a19483569 [ReadMes] - First image of each component is too big (#1110)
* MDC_#917 - Activity Indicator Readme Update

* MDC_#917 - Updated remaining readme image links

* MDC_#917 - Fixed typo
2016-12-27 14:16:55 -05: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
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
Adrian Secord
850faf828b Fix .png and .mp4 file names to match scripts/check_components (#946)
* Fixed FeatureHighlight screenshot.

* Fixed NavigationBar.

* Fixed ShadowLayer.

* Fixed SpritedAnimationView.
2016-12-05 12:22:20 -05:00
Louis Romero
e7198c41e3 Fix the hero video appearance in GitHub. (#916)
* Comment image

* Handle site vs GitHub distinction. Also updates the alt texts to match the component.
2016-12-01 12:52:26 -05:00
Will Larche
5ca7c0bcf8 [Readme] Removing dead link in components. 2016-11-30 13:32:06 -05:00
Sam Morrison
59d092d5f9 Add Feature Highlight demo video and still (#899) 2016-11-29 16:47:55 -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
d4806473e4 MDCFeatureHighlightViewController implementation (#765)
* API Review for Feature Highlight component

Summary:
This is the proposed API for the Feature Highlight component.

For more info see the following links:
Design spec: https://material.googleplex.com/growth-communications/feature-discovery.html#feature-discovery-design
Tracking bug: b/30695049

Example usage
```
MDCFeatureHighlightViewController *vc = [[MDCFeatureHighlightViewController alloc] init];
vc.delegate = self;
vc.hintTitleText = @"...";
vc.hintBodyText = @"...";
[vc highlightView:_button];
[self presentViewController:vc animated:animated completion:completion];
```
In the delegate:
```
- (void)featureHighlightWasAccepted:(MDCFeatureHighlightViewController *)highlight {
  // do accepted things here
  [self dismissViewControllerAnimated:YES completion:nil];
}
- (void)featureHighlightWasIgnored:(MDCFeatureHighlightViewController *)highlight {
  // do ignored things here
  [self dismissViewControllerAnimated:YES completion:nil];
}
```

Reviewers: ajsecord, featherless, iangordon, O1 Material components iOS, randallli

Reviewed By: ajsecord, featherless, iangordon

Subscribers: randallli, iangordon, featherless, ajsecord

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1465

* Add MDCFeatureHighlightViewController

* Add Feature Highlight typical use

* Get Feature Highlight buildable

* Copy functionality over from prototype

* Accept/Reject highlight with animation

* Rotation

* Tap anywhere in the feature highlight typical use case demo to move the button

* Align highlight center and highlight point

* Layout text correctly

* Use sample text

* Use animated transitioning delegate for presentation and dismissal animations

* Clean up presentation + dismissal animation code

* Move intructional text behind button

* Limit width of text in feature highlight

* Layout text relative to center when noncentered

* Fix rotation

* First pass at feature highlight color example

* Properly map the inner and outer colors to the view

* Use correct license header

* Automatically choose text color based on outer highlight color

* Clean up color usage

* wrap long lines

* Clean up title positioning

* Clean up radius calculation

* Constize values

* Add feature highlight nav bar example

* Move examples up a directory

* Remove nav bar example

* Improve outer highlight color docs and implementation

* Add TODO: Mask the labels during the presentation and dismissal animations.

* Clean up feature highlight view

* Clean up feature highlight examples

* Layout feature highlight labels with support for RTL

* Code review improvements

* Clean up feature highlight samples

* Feature Highlight readme

* Update Podfile.lock for Feature Highlight

* Feature highlight readme improvements
2016-10-28 10:44:31 -04:00