Added new property IASKWebViewHideBottomBar to hide the tab bar when pushed

funnel20 · funnel20 · commit 307e40c2ace7 · 2024-09-28T09:22:15.000+02:00
Added an example to all *.plists. See: #504
diff --git a/InAppSettingsKitSampleApp/Settings.bundle/Root.inApp.plist b/InAppSettingsKitSampleApp/Settings.bundle/Root.inApp.plist
@@ -308,6 +308,24 @@
 			<key>IASKChildTitle</key>
 			<string></string>
 		</dict>
+		<dict>
+			<key>File</key>
+			<string>settings_about.html</string>
+			<key>IASKViewControllerClass</key>
+			<string>IASKAppSettingsWebViewController</string>
+			<key>IASKViewControllerSelector</key>
+			<string>initWithFile:specifier:</string>
+			<key>Title</key>
+			<string>WebView without tab bar (when pushed)</string>
+			<key>IASKSubtitle</key>
+			<string>use IASKWebViewHideBottomBar</string>
+			<key>Type</key>
+			<string>PSChildPaneSpecifier</string>
+			<key>IASKChildTitle</key>
+			<string>ABOUT_TITLE</string>
+			<key>IASKWebViewHideBottomBar</key>
+			<true/>
+		</dict>
 		<dict>
 			<key>File</key>
 			<string>https://github.com/futuretap/InAppSettingsKit</string>
diff --git a/InAppSettingsKitSampleApp/Settings.bundle/Root~ipad.inApp.plist b/InAppSettingsKitSampleApp/Settings.bundle/Root~ipad.inApp.plist
@@ -320,6 +320,24 @@
 			<key>IASKChildTitle</key>
 			<string>ABOUT_TITLE</string>
 		</dict>
+		<dict>
+			<key>File</key>
+			<string>settings_about.html</string>
+			<key>IASKViewControllerClass</key>
+			<string>IASKAppSettingsWebViewController</string>
+			<key>IASKViewControllerSelector</key>
+			<string>initWithFile:specifier:</string>
+			<key>Title</key>
+			<string>WebView without tab bar (when pushed)</string>
+			<key>IASKSubtitle</key>
+			<string>use IASKWebViewHideBottomBar</string>
+			<key>Type</key>
+			<string>PSChildPaneSpecifier</string>
+			<key>IASKChildTitle</key>
+			<string>ABOUT_TITLE</string>
+			<key>IASKWebViewHideBottomBar</key>
+			<true/>
+		</dict>
 		<dict>
 			<key>File</key>
 			<string>https://github.com/futuretap/InAppSettingsKit</string>
diff --git a/InAppSettingsKitSampleApp/Settings.bundle/Root~iphone.inApp.plist b/InAppSettingsKitSampleApp/Settings.bundle/Root~iphone.inApp.plist
@@ -320,6 +320,24 @@
 			<key>IASKChildTitle</key>
 			<string>ABOUT_TITLE</string>
 		</dict>
+		<dict>
+			<key>File</key>
+			<string>settings_about.html</string>
+			<key>IASKViewControllerClass</key>
+			<string>IASKAppSettingsWebViewController</string>
+			<key>IASKViewControllerSelector</key>
+			<string>initWithFile:specifier:</string>
+			<key>Title</key>
+			<string>WebView without tab bar (when pushed)</string>
+			<key>IASKSubtitle</key>
+			<string>use IASKWebViewHideBottomBar</string>
+			<key>Type</key>
+			<string>PSChildPaneSpecifier</string>
+			<key>IASKChildTitle</key>
+			<string>ABOUT_TITLE</string>
+			<key>IASKWebViewHideBottomBar</key>
+			<true/>
+		</dict>
 		<dict>
 			<key>File</key>
 			<string>https://github.com/futuretap/InAppSettingsKit</string>
diff --git a/Sources/InAppSettingsKit/Controllers/IASKAppSettingsWebViewController.m b/Sources/InAppSettingsKit/Controllers/IASKAppSettingsWebViewController.m
@@ -24,6 +24,7 @@ @interface IASKAppSettingsWebViewController()
 @property (nonatomic, strong, readwrite) UIProgressView *progressView;
 @property (nonatomic, strong, readwrite) NSURL *url;
 @property (nonatomic, readwrite) BOOL showProgress;
+@property (nonatomic, readwrite) BOOL hideBottomBar;
 @end
 
 @implementation IASKAppSettingsWebViewController
@@ -45,6 +46,7 @@ - (id)initWithFile:(NSString*)urlString specifier:(IASKSpecifier*)specifier {
         self.customTitle = [specifier localizedObjectForKey:kIASKChildTitle];
         self.title = self.customTitle ? : specifier.title;
         self.showProgress = [[specifier.specifierDict objectForKey:kIASKWebViewShowProgress] boolValue];
+        self.hideBottomBar = [[specifier.specifierDict objectForKey:kIASKWebViewHideBottomBar] boolValue];
 	}
 	return self;
 }
@@ -112,6 +114,11 @@ - (void)loadView {
                           options:NSKeyValueObservingOptionNew
                           context:nil];
     }
+    
+    if (self.hideBottomBar) {
+        // Hide the tab bar when this view is pushed:
+        self.hidesBottomBarWhenPushed = YES;
+    }
 }
 
 - (void)viewWillAppear:(BOOL)animated {
diff --git a/Sources/InAppSettingsKit/include/IASKSettingsReader.h b/Sources/InAppSettingsKit/include/IASKSettingsReader.h
@@ -152,6 +152,12 @@ NS_ASSUME_NONNULL_BEGIN
  */
 #define kIASKWebViewShowProgress              @"IASKWebViewShowProgress"
 
+/*
+ IASKWebViewHideBottomBar can be set if IASKViewControllerClass is set to IASKAppSettingsWebViewController.
+ If IASKWebViewHideBottomBar is set, it will hide the toolbar at the bottom of the screen when the IASKAppSettingsWebViewController is pushed on to a navigation controller. This will present the WKWebView full screen and prevents situations where the user can navigate the tab bar while the IASKAppSettingsWebViewController stays still present.
+ */
+#define kIASKWebViewHideBottomBar             @"IASKWebViewHideBottomBar"
+
 extern NSString * const IASKSettingChangedNotification;
 #define kIASKAppSettingChanged                IASKSettingChangedNotification
 
diff --git a/Tests/InAppSettingsKitTests/Settings.bundle/Root.inApp.plist b/Tests/InAppSettingsKitTests/Settings.bundle/Root.inApp.plist
@@ -292,6 +292,24 @@
 			<key>Type</key>
 			<string>PSChildPaneSpecifier</string>
 		</dict>
+		<dict>
+			<key>File</key>
+			<string>settings_about.html</string>
+			<key>IASKViewControllerClass</key>
+			<string>IASKAppSettingsWebViewController</string>
+			<key>IASKViewControllerSelector</key>
+			<string>initWithFile:specifier:</string>
+			<key>Title</key>
+			<string>WebView without tab bar (when pushed)</string>
+			<key>IASKSubtitle</key>
+			<string>use IASKWebViewHideBottomBar</string>
+			<key>Type</key>
+			<string>PSChildPaneSpecifier</string>
+			<key>IASKChildTitle</key>
+			<string>ABOUT_TITLE</string>
+			<key>IASKWebViewHideBottomBar</key>
+			<true/>
+		</dict>
 		<dict>
 			<key>File</key>
 			<string>https://github.com/futuretap/InAppSettingsKit</string>
diff --git a/Tests/InAppSettingsKitTests/Settings.bundle/Root~ipad.inApp.plist b/Tests/InAppSettingsKitTests/Settings.bundle/Root~ipad.inApp.plist
@@ -314,6 +314,24 @@
 			<key>IASKChildTitle</key>
 			<string>ABOUT_TITLE</string>
 		</dict>
+		<dict>
+			<key>File</key>
+			<string>settings_about.html</string>
+			<key>IASKViewControllerClass</key>
+			<string>IASKAppSettingsWebViewController</string>
+			<key>IASKViewControllerSelector</key>
+			<string>initWithFile:specifier:</string>
+			<key>Title</key>
+			<string>WebView without tab bar (when pushed)</string>
+			<key>IASKSubtitle</key>
+			<string>use IASKWebViewHideBottomBar</string>
+			<key>Type</key>
+			<string>PSChildPaneSpecifier</string>
+			<key>IASKChildTitle</key>
+			<string>ABOUT_TITLE</string>
+			<key>IASKWebViewHideBottomBar</key>
+			<true/>
+		</dict>
 		<dict>
 			<key>File</key>
 			<string>https://github.com/futuretap/InAppSettingsKit</string>
diff --git a/Tests/InAppSettingsKitTests/Settings.bundle/Root~iphone.inApp.plist b/Tests/InAppSettingsKitTests/Settings.bundle/Root~iphone.inApp.plist
@@ -314,6 +314,24 @@
 			<key>IASKChildTitle</key>
 			<string>ABOUT_TITLE</string>
 		</dict>
+		<dict>
+			<key>File</key>
+			<string>settings_about.html</string>
+			<key>IASKViewControllerClass</key>
+			<string>IASKAppSettingsWebViewController</string>
+			<key>IASKViewControllerSelector</key>
+			<string>initWithFile:specifier:</string>
+			<key>Title</key>
+			<string>WebView without tab bar (when pushed)</string>
+			<key>IASKSubtitle</key>
+			<string>use IASKWebViewHideBottomBar</string>
+			<key>Type</key>
+			<string>PSChildPaneSpecifier</string>
+			<key>IASKChildTitle</key>
+			<string>ABOUT_TITLE</string>
+			<key>IASKWebViewHideBottomBar</key>
+			<true/>
+		</dict>
 		<dict>
 			<key>File</key>
 			<string>https://github.com/futuretap/InAppSettingsKit</string>

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ @interface IASKAppSettingsWebViewController()`
`24`	`24`	`@property (nonatomic, strong, readwrite) UIProgressView *progressView;`
`25`	`25`	`@property (nonatomic, strong, readwrite) NSURL *url;`
`26`	`26`	`@property (nonatomic, readwrite) BOOL showProgress;`
	`27`	`+@property (nonatomic, readwrite) BOOL hideBottomBar;`
`27`	`28`	`@end`
`28`	`29`
`29`	`30`	`@implementation IASKAppSettingsWebViewController`
`@@ -45,6 +46,7 @@ - (id)initWithFile:(NSString)urlString specifier:(IASKSpecifier)specifier {`
`45`	`46`	`self.customTitle = [specifier localizedObjectForKey:kIASKChildTitle];`
`46`	`47`	`self.title = self.customTitle ? : specifier.title;`
`47`	`48`	`self.showProgress = [[specifier.specifierDict objectForKey:kIASKWebViewShowProgress] boolValue];`
	`49`	`+ self.hideBottomBar = [[specifier.specifierDict objectForKey:kIASKWebViewHideBottomBar] boolValue];`
`48`	`50`	`}`
`49`	`51`	`return self;`
`50`	`52`	`}`
`@@ -112,6 +114,11 @@ - (void)loadView {`
`112`	`114`	`options:NSKeyValueObservingOptionNew`
`113`	`115`	`context:nil];`
`114`	`116`	`}`
	`117`	`+`
	`118`	`+ if (self.hideBottomBar) {`
	`119`	`+ // Hide the tab bar when this view is pushed:`
	`120`	`+ self.hidesBottomBarWhenPushed = YES;`
	`121`	`+ }`
`115`	`122`	`}`
`116`	`123`
`117`	`124`	`- (void)viewWillAppear:(BOOL)animated {`