Skip to content

Commit b4b72b8

Browse files
committed
chore: pnpm api.update
1 parent a303212 commit b4b72b8

File tree

3 files changed

+63
-10
lines changed

3 files changed

+63
-10
lines changed

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

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1335,7 +1335,7 @@
13351335
}
13361336
],
13371337
"kind": "TypeAlias",
1338-
"content": "An event handler for Qwik events, can be a handler QRL or an array of handler QRLs.\n\n\n```typescript\nexport type QRLEventHandlerMulti<EV extends Event, EL> = QRL<EventHandler<EV, EL>> | undefined | null | QRLEventHandlerMulti<EV, EL>[] | EventHandler<EV, EL>;\n```\n**References:** [QRL](#qrl)<!-- -->, [EventHandler](#eventhandler)<!-- -->, [QRLEventHandlerMulti](#qrleventhandlermulti)",
1338+
"content": "An event handler for Qwik events, can be a handler QRL or an array of handler QRLs.\n\n\n```typescript\nexport type QRLEventHandlerMulti<EV extends Event, EL> = QRL<EventHandler<EV, EL>> | undefined | null | QRLEventHandlerMulti<EV, EL>[];\n```\n**References:** [QRL](#qrl)<!-- -->, [EventHandler](#eventhandler)<!-- -->, [QRLEventHandlerMulti](#qrleventhandlermulti)",
13391339
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-attributes.ts",
13401340
"mdFile": "core.qrleventhandlermulti.md"
13411341
},
@@ -1577,6 +1577,20 @@
15771577
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-events.ts",
15781578
"mdFile": "core.qwikpointerevent.md"
15791579
},
1580+
{
1581+
"name": "QwikResumeEvent",
1582+
"id": "qwikresumeevent",
1583+
"hierarchy": [
1584+
{
1585+
"name": "QwikResumeEvent",
1586+
"id": "qwikresumeevent"
1587+
}
1588+
],
1589+
"kind": "TypeAlias",
1590+
"content": "Emitted by qwik-core on the container element when it resumes from a paused state. You cannot put a Qwik event handler on the container so you must listen on the document instead.\n\n\n```typescript\nexport type QwikResumeEvent = CustomEvent<{}>;\n```",
1591+
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-events.ts",
1592+
"mdFile": "core.qwikresumeevent.md"
1593+
},
15801594
{
15811595
"name": "QwikSubmitEvent",
15821596
"id": "qwiksubmitevent",
@@ -1615,7 +1629,7 @@
16151629
}
16161630
],
16171631
"kind": "TypeAlias",
1618-
"content": "Emitted by qwik-loader when a module was lazily loaded\n\n\n```typescript\nexport type QwikSymbolEvent = CustomEvent<{\n symbol: string;\n element: Element;\n reqTime: number;\n qBase?: string;\n qManifest?: string;\n qVersion?: string;\n href?: string;\n}>;\n```",
1632+
"content": "Emitted by qwik-loader on document when a module was lazily loaded\n\n\n```typescript\nexport type QwikSymbolEvent = CustomEvent<{\n symbol: string;\n element: Element;\n reqTime: number;\n qBase?: string;\n qManifest?: string;\n qVersion?: string;\n href?: string;\n}>;\n```",
16191633
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-events.ts",
16201634
"mdFile": "core.qwiksymbolevent.md"
16211635
},
@@ -1661,6 +1675,20 @@
16611675
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-events.ts",
16621676
"mdFile": "core.qwikuievent.md"
16631677
},
1678+
{
1679+
"name": "QwikViewTransitionEvent",
1680+
"id": "qwikviewtransitionevent",
1681+
"hierarchy": [
1682+
{
1683+
"name": "QwikViewTransitionEvent",
1684+
"id": "qwikviewtransitionevent"
1685+
}
1686+
],
1687+
"kind": "TypeAlias",
1688+
"content": "Emitted by qwik-core on document when the a view transition start\n\n\n```typescript\nexport type QwikViewTransitionEvent = CustomEvent<ViewTransition>;\n```",
1689+
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-events.ts",
1690+
"mdFile": "core.qwikviewtransitionevent.md"
1691+
},
16641692
{
16651693
"name": "QwikVisibleEvent",
16661694
"id": "qwikvisibleevent",
@@ -1671,7 +1699,7 @@
16711699
}
16721700
],
16731701
"kind": "TypeAlias",
1674-
"content": "Emitted by qwik-loader when an element becomes visible. Used by `useVisibleTask$`\n\n\n```typescript\nexport type QwikVisibleEvent = CustomEvent<IntersectionObserverEntry>;\n```",
1702+
"content": "Handled by qwik-loader when an element becomes visible. Used by `useVisibleTask$`<!-- -->. Does not bubble.\n\n\n```typescript\nexport type QwikVisibleEvent = CustomEvent<IntersectionObserverEntry>;\n```",
16751703
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-events.ts",
16761704
"mdFile": "core.qwikvisibleevent.md"
16771705
},
@@ -2234,7 +2262,7 @@
22342262
}
22352263
],
22362264
"kind": "Interface",
2237-
"content": "```typescript\nexport interface SyncQRL<TYPE extends Function = any> extends QRL<TYPE> \n```\n**Extends:** [QRL](#qrl)<!-- -->&lt;TYPE&gt;\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\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\n[\\_\\_brand\\_\\_SyncQRL\\_\\_](#)\n\n\n</td><td>\n\n\n</td><td>\n\nTYPE\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[dev](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQRLDev \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[resolved](#)\n\n\n</td><td>\n\n\n</td><td>\n\nTYPE\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
2265+
"content": "```typescript\nexport interface SyncQRL<TYPE extends Function> extends QRL<TYPE> \n```\n**Extends:** [QRL](#qrl)<!-- -->&lt;TYPE&gt;\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\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\n[\\_\\_brand\\_\\_SyncQRL\\_\\_](#)\n\n\n</td><td>\n\n\n</td><td>\n\nTYPE\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[dev](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQRLDev \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[resolved](#)\n\n\n</td><td>\n\n\n</td><td>\n\nTYPE\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
22382266
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/qrl/qrl.public.ts",
22392267
"mdFile": "core.syncqrl.md"
22402268
},

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

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2928,8 +2928,7 @@ export type QRLEventHandlerMulti<EV extends Event, EL> =
29282928
| QRL<EventHandler<EV, EL>>
29292929
| undefined
29302930
| null
2931-
| QRLEventHandlerMulti<EV, EL>[]
2932-
| EventHandler<EV, EL>;
2931+
| QRLEventHandlerMulti<EV, EL>[];
29332932
```
29342933
29352934
**References:** [QRL](#qrl), [EventHandler](#eventhandler), [QRLEventHandlerMulti](#qrleventhandlermulti)
@@ -3262,6 +3261,16 @@ export type QwikPointerEvent<T = Element> = NativePointerEvent;
32623261
32633262
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-events.ts)
32643263
3264+
## QwikResumeEvent
3265+
3266+
Emitted by qwik-core on the container element when it resumes from a paused state. You cannot put a Qwik event handler on the container so you must listen on the document instead.
3267+
3268+
```typescript
3269+
export type QwikResumeEvent = CustomEvent<{}>;
3270+
```
3271+
3272+
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-events.ts)
3273+
32653274
## QwikSubmitEvent
32663275
32673276
> Warning: This API is now obsolete.
@@ -3293,7 +3302,7 @@ export type QwikSVGElements = {
32933302
32943303
## QwikSymbolEvent
32953304
3296-
Emitted by qwik-loader when a module was lazily loaded
3305+
Emitted by qwik-loader on document when a module was lazily loaded
32973306
32983307
```typescript
32993308
export type QwikSymbolEvent = CustomEvent<{
@@ -3351,9 +3360,19 @@ export type QwikUIEvent<T = Element> = NativeUIEvent;
33513360
33523361
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-events.ts)
33533362
3363+
## QwikViewTransitionEvent
3364+
3365+
Emitted by qwik-core on document when the a view transition start
3366+
3367+
```typescript
3368+
export type QwikViewTransitionEvent = CustomEvent<ViewTransition>;
3369+
```
3370+
3371+
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-qwik-events.ts)
3372+
33543373
## QwikVisibleEvent
33553374
3356-
Emitted by qwik-loader when an element becomes visible. Used by `useVisibleTask$`
3375+
Handled by qwik-loader when an element becomes visible. Used by `useVisibleTask$`. Does not bubble.
33573376
33583377
```typescript
33593378
export type QwikVisibleEvent = CustomEvent<IntersectionObserverEntry>;
@@ -8728,7 +8747,7 @@ Function to extract.
87288747
## SyncQRL
87298748
87308749
```typescript
8731-
export interface SyncQRL<TYPE extends Function = any> extends QRL<TYPE>
8750+
export interface SyncQRL<TYPE extends Function> extends QRL<TYPE>
87328751
```
87338752
87348753
**Extends:** [QRL](#qrl)&lt;TYPE&gt;

packages/qwik/src/core/qwik.core.api.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -751,6 +751,9 @@ export type QwikMouseEvent<T = Element, E = NativeMouseEvent> = E;
751751
// @public @deprecated (undocumented)
752752
export type QwikPointerEvent<T = Element> = NativePointerEvent;
753753

754+
// @public
755+
export type QwikResumeEvent = CustomEvent<{}>;
756+
754757
// @public @deprecated (undocumented)
755758
export type QwikSubmitEvent<T = Element> = SubmitEvent;
756759

@@ -779,6 +782,9 @@ export type QwikTransitionEvent<T = Element> = NativeTransitionEvent;
779782
// @public @deprecated (undocumented)
780783
export type QwikUIEvent<T = Element> = NativeUIEvent;
781784

785+
// @public
786+
export type QwikViewTransitionEvent = CustomEvent<ViewTransition>;
787+
782788
// @public
783789
export type QwikVisibleEvent = CustomEvent<IntersectionObserverEntry>;
784790

@@ -1637,7 +1643,7 @@ export interface SVGProps<T extends Element> extends SVGAttributes, QwikAttribut
16371643
export const sync$: <T extends Function>(fn: T) => SyncQRL<T>;
16381644

16391645
// @public (undocumented)
1640-
export interface SyncQRL<TYPE extends Function = any> extends QRL<TYPE> {
1646+
export interface SyncQRL<TYPE extends Function> extends QRL<TYPE> {
16411647
// (undocumented)
16421648
__brand__SyncQRL__: TYPE;
16431649
(...args: TYPE extends (...args: infer ARGS) => any ? ARGS : never): TYPE extends (...args: any[]) => infer RETURN ? RETURN : never;

0 commit comments

Comments
 (0)