fix: deprecated event$

.changeset/hip-lemons-move.md

@@ -0,0 +1,5 @@
+---
+'@builder.io/qwik': patch
+---
+
+Deprecated event$, it will be removed in v2. Instead, use `$()`, and inside the function add `if (isServer) { return; }`

packages/docs/src/components/theme-toggle/theme-toggle.tsx

@@ -1,4 +1,4 @@
-import { component$, event$, useContext, useStyles$ } from '@builder.io/qwik';
+import { component$, $, useContext, useStyles$ } from '@builder.io/qwik';
 import { SunAndMoon } from './sun-and-moon';
 import { themeStorageKey } from '../router-head/theme-script';
 import themeToggle from './theme-toggle.css?inline';
@@ -45,7 +45,7 @@ export const ThemeToggle = component$(() => {
   useStyles$(themeToggle);
   const state = useContext(GlobalStore);
 
-  const onClick$ = event$(() => {
+  const onClick$ = $(() => {
     state.theme = state.theme === 'light' ? 'dark' : 'light';
     setPreference(state.theme);
   });

packages/docs/src/routes/api/qwik/api.json

@@ -819,7 +819,7 @@
         }
       ],
       "kind": "Function",
-      "content": "```typescript\nevent$: <T>(qrl: T) => QRL<T>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nqrl\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n[QRL](#qrl)<!-- -->&lt;T&gt;",
+      "content": "> Warning: This API is now obsolete.\n> \n> It will be removed in v2. Instead, use `$()`<!-- -->, and inside the function add `if (isServer) { return; }`\n> \n\n\n```typescript\nevent$: <T>(qrl: T) => QRL<T>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nqrl\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n[QRL](#qrl)<!-- -->&lt;T&gt;",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/qrl/qrl.public.ts",
       "mdFile": "qwik.event_.md"
     },

packages/docs/src/routes/api/qwik/index.md

@@ -2168,6 +2168,10 @@ any \| undefined
 
 ## event$
 
+> Warning: This API is now obsolete.
+>
+> It will be removed in v2. Instead, use `$()`, and inside the function add `if (isServer) { return; }`
+
 ```typescript
 event$: <T>(qrl: T) => QRL<T>;
 ```

packages/qwik-city/src/runtime/src/spa-init.ts

@@ -2,8 +2,8 @@ import type { ClientSPAWindow } from './qwik-city-component';
 import type { ScrollHistoryState } from './scroll-restoration';
 import type { ScrollState } from './types';
 
-import { isDev } from '@builder.io/qwik';
-import { event$ } from '@builder.io/qwik';
+import { isDev, isServer } from '@builder.io/qwik';
+import { $ } from '@builder.io/qwik';
 
 // TODO Dedupe handler code from here and QwikCityProvider?
 // TODO Navigation API; check for support & simplify.
@@ -14,13 +14,18 @@ import { event$ } from '@builder.io/qwik';
 // - Robust, fully relies only on history. (scrollRestoration = 'manual')
 
 // ! DO NOT IMPORT OR USE ANY EXTERNAL REFERENCES IN THIS SCRIPT.
-export default event$((_: Event, el: Element) => {
+export default $((_: Event, el: Element) => {
   const win: ClientSPAWindow = window;
   const spa = '_qCitySPA';
   const initPopstate = '_qCityInitPopstate';
   const initAnchors = '_qCityInitAnchors';
   const initVisibility = '_qCityInitVisibility';
   const initScroll = '_qCityInitScroll';
+
+  if (isServer) {
+    return;
+  }
+
   if (
     !win[spa] &&
     !win[initPopstate] &&

packages/qwik/src/core/api.md

@@ -230,7 +230,7 @@ export interface ErrorBoundaryStore {
     error: any | undefined;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const event$: <T>(qrl: T) => QRL<T>;
 
 // @public

packages/qwik/src/core/qrl/qrl.public.ts

@@ -270,7 +270,7 @@ export const eventQrl = <T>(qrl: QRL<T>): QRL<T> => {
   return qrl;
 };
 
-/** @public */
+/** @public @deprecated It will be removed in v2. Instead, use `$()`, and inside the function add `if (isServer) { return; }` */
 export const event$ = implicit$FirstArg(eventQrl);
 
 /** @alpha */

starters/apps/e2e/src/components/render/render.tsx

@@ -4,7 +4,7 @@ import {
   useStore,
   useStylesScoped$,
   useTask$,
-  event$,
+  $,
   h,
   jsx,
   SkipRender,
@@ -549,7 +549,7 @@ export const Issue3398 = component$(() => {
 export const Issue3479 = component$(() => {
   const count = useSignal(0);
   const attributes = {
-    onClick$: event$(() => count.value++),
+    onClick$: $(() => count.value++),
   };
   const countStr = String(count.value) + "";
   return (