summaryrefslogtreecommitdiff
path: root/core/java
diff options
context:
space:
mode:
authorLucas Dupin <dupin@google.com>2022-01-06 17:52:22 -0800
committerLucas Dupin <dupin@google.com>2022-01-09 15:37:36 -0800
commit1af47a659c745c459727d2e995350215527fa527 (patch)
tree6faea4eb8dd18757a742fc5d0327d94581167848 /core/java
parenta94b16603637bce77b92c77265cf4283879731a3 (diff)
Customization settings documentation
Updated settings documentation to reflect current behavior. Bug: 195969565 Test: N/A Change-Id: I76eda9d12b251abbe3f5014f29e8bf0fc6bc6793
Diffstat (limited to 'core/java')
-rw-r--r--core/java/android/provider/Settings.java23
1 files changed, 23 insertions, 0 deletions
diff --git a/core/java/android/provider/Settings.java b/core/java/android/provider/Settings.java
index 55ffdab9d094..ac58755dc77f 100644
--- a/core/java/android/provider/Settings.java
+++ b/core/java/android/provider/Settings.java
@@ -10111,6 +10111,29 @@ public final class Settings {
* category, formatted as a serialized {@link org.json.JSONObject}. If there is no
* corresponding package included for a category, then all overlay packages in that
* category must be disabled.
+ *
+ * A few category keys have special meaning and are used for Material You theming.
+ *
+ * A {@code FabricatedOverlay} containing Material You tonal palettes will be generated
+ * in case {@code android.theme.customization.system_palette} contains a
+ * {@link android.annotation.ColorInt}.
+ *
+ * The strategy used for generating the tonal palettes can be defined with the
+ * {@code android.theme.customization.theme_style} key, with one of the following options:
+ * <ul>
+ * <li> TONAL_SPOT = Default Material You theme since Android S.</li>
+ * <li> VIBRANT = Theme where accent 2 and 3 are analogous to accent 1.</li>
+ * <li> EXPRESSIVE = Highly chromatic theme.</li>
+ * <li> SPRITZ = Desaturated theme, almost greyscale.</li>
+ * </ul>
+ *
+ * Example of valid fabricated theme specification:
+ * <pre>
+ * {
+ * "android.theme.customization.system_palette":"B1611C",
+ * "android.theme.customization.theme_style":"EXPRESSIVE"
+ * }
+ * </pre>
* @hide
*/
@SystemApi