refactor: add treeshake annotation for Browser category

vueuse · antfu · Jul 28, 2025 · Jul 22, 2025 · Jul 22, 2025 · Jul 23, 2025
commit d34b92951ec69cd2831a5bdc2bcd482c4f14c850
diff --git a/packages/core/useBluetooth/index.ts b/packages/core/useBluetooth/index.ts
@@ -43,6 +43,7 @@ export interface UseBluetoothOptions extends UseBluetoothRequestDeviceOptions, C
   acceptAllDevices?: boolean
 }
 
+/* #__NO_SIDE_EFFECTS__ */
 export function useBluetooth(options?: UseBluetoothOptions): UseBluetoothReturn {
   let {
     acceptAllDevices = false,

diff --git a/packages/core/useBrowserLocation/index.ts b/packages/core/useBrowserLocation/index.ts
@@ -38,6 +38,7 @@ export interface BrowserLocationState {
  *
  * @see https://vueuse.org/useBrowserLocation
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function useBrowserLocation(options: ConfigurableWindow = {}) {
   const { window = defaultWindow } = options
   const refs = Object.fromEntries(

diff --git a/packages/core/useEyeDropper/index.ts b/packages/core/useEyeDropper/index.ts
@@ -29,6 +29,7 @@ export interface UseEyeDropperOptions {
  *
  * @see https://vueuse.org/useEyeDropper
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function useEyeDropper(options: UseEyeDropperOptions = {}) {
   const { initialValue = '' } = options
   const isSupported = useSupported(() => typeof window !== 'undefined' && 'EyeDropper' in window)

diff --git a/packages/core/useGamepad/index.ts b/packages/core/useGamepad/index.ts
@@ -59,6 +59,7 @@ export function mapGamepadToXbox360Controller(gamepad: Ref<Gamepad | undefined>)
   })
 }
 
+/* #__NO_SIDE_EFFECTS__ */
 export function useGamepad(options: UseGamepadOptions = {}) {
   const {
     navigator = defaultNavigator,

diff --git a/packages/core/useMemory/index.ts b/packages/core/useMemory/index.ts
@@ -39,6 +39,7 @@ type PerformanceMemory = Performance & {
  * @see https://vueuse.org/useMemory
  * @param options
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function useMemory(options: UseMemoryOptions = {}) {
   const memory = deepRef<MemoryInfo>()
   const isSupported = useSupported(() => typeof performance !== 'undefined' && 'memory' in performance)

diff --git a/packages/core/usePermission/index.ts b/packages/core/usePermission/index.ts
@@ -57,6 +57,7 @@ export function usePermission(
   permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor['name'],
   options: UsePermissionOptions<true>,
 ): UsePermissionReturnWithControls
+/* #__NO_SIDE_EFFECTS__ */
 export function usePermission(
   permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor['name'],
   options: UsePermissionOptions<boolean> = {},

diff --git a/packages/core/usePreferredColorScheme/index.ts b/packages/core/usePreferredColorScheme/index.ts
@@ -10,6 +10,7 @@ export type ColorSchemeType = 'dark' | 'light' | 'no-preference'
  * @see https://vueuse.org/usePreferredColorScheme
  * @param [options]
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function usePreferredColorScheme(options?: ConfigurableWindow) {
   const isLight = useMediaQuery('(prefers-color-scheme: light)', options)
   const isDark = useMediaQuery('(prefers-color-scheme: dark)', options)

diff --git a/packages/core/usePreferredContrast/index.ts b/packages/core/usePreferredContrast/index.ts
@@ -10,6 +10,7 @@ export type ContrastType = 'more' | 'less' | 'custom' | 'no-preference'
  * @see https://vueuse.org/usePreferredContrast
  * @param [options]
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function usePreferredContrast(options?: ConfigurableWindow) {
   const isMore = useMediaQuery('(prefers-contrast: more)', options)
   const isLess = useMediaQuery('(prefers-contrast: less)', options)

diff --git a/packages/core/usePreferredDark/index.ts b/packages/core/usePreferredDark/index.ts
@@ -7,6 +7,7 @@ import { useMediaQuery } from '../useMediaQuery'
  * @see https://vueuse.org/usePreferredDark
  * @param [options]
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function usePreferredDark(options?: ConfigurableWindow) {
   return useMediaQuery('(prefers-color-scheme: dark)', options)
 }
diff --git a/packages/core/usePreferredLanguages/index.ts b/packages/core/usePreferredLanguages/index.ts
@@ -10,6 +10,7 @@ import { useEventListener } from '../useEventListener'
  * @see https://vueuse.org/usePreferredLanguages
  * @param options
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function usePreferredLanguages(options: ConfigurableWindow = {}): Ref<readonly string[]> {
   const { window = defaultWindow } = options
   if (!window)

diff --git a/packages/core/usePreferredReducedMotion/index.ts b/packages/core/usePreferredReducedMotion/index.ts
@@ -10,6 +10,7 @@ export type ReducedMotionType = 'reduce' | 'no-preference'
  * @see https://vueuse.org/usePreferredReducedMotion
  * @param [options]
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function usePreferredReducedMotion(options?: ConfigurableWindow) {
   const isReduced = useMediaQuery('(prefers-reduced-motion: reduce)', options)
 

diff --git a/packages/core/usePreferredReducedTransparency/index.ts b/packages/core/usePreferredReducedTransparency/index.ts
@@ -10,6 +10,7 @@ export type ReducedTransparencyType = 'reduce' | 'no-preference'
  * @see https://vueuse.org/usePreferredReducedTransparency
  * @param [options]
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function usePreferredReducedTransparency(options?: ConfigurableWindow) {
   const isReduced = useMediaQuery('(prefers-reduced-transparency: reduce)', options)
 

diff --git a/packages/core/useSSRWidth/index.ts b/packages/core/useSSRWidth/index.ts
@@ -4,6 +4,7 @@ import { hasInjectionContext } from 'vue'
 
 const ssrWidthSymbol = Symbol('vueuse-ssr-width') as InjectionKey<number | null>
 
+/* #__NO_SIDE_EFFECTS__ */
 export function useSSRWidth() {
   // Avoid injection warning outside of components
   const ssrWidth = hasInjectionContext() ? injectLocal(ssrWidthSymbol, null) : null

diff --git a/packages/core/useScreenOrientation/index.ts b/packages/core/useScreenOrientation/index.ts
@@ -23,6 +23,7 @@ export interface ScreenOrientation extends EventTarget {
  *
  * @see https://vueuse.org/useScreenOrientation
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function useScreenOrientation(options: ConfigurableWindow = {}) {
   const {
     window = defaultWindow,

diff --git a/packages/core/useTextDirection/index.ts b/packages/core/useTextDirection/index.ts
@@ -34,6 +34,7 @@ export interface UseTextDirectionOptions extends ConfigurableDocument {
  *
  * @see https://vueuse.org/useTextDirection
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function useTextDirection(options: UseTextDirectionOptions = {}) {
   const {
     document = defaultDocument,

diff --git a/packages/core/useWakeLock/index.ts b/packages/core/useWakeLock/index.ts
@@ -26,6 +26,7 @@ export type UseWakeLockOptions = ConfigurableNavigator & ConfigurableDocument
  * @see https://vueuse.org/useWakeLock
  * @param options
  */
+/* #__NO_SIDE_EFFECTS__ */
 export function useWakeLock(options: UseWakeLockOptions = {}) {
   const {
     navigator = defaultNavigator,
-Original file line number
+Diff line change
@@ Expand Up @@
       })
     }
+    /* #__NO_SIDE_EFFECTS__ */
     export function useGamepad(options: UseGamepadOptions = {}) {
       const {
         navigator = defaultNavigator,
@@ Expand Down @@