feat(vue): expand @robonen/vue composable collection

Composables, tests, category barrels, and README for @robonen/vue.

vue/toolkit/src/composables/elements/useDocumentVisibility/index.test.ts

@@ -0,0 +1,131 @@
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { effectScope, nextTick } from 'vue';
+import { useDocumentVisibility } from '.';
+
+afterEach(() => {
+  vi.unstubAllGlobals();
+  Object.defineProperty(document, 'visibilityState', { value: 'visible', configurable: true });
+});
+
+function setVisibility(state: DocumentVisibilityState) {
+  Object.defineProperty(document, 'visibilityState', { value: state, configurable: true });
+  document.dispatchEvent(new Event('visibilitychange'));
+}
+
+describe(useDocumentVisibility, () => {
+  it('reads the current visibility state', () => {
+    const scope = effectScope();
+    let visibility: ReturnType<typeof useDocumentVisibility>;
+    scope.run(() => {
+      visibility = useDocumentVisibility();
+    });
+
+    expect(visibility!.value).toBe('visible');
+    scope.stop();
+  });
+
+  it('updates on visibilitychange', async () => {
+    const scope = effectScope();
+    let visibility: ReturnType<typeof useDocumentVisibility>;
+    scope.run(() => {
+      visibility = useDocumentVisibility();
+    });
+
+    setVisibility('hidden');
+    await nextTick();
+
+    expect(visibility!.value).toBe('hidden');
+    scope.stop();
+  });
+
+  it('invokes onChange with new state, previous state, and the event', async () => {
+    const onChange = vi.fn();
+    const scope = effectScope();
+    scope.run(() => {
+      useDocumentVisibility({ onChange });
+    });
+
+    setVisibility('hidden');
+    await nextTick();
+
+    expect(onChange).toHaveBeenCalledTimes(1);
+    const [state, previous, event] = onChange.mock.calls[0]!;
+    expect(state).toBe('hidden');
+    expect(previous).toBe('visible');
+    expect(event).toBeInstanceOf(Event);
+
+    setVisibility('visible');
+    await nextTick();
+
+    expect(onChange).toHaveBeenCalledTimes(2);
+    expect(onChange.mock.calls[1]!.slice(0, 2)).toEqual(['visible', 'hidden']);
+    scope.stop();
+  });
+
+  it('does not update or fire onChange when the state is unchanged', async () => {
+    const onChange = vi.fn();
+    const scope = effectScope();
+    let visibility: ReturnType<typeof useDocumentVisibility>;
+    scope.run(() => {
+      visibility = useDocumentVisibility({ onChange });
+    });
+
+    // visibilityState is already 'visible'; dispatching with no real change is a no-op
+    document.dispatchEvent(new Event('visibilitychange'));
+    await nextTick();
+
+    expect(onChange).not.toHaveBeenCalled();
+    expect(visibility!.value).toBe('visible');
+    scope.stop();
+  });
+
+  it('reflects a non-default initial state at setup time', () => {
+    Object.defineProperty(document, 'visibilityState', { value: 'hidden', configurable: true });
+
+    const scope = effectScope();
+    let visibility: ReturnType<typeof useDocumentVisibility>;
+    scope.run(() => {
+      visibility = useDocumentVisibility();
+    });
+
+    expect(visibility!.value).toBe('hidden');
+    scope.stop();
+  });
+
+  it('is SSR-safe and returns "visible" without a document', () => {
+    const scope = effectScope();
+    let visibility: ReturnType<typeof useDocumentVisibility>;
+    scope.run(() => {
+      visibility = useDocumentVisibility({ document: undefined });
+    });
+
+    expect(visibility!.value).toBe('visible');
+    scope.stop();
+  });
+
+  it('accepts a custom document instance', async () => {
+    const onChange = vi.fn();
+    let listener: ((event: Event) => void) | undefined;
+    const customDoc = {
+      visibilityState: 'visible' as DocumentVisibilityState,
+      addEventListener: (_type: string, cb: (event: Event) => void) => { listener = cb; },
+      removeEventListener: vi.fn(),
+    } as unknown as Document;
+
+    const scope = effectScope();
+    let visibility: ReturnType<typeof useDocumentVisibility>;
+    scope.run(() => {
+      visibility = useDocumentVisibility({ document: customDoc, onChange });
+    });
+
+    expect(visibility!.value).toBe('visible');
+
+    (customDoc as { visibilityState: DocumentVisibilityState }).visibilityState = 'hidden';
+    listener?.(new Event('visibilitychange'));
+    await nextTick();
+
+    expect(visibility!.value).toBe('hidden');
+    expect(onChange).toHaveBeenCalledWith('hidden', 'visible', expect.any(Event));
+    scope.stop();
+  });
+});

vue/toolkit/src/composables/elements/useDocumentVisibility/index.ts

@@ -0,0 +1,67 @@
+import { shallowRef } from 'vue';
+import type { ShallowRef } from 'vue';
+import { defaultDocument } from '@/types';
+import type { ConfigurableDocument } from '@/types';
+import { useEventListener } from '@/composables/browser/useEventListener';
+
+export interface UseDocumentVisibilityOptions extends ConfigurableDocument {
+  /**
+   * Called whenever `document.visibilityState` changes, receiving the new state,
+   * the previous state, and the originating `visibilitychange` event.
+   *
+   * @default undefined
+   */
+  onChange?: (
+    state: DocumentVisibilityState,
+    previous: DocumentVisibilityState,
+    event: Event,
+  ) => void;
+}
+
+export type UseDocumentVisibilityReturn = ShallowRef<DocumentVisibilityState>;
+
+/**
+ * @name useDocumentVisibility
+ * @category Elements
+ * @description Reactive `document.visibilityState`.
+ *
+ * @param {UseDocumentVisibilityOptions} [options={}] Options (custom `document`, `onChange` callback)
+ * @returns {UseDocumentVisibilityReturn} The current visibility state
+ *
+ * @example
+ * const visibility = useDocumentVisibility();
+ * watch(visibility, (state) => {
+ *   if (state === 'visible') refresh();
+ * });
+ *
+ * @example
+ * useDocumentVisibility({
+ *   onChange: (state) => {
+ *     if (state === 'hidden') pausePlayback();
+ *   },
+ * });
+ *
+ * @since 0.0.15
+ */
+export function useDocumentVisibility(
+  options: UseDocumentVisibilityOptions = {},
+): UseDocumentVisibilityReturn {
+  const { document = defaultDocument, onChange } = options;
+
+  const visibility = shallowRef<DocumentVisibilityState>(document?.visibilityState ?? 'visible');
+
+  if (document) {
+    useEventListener(document, 'visibilitychange', (event) => {
+      const previous = visibility.value;
+      const state = document.visibilityState;
+
+      if (state === previous)
+        return;
+
+      visibility.value = state;
+      onChange?.(state, previous, event);
+    }, { passive: true });
+  }
+
+  return visibility;
+}