Function: useValaxyDark() ​

Source: 1.1.0 · e3417e89b638

ts
function useValaxyDark(options?): object;

Defined in: packages/valaxy/client/composables/dark.ts:5

Parameters ​

options? ​

circleTransition? ​

boolean

Enable circle transition when toggling dark mode Then use toggleDarkWithTransition instead of toggleDark

themeColor? ​

{ dark?: string; light?: string; }

themeColor.dark? ​

string

themeColor.light? ​

string

useDarkOptions? ​

UseDarkOptions

Options for useDark disableTransition default is true

See

https://vueuse.org/core/useDark

Url

https://paco.me/writing/disable-theme-transitions

Returns ​

isDark ​

ts
isDark: UseDarkReturn;

Dark mode state, sync with app store

You can also use const appStore = useAppStore(); appStore.isDark to get the value

themeColor ​

ts
themeColor: ComputedRef<string>;

toggleDark ​

ts
toggleDark: (value?) => boolean;

Parameters ​

value? ​

boolean

Returns ​

boolean

toggleDarkWithTransition ​

ts
toggleDarkWithTransition: (event, options) => void;

Parameters ​

event ​

MouseEvent

options? ​
duration? ​

number

easing? ​

string

Returns ​

void