[local_auth] Add Android theme compatibility documentation (#6875)

Add documentation to README.md file from local_auth package: - Compatibility of Android theme for Android 8 and below.
flutter · Feb 21, 2023 · 34a6813 · 34a6813
1 parent 132d9c7
commit 34a6813
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 2 deletions.
diff --git a/packages/local_auth/local_auth/CHANGELOG.md b/packages/local_auth/local_auth/CHANGELOG.md
@@ -1,6 +1,7 @@
-## NEXT
+## 2.1.4
 
 * Updates minimum Flutter version to 3.0.
+* Updates documentation for Android version 8 and below theme compatibility.
 
 ## 2.1.3
 

diff --git a/packages/local_auth/local_auth/README.md b/packages/local_auth/local_auth/README.md
@@ -252,6 +252,42 @@ types (such as face scanning) and you want to support SDKs lower than Q,
 _do not_ call `getAvailableBiometrics`. Simply call `authenticate` with `biometricOnly: true`.
 This will return an error if there was no hardware available.
 
+#### Android theme
+
+Your `LaunchTheme`'s parent must be a valid `Theme.AppCompat` theme to prevent
+crashes on Android 8 and below. For example, use `Theme.AppCompat.DayNight` to
+enable light/dark modes for the biometric dialog. To do that go to
+`android/app/src/main/res/values/styles.xml` and look for the style with name
+`LaunchTheme`. Then change the parent for that style as follows:
+
+```xml
+...
+<resources>
+  <style name="LaunchTheme" parent="Theme.AppCompat.DayNight">
+    ...
+  </style>
+  ...
+</resources>
+...
+```
+
+If you don't have a `styles.xml` file for your Android project you can set up
+the Android theme directly in `android/app/src/main/AndroidManifest.xml`:
+
+```xml
+...
+	<application
+		...
+		<activity
+			...
+			android:theme="@style/Theme.AppCompat.DayNight"
+			...	
+		>
+		</activity>
+	</application>
+...
+```
+
 ## Sticky Auth
 
 You can set the `stickyAuth` option on the plugin to true so that plugin does not

diff --git a/packages/local_auth/local_auth/pubspec.yaml b/packages/local_auth/local_auth/pubspec.yaml
@@ -3,7 +3,7 @@ description: Flutter plugin for Android and iOS devices to allow local
   authentication via fingerprint, touch ID, face ID, passcode, pin, or pattern.
 repository: https://github.com/flutter/plugins/tree/main/packages/local_auth/local_auth
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+local_auth%22
-version: 2.1.3
+version: 2.1.4
 
 environment:
   sdk: ">=2.14.0 <3.0.0"