Skip to content

Commit 9008cd9

Browse files
committed
[docs] Remove 'unspecified' from Appearance.getColorScheme
1 parent 5023326 commit 9008cd9

2 files changed

Lines changed: 2 additions & 4 deletions

File tree

docs/appearance.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,15 @@ flowchart TD
8383
### `getColorScheme()`
8484

8585
```tsx
86-
static getColorScheme(): 'light' | 'dark' | 'unspecified' | null;
86+
static getColorScheme(): 'light' | 'dark' | null;
8787
```
8888

89-
Returns the active color scheme. The value may be updated later, either through direct user action (e.g. theme selection in device settings or application-level selected user interface style via `setColorScheme`) or on a schedule (e.g. light and dark themes that follow the day/night cycle).
89+
Returns the active color scheme. This value may change at runtime, either at the system level (e.g. scheduled color scheme change at sunrise or sunset) or when overridden at the app level via `setColorScheme()`.
9090

9191
Return values:
9292

9393
- `'light'`: The light color scheme is applied.
9494
- `'dark'`: The dark color scheme is applied.
95-
- `'unspecified'`: **_Never returned_** (incorrectly typed).
9695
- `null`: May be returned if the native Appearance module is not available.
9796

9897
See also: [`useColorScheme`](usecolorscheme) (hook).

docs/usecolorscheme.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ The `useColorScheme` React hook provides and subscribes to color scheme updates
1313

1414
- `'light'`: The light color scheme is applied.
1515
- `'dark'`: The dark color scheme is applied.
16-
- `'unspecified'`: **_Never returned_** (incorrectly typed).
1716
- `null`: May be returned if the native Appearance module is not available.
1817

1918
---

0 commit comments

Comments
 (0)