Skip to main content

Interface: UseAndroidDynamicColorInstance

Defined in: hooks/use-android-dynamic-color/UseAndroidDynamicColorInstance.ts:5

Returns Android Dynamic Color based on user's wallpaper and style.

If you instantiate the class with undefined dark option or get the instantiated class with AndroidDynamicColor.dynamic static method, the module will returns color scheme based on user's theme setting.

If you are using Expo, the userInterfaceStyle (from expo-system-ui) configuration, or other frameworks configuration is ignored, because the theme (dark or light) detection is using Android native API

Extends

Properties

colorScheme

readonly colorScheme: ColorScheme

Defined in: modules/android-dynamic-color/AndroidDynamicColor.ts:73

Inherited from

UseAndroidDynamicColorInstance.colorScheme


errorPalette

readonly errorPalette: DynamicColorPalette

Defined in: modules/android-dynamic-color/_DynamicColorPalettesDelegate.ts:18

Inherited from

AndroidDynamicColor.errorPalette


neutralPalette

readonly neutralPalette: DynamicColorPalette

Defined in: modules/android-dynamic-color/_DynamicColorPalettesDelegate.ts:19

Inherited from

AndroidDynamicColor.neutralPalette


neutralVariantPalette

readonly neutralVariantPalette: DynamicColorPalette

Defined in: modules/android-dynamic-color/_DynamicColorPalettesDelegate.ts:20

Inherited from

AndroidDynamicColor.neutralVariantPalette


primaryPalette

readonly primaryPalette: DynamicColorPalette

Defined in: modules/android-dynamic-color/_DynamicColorPalettesDelegate.ts:15

Inherited from

AndroidDynamicColor.primaryPalette


secondaryPalette

readonly secondaryPalette: DynamicColorPalette

Defined in: modules/android-dynamic-color/_DynamicColorPalettesDelegate.ts:16

Inherited from

AndroidDynamicColor.secondaryPalette


tertiaryPalette

readonly tertiaryPalette: DynamicColorPalette

Defined in: modules/android-dynamic-color/_DynamicColorPalettesDelegate.ts:17

Inherited from

AndroidDynamicColor.tertiaryPalette


theme

readonly theme: "light" | "dark"

Defined in: modules/android-dynamic-color/AndroidDynamicColor.ts:75

Inherited from

UseAndroidDynamicColorInstance.theme