{"id":16590541,"url":"https://github.com/pheuter/mfwalkthrough","last_synced_at":"2025-03-23T14:31:08.577Z","repository":{"id":15123421,"uuid":"17850423","full_name":"pheuter/MFWalkthrough","owner":"pheuter","description":"A container view controller for iOS that manages conditional navigation between view controllers","archived":false,"fork":false,"pushed_at":"2014-03-22T23:29:00.000Z","size":252,"stargazers_count":35,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T21:07:41.822Z","etag":null,"topics":["delegate-methods","ios","objective-c","transition"],"latest_commit_sha":null,"homepage":"http://pheuter.github.io/MFWalkthrough/","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pheuter.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-03-18T01:58:55.000Z","updated_at":"2021-04-20T15:10:37.000Z","dependencies_parsed_at":"2022-09-10T19:22:23.747Z","dependency_job_id":null,"html_url":"https://github.com/pheuter/MFWalkthrough","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheuter%2FMFWalkthrough","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheuter%2FMFWalkthrough/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheuter%2FMFWalkthrough/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheuter%2FMFWalkthrough/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pheuter","download_url":"https://codeload.github.com/pheuter/MFWalkthrough/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245115724,"owners_count":20563218,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["delegate-methods","ios","objective-c","transition"],"created_at":"2024-10-11T23:13:24.653Z","updated_at":"2025-03-23T14:31:08.070Z","avatar_url":"https://github.com/pheuter.png","language":"Objective-C","readme":"# MFWalkthrough\n\n[![Build Status](https://travis-ci.org/pheuter/MFWalkthrough.svg?branch=master)](https://travis-ci.org/pheuter/MFWalkthrough)\n[![Version](http://cocoapod-badges.herokuapp.com/v/MFWalkthrough/badge.png)](http://cocoadocs.org/docsets/MFWalkthrough)\n\n## Blog post\n\n[MFWalkthrough: A Container View Controller for iOS](http://blog.markfayngersh.com/mfwalkthrough-container-view-controller-for-ios)\n\n## Installation\n\nMFWalkthrough is available through [CocoaPods](http://cocoapods.org), to install\nit simply add the following line to your Podfile:\n\n    pod \"MFWalkthrough\", \"~\u003e 0.0.2\"\n\n## Demo\n\nYou can find the sample project in **Example/WalkthroughDemo**.\n\n![Demo](https://dl.dropboxusercontent.com/u/1803181/MFWalkthroughDemo.gif)\n\n## Usage\n\n### Display walkthrough containing 3 view controllers\n\n- `MFWalkthroughDataSource` - Used to determine what property to observe to enable transitions\n- `MFWalkthroughDelegate` - React to various transitions and states\n\n```objective-c\n#import \u003cMFWalkthrough/MFWalkthroughViewController.h\u003e\n\n@interface ViewController : UIViewController \u003cMFWalkthroughDataSource, MFWalkthroughDelegate\u003e\n```\n\nIn the implementation,\n\n```objective-c\n// Initialize your view controllers\nUIViewController *firstController;\nUIViewController *secondController;\nUIViewController *lastController;\n\n// Create the MFWalkthroughViewController instance\nMFWalkthroughViewController *walkthroughController =\n      [[MFWalkthroughViewController alloc]\n          initWithViewControllers:@[ firstController, secondController, lastController ]];\n\n// Present the walkthrough controller\n[self.navigationController pushViewController:walkthroughController\n                                       animated:YES];\n```\n\nRequired data source method:\n\n```objective-c\n- (NSString *)walkthroughViewController:(MFWalkthroughViewController *)walkthroughViewController enableContinuePropertyForViewController:(UIViewController *)viewController {\n  return @\"somePropertyThatDeterminesIfContinueIsEnabled\";\n}\n```\n\nRequired delegate methods:\n\n```objective-c\n- (void)walkthroughViewController:(MFWalkthroughViewController *)walkthroughViewController willGoBackFromFirstViewController:(UIViewController *)firstViewController {\n  NSLog(@\"I'm at the very beginning!\");\n}\n\n- (void)walkthroughViewController:(MFWalkthroughViewController *)walkthroughViewController willContinueFromLastViewController:(UIViewController *)lastViewController {\n  NSLog(@\"I'm at the very end!\");\n}\n```\n\nThe following delegate methods are optional:\n\n- `- (void)walkthroughViewController:couldNotContinueFromViewController:`\n- `- (void)walkthroughViewController:willContinueFromViewController:toViewController:`\n- `- (void)walkthroughViewController:willGoBackFromViewController:toViewController:`\n\nRefer to source documentation for more detail\n\n## Customization\n\nMFWalkthrough is designed to be used in conjunction with UINavigationController, simplifying conditional transitions between view controllers depending on some intermediate state.\n\n[FRDLivelyButton](https://github.com/sebastienwindal/FRDLivelyButton) is used to render the navigation buttons. You can customize the button colors and line widths via the following `MFWalkthroughViewController` properties:\n\n- `(UIColor *)navigationButtonColor` - Defaults to `navigationBar.tintColor`\n- `(CGFloat)navigationButtonLineWidth` - Defaults to `3.0f`\n\n## Testing\n\nTo run the unit tests:\n\n    $ cd Example\n    $ make install\n    $ make ci\n\n## Author\n\nMark Fayngersh, phunny.phacts@gmail.com\n\n## License\n\nMFWalkthrough is available under the MIT license. See the LICENSE file for more info.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpheuter%2Fmfwalkthrough","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpheuter%2Fmfwalkthrough","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpheuter%2Fmfwalkthrough/lists"}