Do not edit this file. It is a report generated by API Extractor.
import * as CSS_2 from 'csstype';
import { JSXNode as JSXNode_2 } from '@builder.io/qwik/jsx-runtime';
import type { StreamWriter as StreamWriter_2 } from '@builder.io/qwik';
// @public
export const $: <T>(expression: T) => QRL<T>;
// @internal (undocumented)
export type _AllowPlainQrl<Q> = QRLEventHandlerMulti<any, any> extends Q ? Q extends QRLEventHandlerMulti<infer EV, infer EL> ? Q | (EL extends Element ? EventHandler<EV, EL> : never) : Q : Q extends QRL<infer U> ? Q | U : NonNullable<Q> extends never ? Q : QRL<Q> | Q;
// Warning: (ae-forgotten-export) The symbol "Attrs" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export interface AnchorHTMLAttributes<T extends Element> extends Attrs<'a', T> {
}
// @public (undocumented)
export interface AreaHTMLAttributes<T extends Element> extends Attrs<'area', T> {
}
// @public
export interface AriaAttributes {
'aria-activedescendant'?: string | undefined;
'aria-atomic'?: Booleanish | undefined;
'aria-autocomplete'?: 'none' | 'inline' | 'list' | 'both' | undefined;
'aria-busy'?: Booleanish | undefined;
'aria-checked'?: boolean | 'false' | 'mixed' | 'true' | undefined;
'aria-colcount'?: number | undefined;
'aria-colindex'?: number | undefined;
'aria-colspan'?: number | undefined;
'aria-controls'?: string | undefined;
'aria-current'?: boolean | 'false' | 'true' | 'page' | 'step' | 'location' | 'date' | 'time' | undefined;
'aria-describedby'?: string | undefined;
'aria-details'?: string | undefined;
'aria-disabled'?: Booleanish | undefined;
// @deprecated
'aria-dropeffect'?: 'none' | 'copy' | 'execute' | 'link' | 'move' | 'popup' | undefined;
'aria-errormessage'?: string | undefined;
'aria-expanded'?: Booleanish | undefined;
'aria-flowto'?: string | undefined;
// @deprecated
'aria-grabbed'?: Booleanish | undefined;
'aria-haspopup'?: boolean | 'false' | 'true' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog' | undefined;
'aria-hidden'?: Booleanish | undefined;
'aria-invalid'?: boolean | 'false' | 'true' | 'grammar' | 'spelling' | undefined;
'aria-keyshortcuts'?: string | undefined;
'aria-label'?: string | undefined;
'aria-labelledby'?: string | undefined;
'aria-level'?: number | undefined;
'aria-live'?: 'off' | 'assertive' | 'polite' | undefined;
'aria-modal'?: Booleanish | undefined;
'aria-multiline'?: Booleanish | undefined;
'aria-multiselectable'?: Booleanish | undefined;
'aria-orientation'?: 'horizontal' | 'vertical' | undefined;
'aria-owns'?: string | undefined;
'aria-placeholder'?: string | undefined;
'aria-posinset'?: number | undefined;
'aria-pressed'?: boolean | 'false' | 'mixed' | 'true' | undefined;
'aria-readonly'?: Booleanish | undefined;
'aria-relevant'?: 'additions' | 'additions removals' | 'additions text' | 'all' | 'removals' | 'removals additions' | 'removals text' | 'text' | 'text additions' | 'text removals' | undefined;
'aria-required'?: Booleanish | undefined;
'aria-roledescription'?: string | undefined;
'aria-rowcount'?: number | undefined;
'aria-rowindex'?: number | undefined;
'aria-rowspan'?: number | undefined;
'aria-selected'?: Booleanish | undefined;
'aria-setsize'?: number | undefined;
'aria-sort'?: 'none' | 'ascending' | 'descending' | 'other' | undefined;
'aria-valuemax'?: number | undefined;
'aria-valuemin'?: number | undefined;
'aria-valuenow'?: number | undefined;
'aria-valuetext'?: string | undefined;
}
// @public (undocumented)
export type AriaRole = 'alert' | 'alertdialog' | 'application' | 'article' | 'banner' | 'button' | 'cell' | 'checkbox' | 'columnheader' | 'combobox' | 'complementary' | 'contentinfo' | 'definition' | 'dialog' | 'directory' | 'document' | 'feed' | 'figure' | 'form' | 'grid' | 'gridcell' | 'group' | 'heading' | 'img' | 'link' | 'list' | 'listbox' | 'listitem' | 'log' | 'main' | 'marquee' | 'math' | 'menu' | 'menubar' | 'menuitem' | 'menuitemcheckbox' | 'menuitemradio' | 'navigation' | 'none' | 'note' | 'option' | 'presentation' | 'progressbar' | 'radio' | 'radiogroup' | 'region' | 'row' | 'rowgroup' | 'rowheader' | 'scrollbar' | 'search' | 'searchbox' | 'separator' | 'slider' | 'spinbutton' | 'status' | 'switch' | 'tab' | 'table' | 'tablist' | 'tabpanel' | 'term' | 'textbox' | 'timer' | 'toolbar' | 'tooltip' | 'tree' | 'treegrid' | 'treeitem' | (string & {});
// @public (undocumented)
export interface AudioHTMLAttributes<T extends Element> extends Attrs<'audio', T> {
}
// @public (undocumented)
export interface BaseHTMLAttributes<T extends Element> extends Attrs<'base', T> {
}
// @public (undocumented)
export interface BlockquoteHTMLAttributes<T extends Element> extends Attrs<'blockquote', T> {
}
// @public (undocumented)
export type Booleanish = boolean | `${boolean}`;
// @public (undocumented)
export interface ButtonHTMLAttributes<T extends Element> extends Attrs<'button', T> {
}
// @public (undocumented)
export interface CanvasHTMLAttributes<T extends Element> extends Attrs<'canvas', T> {
}
// @public
export type ClassList = string | undefined | null | false | Record<string, boolean | string | number | null | undefined> | ClassList[];
// @public (undocumented)
export interface ColgroupHTMLAttributes<T extends Element> extends Attrs<'colgroup', T> {
}
// @public (undocumented)
export interface ColHTMLAttributes<T extends Element> extends Attrs<'col', T> {
}
// @public
export const component$: <PROPS = unknown>(onMount: OnRenderFn<PROPS>) => Component<PROPS>;
// @public
export type Component<PROPS = unknown> = FunctionComponent<PublicProps<PROPS>>;
// @public (undocumented)
export interface ComponentBaseProps {
// (undocumented)
'q:slot'?: string;
// (undocumented)
key?: string | number | null | undefined;
}
// @public
export const componentQrl: <PROPS extends Record<any, any>>(componentQrl: QRL<OnRenderFn<PROPS>>) => Component<PROPS>;
// @internal (undocumented)
export const _CONST_PROPS: unique symbol;
// @public
export interface ContextId<STATE> {
readonly __brand_context_type__: STATE;
readonly id: string;
}
// @public
export interface CorePlatform {
chunkForSymbol: (symbolName: string, chunk: string | null) => readonly [symbol: string, chunk: string] | undefined;
importSymbol: (containerEl: Element | undefined, url: string | URL | undefined | null, symbol: string) => ValueOrPromise<any>;
isServer: boolean;
nextTick: (fn: () => any) => Promise<any>;
raf: (fn: () => any) => Promise<any>;
}
// @public
export interface CorrectedToggleEvent extends Event {
// (undocumented)
readonly newState: 'open' | 'closed';
// (undocumented)
readonly prevState: 'open' | 'closed';
}
// @public
export const createContextId: <STATE = unknown>(name: string) => ContextId<STATE>;
// @public (undocumented)
export interface CSSProperties extends CSS_2.Properties<string | number>, CSS_2.PropertiesHyphen<string | number> {
[v: `--${string}`]: string | number | undefined;
}
// @public (undocumented)
export interface DataHTMLAttributes<T extends Element> extends Attrs<'data', T> {
}
// @public (undocumented)
export interface DelHTMLAttributes<T extends Element> extends Attrs<'del', T> {
}
// @internal (undocumented)
export const _deserializeData: (data: string, element?: unknown) => any;
// @public (undocumented)
export interface DetailsHTMLAttributes<T extends Element> extends Attrs<'details', T> {
}
// @public (undocumented)
export interface DevJSX {
// (undocumented)
columnNumber: number;
// (undocumented)
fileName: string;
// (undocumented)
lineNumber: number;
// (undocumented)
stack?: string;
}
// @public (undocumented)
export interface DialogHTMLAttributes<T extends Element> extends Attrs<'dialog', T> {
}
// Warning: (ae-forgotten-export) The symbol "DOMAttributesBase" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "QwikEvents" needs to be exported by the entry point index.d.ts
//
// @public
export interface DOMAttributes<EL extends Element> extends DOMAttributesBase<EL>, QwikEvents<EL> {
// (undocumented)
class?: ClassList | Signal<ClassList> | undefined;
}
// @public (undocumented)
export type EagernessOptions = 'visible' | 'load' | 'idle';
// @public (undocumented)
export interface EmbedHTMLAttributes<T extends Element> extends Attrs<'embed', T> {
}
// @public (undocumented)
export interface ErrorBoundaryStore {
// (undocumented)
error: any | undefined;
}
// @public (undocumented)
export const event$: <T>(first: T) => QRL<T>;
// @public
export type EventHandler<EV = Event, EL = Element> = {
bivarianceHack(event: EV, element: EL): any;
}['bivarianceHack'];
// @public (undocumented)
export const eventQrl: <T>(qrl: QRL<T>) => QRL<T>;
// @public (undocumented)
export interface FieldsetHTMLAttributes<T extends Element> extends Attrs<'fieldset', T> {
}
// Warning: (ae-forgotten-export) The symbol "SignalDerived" needs to be exported by the entry point index.d.ts
//
// @internal (undocumented)
export const _fnSignal: <T extends (...args: any) => any>(fn: T, args: Parameters<T>, fnStr?: string) => SignalDerived<ReturnType<T>, Parameters<T>>;
// @public (undocumented)
export interface FormHTMLAttributes<T extends Element> extends Attrs<'form', T> {
}
// @public (undocumented)
export const Fragment: FunctionComponent<{
children?: any;
key?: string | number | null;
}>;
// @public
export type FunctionComponent<P = unknown> = {
renderFn(props: P, key: string | null, flags: number, dev?: DevJSX): JSXOutput;
}['renderFn'];
// @internal (undocumented)
export const _getContextElement: () => unknown;
// @internal (undocumented)
export const _getContextEvent: () => unknown;
// Warning: (ae-forgotten-export) The symbol "ElementVNode" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ClientContainer" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function getDomContainer(element: Element | ElementVNode): ClientContainer;
// Warning: (ae-internal-missing-underscore) The name "getLocale" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export function getLocale(defaultLocale?: string): string;
// @public
export const getPlatform: () => CorePlatform;
// @public
function h<TYPE extends string | FunctionComponent<PROPS>, PROPS extends {} = {}>(type: TYPE, props?: PROPS | null, ...children: any[]): JSXNode<TYPE>;
export { h as createElement }
export { h }
// @public (undocumented)
export interface HrHTMLAttributes<T extends Element> extends Attrs<'hr', T> {
}
// @public (undocumented)
export type HTMLAttributeAnchorTarget = '_self' | '_blank' | '_parent' | '_top' | (string & {});
// @public (undocumented)
export type HTMLAttributeReferrerPolicy = ReferrerPolicy;
// @public (undocumented)
export interface HTMLAttributes<E extends Element> extends HTMLElementAttrs, DOMAttributes<E> {
}
// @public (undocumented)
export type HTMLCrossOriginAttribute = 'anonymous' | 'use-credentials' | '' | undefined;
// Warning: (ae-forgotten-export) The symbol "HTMLAttributesBase" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "FilterBase" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export interface HTMLElementAttrs extends HTMLAttributesBase, FilterBase<HTMLElement> {
}
// @public (undocumented)
export const HTMLFragment: FunctionComponent<{
dangerouslySetInnerHTML: string;
}>;
// @public (undocumented)
export interface HtmlHTMLAttributes<T extends Element> extends Attrs<'html', T> {
}
// @public (undocumented)
export type HTMLInputAutocompleteAttribute = 'on' | 'off' | 'billing' | 'shipping' | 'name' | 'honorific-prefix' | 'given-name' | 'additional-name' | 'family-name' | 'honorific-suffix' | 'nickname' | 'username' | 'new-password' | 'current-password' | 'one-time-code' | 'organization-title' | 'organization' | 'street-address' | 'address-line1' | 'address-line2' | 'address-line3' | 'address-level4' | 'address-level3' | 'address-level2' | 'address-level1' | 'country' | 'country-name' | 'postal-code' | 'cc-name' | 'cc-given-name' | 'cc-additional-name' | 'cc-family-name' | 'cc-number' | 'cc-exp' | 'cc-exp-month' | 'cc-exp-year' | 'cc-csc' | 'cc-type' | 'transaction-currency' | 'transaction-amount' | 'language' | 'bday' | 'bday-day' | 'bday-month' | 'bday-year' | 'sex' | 'url' | 'photo';
// @public (undocumented)
export type HTMLInputTypeAttribute = 'button' | 'checkbox' | 'color' | 'date' | 'datetime-local' | 'email' | 'file' | 'hidden' | 'image' | 'month' | 'number' | 'password' | 'radio' | 'range' | 'reset' | 'search' | 'submit' | 'tel' | 'text' | 'time' | 'url' | 'week' | (string & {});
// @internal
export const _hW: () => void;
// @public (undocumented)
export interface IframeHTMLAttributes<T extends Element> extends Attrs<'iframe', T> {
}
// @public (undocumented)
export interface ImgHTMLAttributes<T extends Element> extends Attrs<'img', T> {
}
// @public
export const implicit$FirstArg: <FIRST, REST extends any[], RET>(fn: (first: QRL<FIRST>, ...rest: REST) => RET) => ((first: FIRST, ...rest: REST) => RET);
// Warning: (ae-internal-missing-underscore) The name "inlinedQrl" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export const inlinedQrl: <T>(symbol: T, symbolName: string, lexicalScopeCapture?: any[]) => QRL<T>;
// Warning: (ae-forgotten-export) The symbol "QRLDev" needs to be exported by the entry point index.d.ts
// Warning: (ae-internal-missing-underscore) The name "inlinedQrlDEV" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export const inlinedQrlDEV: <T = any>(symbol: T, symbolName: string, opts: QRLDev, lexicalScopeCapture?: any[]) => QRL<T>;
// @public (undocumented)
export type InputHTMLAttributes<T extends Element> = Attrs<'input', T, HTMLInputElement>;
// @public (undocumented)
export interface InsHTMLAttributes<T extends Element> extends Attrs<'ins', T> {
}
// Warning: (ae-incompatible-release-tags) The symbol "IntrinsicElements" is marked as @public, but its signature references "IntrinsicHTMLElements" which is marked as @internal
// Warning: (ae-incompatible-release-tags) The symbol "IntrinsicElements" is marked as @public, but its signature references "IntrinsicSVGElements" which is marked as @internal
//
// @public (undocumented)
export interface IntrinsicElements extends IntrinsicHTMLElements, IntrinsicSVGElements {
}
// Warning: (ae-forgotten-export) The symbol "Augmented" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "SpecialAttrs" needs to be exported by the entry point index.d.ts
// Warning: (ae-internal-missing-underscore) The name "IntrinsicHTMLElements" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export type IntrinsicHTMLElements = {
[key in keyof HTMLElementTagNameMap]: Augmented<HTMLElementTagNameMap[key], SpecialAttrs[key]> & HTMLAttributes<HTMLElementTagNameMap[key]>;
} & {
[unknownTag: string]: {
[prop: string]: any;
} & HTMLElementAttrs & HTMLAttributes<any>;
};
// Warning: (ae-internal-missing-underscore) The name "IntrinsicSVGElements" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export type IntrinsicSVGElements = {
[K in keyof Omit<SVGElementTagNameMap, keyof HTMLElementTagNameMap>]: LenientSVGProps<SVGElementTagNameMap[K]>;
};
// @internal (undocumented)
export const _isJSXNode: <T>(n: unknown) => n is JSXNode<T>;
// @public
export const isSignal: <T = unknown>(obj: any) => obj is Signal<T>;
// Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
//
// @public
const jsx: <T extends string | FunctionComponent<any>>(type: T, props: T extends FunctionComponent<infer PROPS> ? PROPS : Props, key?: string | number | null) => JSXNode<T>;
export { jsx }
export { jsx as jsxs }
// @internal (undocumented)
export const _jsxBranch: <T>(input?: T) => T | undefined;
// @internal
export const _jsxC: <T extends string | FunctionComponent<any>>(type: T, varProps: Props | null, constProps: Props | null, flags: number, key: string | number | null, dev?: DevJSX) => JSXNode<T>;
// @public (undocumented)
export type JSXChildren = string | number | boolean | null | undefined | Function | RegExp | JSXChildren[] | Promise<JSXChildren> | Signal<JSXChildren> | JSXNode;
// Warning: (ae-forgotten-export) The symbol "JsxDevOpts" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const jsxDEV: <T extends string | FunctionComponent<Props>>(type: T, props: T extends FunctionComponent<infer PROPS> ? PROPS : Props, key: string | number | null | undefined, _isStatic: boolean, opts: JsxDevOpts, _ctx: unknown) => JSXNode<T>;
// @public
export interface JSXNode<T extends string | FunctionComponent | unknown = unknown> {
// (undocumented)
children: JSXChildren | null;
// (undocumented)
constProps: Record<any, unknown> | null;
// (undocumented)
dev?: DevJSX;
// (undocumented)
flags: number;
// (undocumented)
key: string | null;
// (undocumented)
props: T extends FunctionComponent<infer P> ? P : Record<any, unknown>;
// (undocumented)
type: T;
// (undocumented)
varProps: Record<any, unknown>;
}
// @public
export type JSXOutput = JSXNode | string | number | boolean | null | undefined | JSXOutput[];
// @internal
export const _jsxQ: <T>(type: T, varProps: Props | null, constProps: Props | null, children: JSXChildren | null, flags: number, key: string | number | null | undefined, dev?: DevJSX) => JSXNode<T>;
// @public (undocumented)
export type JSXTagName = keyof HTMLElementTagNameMap | Omit<string, keyof HTMLElementTagNameMap>;
// @public @deprecated (undocumented)
export interface KeygenHTMLAttributes<T extends Element> extends Attrs<'base', T> {
}
// Warning: (ae-forgotten-export) The symbol "LiteralUnion" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "AllEventKeys" needs to be exported by the entry point index.d.ts
//
// @public
export type KnownEventNames = LiteralUnion<AllEventKeys, string>;
// @public (undocumented)
export interface LabelHTMLAttributes<T extends Element> extends Attrs<'label', T> {
}
// Warning: (ae-internal-missing-underscore) The name "LenientSVGProps" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export interface LenientSVGProps<T extends Element> extends SVGAttributes, DOMAttributes<T> {
}
// @public (undocumented)
export interface LiHTMLAttributes<T extends Element> extends Attrs<'li', T> {
}
// @public (undocumented)
export interface LinkHTMLAttributes<T extends Element> extends Attrs<'link', T> {
}
// @public (undocumented)
export interface MapHTMLAttributes<T extends Element> extends Attrs<'map', T> {
}
// @public (undocumented)
export interface MediaHTMLAttributes<T extends Element> extends HTMLAttributes<T>, Augmented<HTMLMediaElement, {
crossOrigin?: HTMLCrossOriginAttribute;
}> {
}
// @public (undocumented)
export interface MenuHTMLAttributes<T extends Element> extends Attrs<'menu', T> {
}
// @public (undocumented)
export interface MetaHTMLAttributes<T extends Element> extends Attrs<'meta', T> {
}
// @public (undocumented)
export interface MeterHTMLAttributes<T extends Element> extends Attrs<'meter', T> {
}
// @public @deprecated (undocumented)
export type NativeAnimationEvent = AnimationEvent;
// @public @deprecated (undocumented)
export type NativeClipboardEvent = ClipboardEvent;
// @public @deprecated (undocumented)
export type NativeCompositionEvent = CompositionEvent;
// @public @deprecated (undocumented)
export type NativeDragEvent = DragEvent;
// @public @deprecated (undocumented)
export type NativeFocusEvent = FocusEvent;
// @public @deprecated (undocumented)
export type NativeKeyboardEvent = KeyboardEvent;
// @public @deprecated (undocumented)
export type NativeMouseEvent = MouseEvent;
// @public @deprecated (undocumented)
export type NativePointerEvent = PointerEvent;
// @public @deprecated (undocumented)
export type NativeTouchEvent = TouchEvent;
// @public @deprecated (undocumented)
export type NativeTransitionEvent = TransitionEvent;
// @public @deprecated (undocumented)
export type NativeUIEvent = UIEvent;
// @public @deprecated (undocumented)
export type NativeWheelEvent = WheelEvent;
// @internal (undocumented)
export const _noopQrl: <T>(symbolName: string, lexicalScopeCapture?: any[]) => QRL<T>;
// @public
export type NoSerialize<T> = (T & {
__no_serialize__: true;
}) | undefined;
// @public
export const noSerialize: <T extends object | undefined>(input: T) => NoSerialize<T>;
// @public (undocumented)
export type Numberish = number | `${number}`;
// @public (undocumented)
export interface ObjectHTMLAttributes<T extends Element> extends Attrs<'object', T> {
}
// @public (undocumented)
export interface OlHTMLAttributes<T extends Element> extends Attrs<'ol', T> {
}
// @internal (undocumented)
export type _Only$<P> = {
[K in keyof P as K extends `${string}$` ? K : never]: _AllowPlainQrl<P[K]>;
};
// @public (undocumented)
export type OnRenderFn<PROPS> = (props: PROPS) => JSXOutput;
// @public (undocumented)
export interface OnVisibleTaskOptions {
strategy?: VisibleTaskStrategy;
}
// @public (undocumented)
export interface OptgroupHTMLAttributes<T extends Element> extends Attrs<'optgroup', T> {
}
// @public (undocumented)
export interface OptionHTMLAttributes<T extends Element> extends Attrs<'option', T> {
}
// @public (undocumented)
export interface OutputHTMLAttributes<T extends Element> extends Attrs<'output', T> {
}
// @public @deprecated (undocumented)
export interface ParamHTMLAttributes<T extends Element> extends Attrs<'base', T, HTMLParamElement> {
}
// Warning: (ae-forgotten-export) The symbol "QContext" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ContainerState" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "GetObjID" needs to be exported by the entry point index.d.ts
//
// @internal
export const _pauseFromContexts: (allContexts: QContext[], containerState: ContainerState, fallbackGetObjId?: GetObjID, textNodes?: Map<string, string>) => Promise<SnapshotResult>;
// @alpha
export const PrefetchGraph: (opts?: {
base?: string;
manifestHash?: string;
manifestURL?: string;
}) => JSXNode_2<string>;
// @alpha
export const PrefetchServiceWorker: (opts: {
base?: string;
path?: string;
verbose?: boolean;
fetchBundleGraph?: boolean;
}) => JSXNode_2<string>;
// @public (undocumented)
export interface ProgressHTMLAttributes<T extends Element> extends Attrs<'progress', T> {
}
// @public @deprecated (undocumented)
export type PropFnInterface<ARGS extends any[], RET> = {
__qwik_serializable__?: any;
(...args: ARGS): Promise<RET>;
};
// @public
export type PropFunction<T> = QRL<T>;
// @public @deprecated (undocumented)
export type PropFunctionProps<PROPS extends Record<any, any>> = {
[K in keyof PROPS]: PROPS[K] extends undefined ? PROPS[K] : PROPS[K] extends ((...args: infer ARGS) => infer RET) | undefined ? PropFnInterface<ARGS, Awaited<RET>> : PROPS[K];
};
// Warning: (ae-forgotten-export) The symbol "IsAny" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ObjectProps" needs to be exported by the entry point index.d.ts
//
// @public
export type PropsOf<COMP> = COMP extends string ? COMP extends keyof QwikIntrinsicElements ? QwikIntrinsicElements[COMP] : QwikIntrinsicElements['span'] : NonNullable<COMP> extends never ? never : COMP extends FunctionComponent<infer PROPS> ? PROPS extends Record<any, infer V> ? IsAny<V> extends true ? never : ObjectProps<PROPS> : COMP extends Component<infer OrigProps> ? ObjectProps<OrigProps> : PROPS : never;
// Warning: (ae-forgotten-export) The symbol "ComponentChildren" needs to be exported by the entry point index.d.ts
// Warning: (ae-incompatible-release-tags) The symbol "PublicProps" is marked as @public, but its signature references "_Only$" which is marked as @internal
//
// @public
export type PublicProps<PROPS> = (PROPS extends Record<any, any> ? Omit<PROPS, `${string}$`> & _Only$<PROPS> : unknown extends PROPS ? {} : PROPS) & ComponentBaseProps & ComponentChildren<PROPS>;
// Warning: (ae-forgotten-export) The symbol "BivariantQrlFn" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "QrlArgs" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "QrlReturn" needs to be exported by the entry point index.d.ts
//
// @public
export type QRL<TYPE = unknown> = {
__qwik_serializable__?: any;
__brand__QRL__: TYPE;
resolve(): Promise<TYPE>;
resolved: undefined | TYPE;
getCaptured(): unknown[] | null;
getSymbol(): string;
getHash(): string;
dev: QRLDev | null;
} & BivariantQrlFn<QrlArgs<TYPE>, QrlReturn<TYPE>>;
// @public
export const qrl: <T = any>(chunkOrFn: string | (() => Promise<any>), symbol: string, lexicalScopeCapture?: any[], stackOffset?: number) => QRL<T>;
// Warning: (ae-internal-missing-underscore) The name "qrlDEV" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export const qrlDEV: <T = any>(chunkOrFn: string | (() => Promise<any>), symbol: string, opts: QRLDev, lexicalScopeCapture?: any[]) => QRL<T>;
// @beta
export type QRLEventHandlerMulti<EV extends Event, EL> = QRL<EventHandler<EV, EL>> | undefined | null | QRLEventHandlerMulti<EV, EL>[];
// Warning: (ae-forgotten-export) The symbol "SyncQRL" needs to be exported by the entry point index.d.ts
//
// @alpha
export const _qrlSync: <TYPE extends Function>(fn: TYPE, serializedFn?: string) => SyncQRL<TYPE>;
// @public (undocumented)
export interface QuoteHTMLAttributes<T extends Element> extends Attrs<'q', T> {
}
// @public @deprecated (undocumented)
export type QwikAnimationEvent<T = Element> = NativeAnimationEvent;
// @public
export interface QwikAttributes<EL extends Element> extends DOMAttributesBase<EL>, QwikEvents<EL, false> {
// (undocumented)
class?: ClassList | undefined;
}
// @public @deprecated (undocumented)
export type QwikChangeEvent<T = Element> = Event;
// @public @deprecated (undocumented)
export type QwikClipboardEvent<T = Element> = NativeClipboardEvent;
// @public @deprecated (undocumented)
export type QwikCompositionEvent<T = Element> = NativeCompositionEvent;
// @public (undocumented)
export interface QwikDOMAttributes extends DOMAttributes<Element> {
}
// @public @deprecated (undocumented)
export type QwikDragEvent<T = Element> = NativeDragEvent;
// @public @deprecated (undocumented)
export type QwikFocusEvent<T = Element> = NativeFocusEvent;
// @public
export type QwikHTMLElements = {
[tag in keyof HTMLElementTagNameMap]: Augmented<HTMLElementTagNameMap[tag], SpecialAttrs[tag]> & HTMLElementAttrs & QwikAttributes<HTMLElementTagNameMap[tag]>;
};
// @public
export type QwikIdleEvent = CustomEvent<{}>;
// @public
export type QwikInitEvent = CustomEvent<{}>;
// @public
export interface QwikIntrinsicElements extends QwikHTMLElements, QwikSVGElements {
}
// @public @deprecated (undocumented)
export type QwikInvalidEvent<T = Element> = Event;
// @public (undocumented)
export namespace QwikJSX {
// (undocumented)
export type Element = JSXOutput;
// (undocumented)
export interface ElementChildrenAttribute {
// (undocumented)
children: JSXChildren;
}
// (undocumented)
export type ElementType = string | FunctionComponent<Record<any, any>>;
// Warning: (ae-forgotten-export) The symbol "QwikIntrinsicAttributes" needs to be exported by the entry point index.d.ts
//
// (undocumented)
export interface IntrinsicAttributes extends QwikIntrinsicAttributes {
}
// Warning: (ae-forgotten-export) The symbol "LenientQwikElements" needs to be exported by the entry point index.d.ts
//
// (undocumented)
export interface IntrinsicElements extends LenientQwikElements {
}
}
// @public @deprecated (undocumented)
export type QwikKeyboardEvent<T = Element> = NativeKeyboardEvent;
// @public @deprecated (undocumented)
export type QwikMouseEvent<T = Element, E = NativeMouseEvent> = E;
// @public @deprecated (undocumented)
export type QwikPointerEvent<T = Element> = NativePointerEvent;
// @public @deprecated (undocumented)
export type QwikSubmitEvent<T = Element> = SubmitEvent;
// @public
export type QwikSVGElements = {
[K in keyof Omit<SVGElementTagNameMap, keyof HTMLElementTagNameMap>]: SVGProps<SVGElementTagNameMap[K]>;
};
// @public
export type QwikSymbolEvent = CustomEvent<{
symbol: string;
element: Element;
reqTime: number;
}>;
// @public @deprecated (undocumented)
export type QwikTouchEvent<T = Element> = NativeTouchEvent;
// @public @deprecated (undocumented)
export type QwikTransitionEvent<T = Element> = NativeTransitionEvent;
// @public @deprecated (undocumented)
export type QwikUIEvent<T = Element> = NativeUIEvent;
// @public
export type QwikVisibleEvent = CustomEvent<IntersectionObserverEntry>;
// @public @deprecated (undocumented)
export type QwikWheelEvent<T = Element> = NativeWheelEvent;
// @public (undocumented)
export type ReadonlySignal<T = unknown> = Readonly<Signal<T>>;
// @internal (undocumented)
export const _regSymbol: (symbol: any, hash: string) => any;
// @public
export const render: (parent: Element | Document, jsxNode: JSXOutput | FunctionComponent<any>, opts?: RenderOptions) => Promise<RenderResult>;
// @public (undocumented)
export const RenderOnce: FunctionComponent<{
children?: unknown;
key?: string | number | null | undefined;
}>;
// @public (undocumented)
export interface RenderOptions {
// (undocumented)
serverData?: Record<string, any>;
}
// @public (undocumented)
export interface RenderResult {
// (undocumented)
cleanup(): void;
}
// @internal (undocumented)
export const _renderSSR: (node: JSXOutput, opts: RenderSSROptions) => Promise<void>;
// @public (undocumented)
export interface RenderSSROptions {
// (undocumented)
base?: string;
// (undocumented)
beforeClose?: (contexts: QContext[], containerState: ContainerState, containsDynamic: boolean, textNodes: Map<string, string>) => Promise<JSXNode>;
// (undocumented)
beforeContent?: JSXNode<string>[];
// (undocumented)
containerAttributes: Record<string, string>;
// (undocumented)
containerTagName: string;
// (undocumented)
manifestHash: string;
// (undocumented)
serverData?: Record<string, any>;
// (undocumented)
stream: StreamWriter;
}
// @public
export const Resource: <T>(props: ResourceProps<T>) => JSXOutput;
// @public (undocumented)
export interface ResourceCtx<T> {
// (undocumented)
cache(policyOrMilliseconds: number | 'immutable'): void;
// (undocumented)
cleanup(callback: () => void): void;
// (undocumented)
readonly previous: T | undefined;
// (undocumented)
readonly track: Tracker;
}
// @public (undocumented)
export type ResourceFn<T> = (ctx: ResourceCtx<unknown>) => ValueOrPromise<T>;
// @public
export interface ResourceOptions {
timeout?: number;
}
// @public (undocumented)
export interface ResourcePending<T> {
// (undocumented)
readonly loading: boolean;
// (undocumented)
readonly value: Promise<T>;
}
// @public (undocumented)
export interface ResourceProps<T> {
// (undocumented)
onPending?: () => JSXOutput;
// (undocumented)
onRejected?: (reason: Error) => JSXOutput;
// (undocumented)
onResolved: (value: T) => JSXOutput;
// (undocumented)
readonly value: ResourceReturn<T> | Signal<Promise<T> | T> | Promise<T>;
}
// @public (undocumented)
export interface ResourceRejected<T> {
// (undocumented)
readonly loading: boolean;
// (undocumented)
readonly value: Promise<T>;
}
// @public (undocumented)
export interface ResourceResolved<T> {
// (undocumented)
readonly loading: boolean;
// (undocumented)
readonly value: Promise<T>;
}
// @public (undocumented)
export type ResourceReturn<T> = ResourcePending<T> | ResourceResolved<T> | ResourceRejected<T>;
// @internal (undocumented)
export const _restProps: (props: Record<string, any>, omit: string[], target?: {}) => {};
// @public (undocumented)
export interface ScriptHTMLAttributes<T extends Element> extends Attrs<'script', T> {
}
// @public (undocumented)
export interface SelectHTMLAttributes<T extends Element> extends Attrs<'select', T> {
}
// @internal (undocumented)
export const _serializeData: (data: any, pureQRL?: boolean) => Promise<string>;
// @public
export const setPlatform: (plt: CorePlatform) => CorePlatform;
// Warning: (ae-forgotten-export) The symbol "Container2" needs to be exported by the entry point index.d.ts
//
// @internal (undocumented)
export abstract class _SharedContainer implements Container2 {
// (undocumented)
abstract $appendStyle$(content: string, styleId: string, host: HostElement, scoped: boolean): void;
// (undocumented)
$currentUniqueId$: number;
// (undocumented)
readonly $getObjectById$: (id: number | string) => any;
// (undocumented)
readonly $locale$: string;
// Warning: (ae-forgotten-export) The symbol "ObjToProxyMap" needs to be exported by the entry point index.d.ts
//
// (undocumented)
readonly $proxyMap$: ObjToProxyMap;
// Warning: (ae-forgotten-export) The symbol "Scheduler" needs to be exported by the entry point index.d.ts
//
// (undocumented)
readonly $scheduler$: Scheduler;
// (undocumented)
$serverData$: Record<string, any>;
// Warning: (ae-forgotten-export) The symbol "SubscriptionManager" needs to be exported by the entry point index.d.ts
//
// (undocumented)
readonly $subsManager$: SubscriptionManager;
// (undocumented)
readonly $version$: string;
constructor(scheduleDrain: () => void, journalFlush: () => void, serverData: Record<string, any>, locale: string);
// Warning: (ae-forgotten-export) The symbol "HostElement" needs to be exported by the entry point index.d.ts
//
// (undocumented)
abstract ensureProjectionResolved(host: HostElement): void;
// (undocumented)
abstract getHostProp<T>(host: HostElement, name: string): T | null;
// (undocumented)
abstract getParentHost(host: HostElement): HostElement | null;
// (undocumented)
abstract handleError(err: any, $host$: HostElement): void;
// (undocumented)
abstract processJsx(host: HostElement, jsx: JSXOutput): ValueOrPromise<void>;
// (undocumented)
abstract resolveContext<T>(host: HostElement, contextId: ContextId<T>): T | undefined;
// Warning: (ae-forgotten-export) The symbol "SerializationContext" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "SymbolToChunkResolver" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "StreamWriter_3" needs to be exported by the entry point index.d.ts
//
// (undocumented)
serializationCtxFactory(NodeConstructor: SerializationContext['$NodeConstructor$'] | null, symbolToChunkResolver: SymbolToChunkResolver, writer?: StreamWriter_3): SerializationContext;
// (undocumented)
abstract setContext<T>(host: HostElement, context: ContextId<T>, value: T): void;
// (undocumented)
abstract setHostProp<T>(host: HostElement, name: string, value: T): void;
// Warning: (ae-forgotten-export) The symbol "Subscriber" needs to be exported by the entry point index.d.ts
//
// (undocumented)
trackSignalValue<T>(signal: Signal, sub: Subscriber): T;
}
// @public (undocumented)
export interface Signal<T = any> {
// (undocumented)
value: T;
}
// @public (undocumented)
export type Size = number | string;
// @public (undocumented)
export const SkipRender: JSXNode;
// @public
export const Slot: FunctionComponent<{
name?: string;
children?: JSXChildren;
}>;
// @public (undocumented)
export interface SlotHTMLAttributes<T extends Element> extends Attrs<'slot', T> {
}
// @public (undocumented)
export interface SnapshotListener {
// (undocumented)
el: Element;
// (undocumented)
key: string;
// (undocumented)
qrl: QRL<any>;
}
// @public (undocumented)
export type SnapshotMeta = Record<string, SnapshotMetaValue>;
// @public (undocumented)
export interface SnapshotMetaValue {
// (undocumented)
c?: string;
// (undocumented)
h?: string;
// (undocumented)
s?: string;
// (undocumented)
w?: string;
}
// @public (undocumented)
export interface SnapshotResult {
// (undocumented)
funcs: string[];
// (undocumented)
mode: 'render' | 'listeners' | 'static';
// @deprecated (undocumented)
objs?: any[];
// (undocumented)
qrls: QRL[];
// Warning: (ae-forgotten-export) The symbol "ResourceReturnInternal" needs to be exported by the entry point index.d.ts
//
// (undocumented)
resources: ResourceReturnInternal<any>[];
// @deprecated (undocumented)
state?: SnapshotState;
}
// @public @deprecated (undocumented)
export interface SnapshotState {
// (undocumented)
ctx: SnapshotMeta;
// (undocumented)
objs: any[];
// (undocumented)
refs: Record<string, string>;
// (undocumented)
subs: any[];
}
// @public (undocumented)
export interface SourceHTMLAttributes<T extends Element> extends Attrs<'source', T> {
}
// @public (undocumented)
export const SSRComment: FunctionComponent<{
data: string;
}>;
// @public @deprecated (undocumented)
export const SSRHint: FunctionComponent<SSRHintProps>;
// @public (undocumented)
export type SSRHintProps = {
dynamic?: boolean;
};
// @public (undocumented)
export const SSRRaw: FunctionComponent<{
data: string;
}>;
// @public (undocumented)
export const SSRStream: FunctionComponent<SSRStreamProps>;
// @public (undocumented)
export const SSRStreamBlock: FunctionComponent<{
children?: any;
}>;
// @public (undocumented)
export type SSRStreamProps = {
children: AsyncGenerator<JSXChildren, void, any> | ((stream: StreamWriter) => Promise<void>) | (() => AsyncGenerator<JSXChildren, void, any>);
};
// @public (undocumented)
export type StreamWriter = {
write: (chunk: string) => void;
};
// @public (undocumented)
export interface StyleHTMLAttributes<T extends Element> extends Attrs<'style', T> {
}
// Warning: (ae-internal-missing-underscore) The name "SubscriptionType" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export const enum SubscriptionType {
// (undocumented)
HOST = 0,
// (undocumented)
PROP_IMMUTABLE = 1,
// (undocumented)
PROP_MUTABLE = 2,
// (undocumented)
TEXT_IMMUTABLE = 3,
// (undocumented)
TEXT_MUTABLE = 4
}
// @public
export interface SVGAttributes<T extends Element = Element> extends AriaAttributes {
// (undocumented)
'accent-height'?: number | string | undefined;
// (undocumented)
'alignment-baseline'?: 'auto' | 'baseline' | 'before-edge' | 'text-before-edge' | 'middle' | 'central' | 'after-edge' | 'text-after-edge' | 'ideographic' | 'alphabetic' | 'hanging' | 'mathematical' | 'inherit' | undefined;
// (undocumented)
'arabic-form'?: 'initial' | 'medial' | 'terminal' | 'isolated' | undefined;
// (undocumented)
'baseline-shift'?: number | string | undefined;
// (undocumented)
'cap-height'?: number | string | undefined;
// (undocumented)
'clip-path'?: string | undefined;
// (undocumented)
'clip-rule'?: number | string | undefined;
// (undocumented)
'color-interpolation'?: number | string | undefined;
// (undocumented)
'color-interpolation-filters'?: 'auto' | 's-rGB' | 'linear-rGB' | 'inherit' | undefined;
// (undocumented)
'color-profile'?: number | string | undefined;
// (undocumented)
'color-rendering'?: number | string | undefined;
// (undocumented)
'dominant-baseline'?: number | string | undefined;
// (undocumented)
'edge-mode'?: number | string | undefined;
// (undocumented)
'enable-background'?: number | string | undefined;
// (undocumented)
'fill-opacity'?: number | string | undefined;
// (undocumented)
'fill-rule'?: 'nonzero' | 'evenodd' | 'inherit' | undefined;
// (undocumented)
'flood-color'?: number | string | undefined;
// (undocumented)
'flood-opacity'?: number | string | undefined;
// (undocumented)
'font-family'?: string | undefined;
// (undocumented)
'font-size'?: number | string | undefined;
// (undocumented)
'font-size-adjust'?: number | string | undefined;
// (undocumented)
'font-stretch'?: number | string | undefined;
// (undocumented)
'font-style'?: number | string | undefined;
// (undocumented)
'font-variant'?: number | string | undefined;
// (undocumented)
'font-weight'?: number | string | undefined;
// (undocumented)
'glyph-name'?: number | string | undefined;
// (undocumented)
'glyph-orientation-horizontal'?: number | string | undefined;
// (undocumented)
'glyph-orientation-vertical'?: number | string | undefined;
// (undocumented)
'horiz-adv-x'?: number | string | undefined;
// (undocumented)
'horiz-origin-x'?: number | string | undefined;
// (undocumented)
'image-rendering'?: number | string | undefined;
// (undocumented)
'letter-spacing'?: number | string | undefined;
// (undocumented)
'lighting-color'?: number | string | undefined;
// (undocumented)
'marker-end'?: string | undefined;
// (undocumented)
'marker-mid'?: string | undefined;
// (undocumented)
'marker-start'?: string | undefined;
// (undocumented)
'overline-position'?: number | string | undefined;
// (undocumented)
'overline-thickness'?: number | string | undefined;
// (undocumented)
'paint-order'?: number | string | undefined;
// (undocumented)
'pointer-events'?: number | string | undefined;
// (undocumented)
'rendering-intent'?: number | string | undefined;
// (undocumented)
'shape-rendering'?: number | string | undefined;
// (undocumented)
'stop-color'?: string | undefined;
// (undocumented)
'stop-opacity'?: number | string | undefined;
// (undocumented)
'strikethrough-position'?: number | string | undefined;
// (undocumented)
'strikethrough-thickness'?: number | string | undefined;
// (undocumented)
'stroke-dasharray'?: string | number | undefined;
// (undocumented)
'stroke-dashoffset'?: string | number | undefined;
// (undocumented)
'stroke-linecap'?: 'butt' | 'round' | 'square' | 'inherit' | undefined;
// (undocumented)
'stroke-linejoin'?: 'miter' | 'round' | 'bevel' | 'inherit' | undefined;
// (undocumented)
'stroke-miterlimit'?: string | undefined;
// (undocumented)
'stroke-opacity'?: number | string | undefined;
// (undocumented)
'stroke-width'?: number | string | undefined;
// (undocumented)
'text-anchor'?: string | undefined;
// (undocumented)
'text-decoration'?: number | string | undefined;
// (undocumented)
'text-rendering'?: number | string | undefined;
// (undocumented)
'underline-position'?: number | string | undefined;
// (undocumented)
'underline-thickness'?: number | string | undefined;
// (undocumented)
'unicode-bidi'?: number | string | undefined;
// (undocumented)
'unicode-range'?: number | string | undefined;
// (undocumented)
'units-per-em'?: number | string | undefined;
// (undocumented)
'v-alphabetic'?: number | string | undefined;
// (undocumented)
'v-hanging'?: number | string | undefined;
// (undocumented)
'v-ideographic'?: number | string | undefined;
// (undocumented)
'v-mathematical'?: number | string | undefined;
// (undocumented)
'vector-effect'?: number | string | undefined;
// (undocumented)
'vert-adv-y'?: number | string | undefined;
// (undocumented)
'vert-origin-x'?: number | string | undefined;
// (undocumented)
'vert-origin-y'?: number | string | undefined;
// (undocumented)
'word-spacing'?: number | string | undefined;
// (undocumented)
'writing-mode'?: number | string | undefined;
// (undocumented)
'x-channel-selector'?: string | undefined;
// (undocumented)
'x-height'?: number | string | undefined;
// (undocumented)
'xlink:actuate'?: string | undefined;
// (undocumented)
'xlink:arcrole'?: string | undefined;
// (undocumented)
'xlink:href'?: string | undefined;
// (undocumented)
'xlink:role'?: string | undefined;
// (undocumented)
'xlink:show'?: string | undefined;
// (undocumented)
'xlink:title'?: string | undefined;
// (undocumented)
'xlink:type'?: string | undefined;
// (undocumented)
'xml:base'?: string | undefined;
// (undocumented)
'xml:lang'?: string | undefined;
// (undocumented)
'xml:space'?: string | undefined;
// (undocumented)
'xmlns:xlink'?: string | undefined;
// (undocumented)
accumulate?: 'none' | 'sum' | undefined;
// (undocumented)
additive?: 'replace' | 'sum' | undefined;
// (undocumented)
allowReorder?: 'no' | 'yes' | undefined;
// (undocumented)
alphabetic?: number | string | undefined;
// (undocumented)
amplitude?: number | string | undefined;
// (undocumented)
ascent?: number | string | undefined;
// (undocumented)
attributeName?: string | undefined;
// (undocumented)
attributeType?: string | undefined;
// (undocumented)
autoReverse?: Booleanish | undefined;
// (undocumented)
azimuth?: number | string | undefined;
// (undocumented)
baseFrequency?: number | string | undefined;
// (undocumented)
baseProfile?: number | string | undefined;
// (undocumented)
bbox?: number | string | undefined;
// (undocumented)
begin?: number | string | undefined;
// (undocumented)
bias?: number | string | undefined;
// (undocumented)
by?: number | string | undefined;
// (undocumented)
calcMode?: number | string | undefined;
// (undocumented)
clip?: number | string | undefined;
// (undocumented)
clipPathUnits?: number | string | undefined;
// (undocumented)
color?: string | undefined;
// (undocumented)
contentScriptType?: number | string | undefined;
// (undocumented)
contentStyleType?: number | string | undefined;
// (undocumented)
crossOrigin?: HTMLCrossOriginAttribute;
// (undocumented)
cursor?: number | string;
// (undocumented)
cx?: number | string | undefined;
// (undocumented)
cy?: number | string | undefined;
// (undocumented)
d?: string | undefined;
// (undocumented)
decelerate?: number | string | undefined;
// (undocumented)
descent?: number | string | undefined;
// (undocumented)
diffuseConstant?: number | string | undefined;
// (undocumented)
direction?: number | string | undefined;
// (undocumented)
display?: number | string | undefined;
// (undocumented)
divisor?: number | string | undefined;
// (undocumented)
dur?: number | string | undefined;
// (undocumented)
dx?: number | string | undefined;
// (undocumented)
dy?: number | string | undefined;
// (undocumented)
elevation?: number | string | undefined;
// (undocumented)
end?: number | string | undefined;
// (undocumented)
exponent?: number | string | undefined;
// (undocumented)
externalResourcesRequired?: number | string | undefined;
// (undocumented)
fill?: string | undefined;
// (undocumented)
filter?: string | undefined;
// (undocumented)
filterRes?: number | string | undefined;
// (undocumented)
filterUnits?: number | string | undefined;
// (undocumented)
focusable?: number | string | undefined;
// (undocumented)
format?: number | string | undefined;
// (undocumented)
fr?: number | string | undefined;
// (undocumented)
from?: number | string | undefined;
// (undocumented)
fx?: number | string | undefined;
// (undocumented)
fy?: number | string | undefined;
// (undocumented)
g1?: number | string | undefined;
// (undocumented)
g2?: number | string | undefined;
// (undocumented)
glyphRef?: number | string | undefined;
// (undocumented)
gradientTransform?: string | undefined;
// (undocumented)
gradientUnits?: string | undefined;
// (undocumented)
hanging?: number | string | undefined;
// (undocumented)
height?: Size | undefined;
// (undocumented)
href?: string | undefined;
// (undocumented)
id?: string | undefined;
// (undocumented)
ideographic?: number | string | undefined;
// (undocumented)
in?: string | undefined;
// (undocumented)
in2?: number | string | undefined;
// (undocumented)
intercept?: number | string | undefined;
// (undocumented)
k?: number | string | undefined;
// (undocumented)
k1?: number | string | undefined;
// (undocumented)
k2?: number | string | undefined;
// (undocumented)
k3?: number | string | undefined;
// (undocumented)
k4?: number | string | undefined;
// (undocumented)
kernelMatrix?: number | string | undefined;
// (undocumented)
kernelUnitLength?: number | string | undefined;
// (undocumented)
kerning?: number | string | undefined;
// (undocumented)
keyPoints?: number | string | undefined;
// (undocumented)
keySplines?: number | string | undefined;
// (undocumented)
keyTimes?: number | string | undefined;
// (undocumented)
lang?: string | undefined;
// (undocumented)
lengthAdjust?: number | string | undefined;
// (undocumented)
limitingConeAngle?: number | string | undefined;
// (undocumented)
local?: number | string | undefined;
// (undocumented)
markerHeight?: number | string | undefined;
// (undocumented)
markerUnits?: number | string | undefined;
// (undocumented)
markerWidth?: number | string | undefined;
// (undocumented)
mask?: string | undefined;
// (undocumented)
maskContentUnits?: number | string | undefined;
// (undocumented)
maskUnits?: number | string | undefined;
// (undocumented)
mathematical?: number | string | undefined;
// (undocumented)
max?: number | string | undefined;
// (undocumented)
media?: string | undefined;
// (undocumented)
method?: string | undefined;
// (undocumented)
min?: number | string | undefined;
// (undocumented)
mode?: number | string | undefined;
// (undocumented)
name?: string | undefined;
// (undocumented)
numOctaves?: number | string | undefined;
// (undocumented)
offset?: number | string | undefined;
// (undocumented)
opacity?: number | string | undefined;
// (undocumented)
operator?: number | string | undefined;
// (undocumented)
order?: number | string | undefined;
// (undocumented)
orient?: number | string | undefined;
// (undocumented)
orientation?: number | string | undefined;
// (undocumented)
origin?: number | string | undefined;
// (undocumented)
overflow?: number | string | undefined;
// (undocumented)
panose1?: number | string | undefined;
// (undocumented)
path?: string | undefined;
// (undocumented)
pathLength?: number | string | undefined;
// (undocumented)
patternContentUnits?: string | undefined;
// (undocumented)
patternTransform?: number | string | undefined;
// (undocumented)
patternUnits?: string | undefined;
// (undocumented)
points?: string | undefined;
// (undocumented)
pointsAtX?: number | string | undefined;
// (undocumented)
pointsAtY?: number | string | undefined;
// (undocumented)
pointsAtZ?: number | string | undefined;
// (undocumented)
preserveAlpha?: number | string | undefined;
// (undocumented)
preserveAspectRatio?: string | undefined;
// (undocumented)
primitiveUnits?: number | string | undefined;
// (undocumented)
r?: number | string | undefined;
// (undocumented)
radius?: number | string | undefined;
// (undocumented)
refX?: number | string | undefined;
// (undocumented)
refY?: number | string | undefined;
// (undocumented)
repeatCount?: number | string | undefined;
// (undocumented)
repeatDur?: number | string | undefined;
// (undocumented)
requiredextensions?: number | string | undefined;
// (undocumented)
requiredFeatures?: number | string | undefined;
// (undocumented)
restart?: number | string | undefined;
// (undocumented)
result?: string | undefined;
// (undocumented)
role?: string | undefined;
// (undocumented)
rotate?: number | string | undefined;
// (undocumented)
rx?: number | string | undefined;
// (undocumented)
ry?: number | string | undefined;
// (undocumented)
scale?: number | string | undefined;
// (undocumented)
seed?: number | string | undefined;
// (undocumented)
slope?: number | string | undefined;
// (undocumented)
spacing?: number | string | undefined;
// (undocumented)
specularConstant?: number | string | undefined;
// (undocumented)
specularExponent?: number | string | undefined;
// (undocumented)
speed?: number | string | undefined;
// (undocumented)
spreadMethod?: string | undefined;
// (undocumented)
startOffset?: number | string | undefined;
// (undocumented)
stdDeviation?: number | string | undefined;
// (undocumented)
stemh?: number | string | undefined;
// (undocumented)
stemv?: number | string | undefined;
// (undocumented)
stitchTiles?: number | string | undefined;
// (undocumented)
string?: number | string | undefined;
// (undocumented)
stroke?: string | undefined;
// (undocumented)
style?: CSSProperties | string | undefined;
// (undocumented)
surfaceScale?: number | string | undefined;
// (undocumented)
systemLanguage?: number | string | undefined;
// (undocumented)
tabindex?: number | undefined;
// (undocumented)
tableValues?: number | string | undefined;
// (undocumented)
target?: string | undefined;
// (undocumented)
targetX?: number | string | undefined;
// (undocumented)
targetY?: number | string | undefined;
// (undocumented)
textLength?: number | string | undefined;
// (undocumented)
to?: number | string | undefined;
// (undocumented)
transform?: string | undefined;
// (undocumented)
type?: string | undefined;
// (undocumented)
u1?: number | string | undefined;
// (undocumented)
u2?: number | string | undefined;
// (undocumented)
unicode?: number | string | undefined;
// (undocumented)
values?: string | undefined;
// (undocumented)
version?: string | undefined;
// (undocumented)
viewBox?: string | undefined;
// (undocumented)
viewTarget?: number | string | undefined;
// (undocumented)
visibility?: number | string | undefined;
// (undocumented)
width?: Size | undefined;
// (undocumented)
widths?: number | string | undefined;
// (undocumented)
x?: number | string | undefined;
// (undocumented)
x1?: number | string | undefined;
// (undocumented)
x2?: number | string | undefined;
// (undocumented)
xmlns?: string | undefined;
// (undocumented)
y?: number | string | undefined;
// (undocumented)
y1?: number | string | undefined;
// (undocumented)
y2?: number | string | undefined;
// (undocumented)
yChannelSelector?: string | undefined;
// (undocumented)
z?: number | string | undefined;
// (undocumented)
zoomAndPan?: string | undefined;
}
// @public (undocumented)
export interface SVGProps<T extends Element> extends SVGAttributes, QwikAttributes<T> {
}
// @alpha
export const sync$: <T extends Function>(fn: T) => SyncQRL<T>;
// @public (undocumented)
export interface TableHTMLAttributes<T extends Element> extends Attrs<'table', T> {
}
// @public (undocumented)
export interface TaskCtx {
// (undocumented)
cleanup(callback: () => void): void;
// (undocumented)
track: Tracker;
}
// @public (undocumented)
export type TaskFn = (ctx: TaskCtx) => ValueOrPromise<void | (() => void)>;
// @public (undocumented)
export interface TdHTMLAttributes<T extends Element> extends Attrs<'td', T> {
}
// @public (undocumented)
export interface TextareaHTMLAttributes<T extends Element> extends Attrs<'textarea', T> {
}
// @public (undocumented)
export interface ThHTMLAttributes<T extends Element> extends Attrs<'tr', T> {
}
// @public (undocumented)
export interface TimeHTMLAttributes<T extends Element> extends Attrs<'time', T> {
}
// @public (undocumented)
export interface TitleHTMLAttributes<T extends Element> extends Attrs<'title', T> {
}
// @public
export interface Tracker {
<T>(fn: () => T): T;
<T extends object>(obj: T): T extends Signal<infer U> ? U : T;
<T extends object, P extends keyof T>(obj: T, prop: P): T[P];
}
// @public (undocumented)
export interface TrackHTMLAttributes<T extends Element> extends Attrs<'track', T> {
}
// @public
export const untrack: <T>(fn: () => T) => T;
// Warning: (ae-forgotten-export) The symbol "Computed" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const useComputed$: Computed;
// Warning: (ae-forgotten-export) The symbol "ComputedQRL" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const useComputedQrl: ComputedQRL;
// Warning: (ae-forgotten-export) The symbol "UseContext" needs to be exported by the entry point index.d.ts
//
// @public
export const useContext: UseContext;
// @public
export const useContextProvider: <STATE>(context: ContextId<STATE>, newValue: STATE) => void;
// @public (undocumented)
export const useErrorBoundary: () => Readonly<ErrorBoundaryStore>;
// @public (undocumented)
export const useId: () => string;
// Warning: (ae-internal-missing-underscore) The name "useLexicalScope" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export const useLexicalScope: <VARS extends any[]>() => VARS;
// Warning: (ae-forgotten-export) The symbol "EventQRL" needs to be exported by the entry point index.d.ts
//
// @public
export const useOn: <T extends KnownEventNames>(event: T | T[], eventQrl: EventQRL<T>) => void;
// @public
export const useOnDocument: <T extends KnownEventNames>(event: T | T[], eventQrl: EventQRL<T>) => void;
// @public
export const useOnWindow: <T extends KnownEventNames>(event: T | T[], eventQrl: EventQRL<T>) => void;
// @public
export const useResource$: <T>(generatorFn: ResourceFn<T>, opts?: ResourceOptions) => ResourceReturn<T>;
// @public
export const useResourceQrl: <T>(qrl: QRL<ResourceFn<T>>, opts?: ResourceOptions) => ResourceReturn<T>;
// @public (undocumented)
export function useServerData<T>(key: string): T | undefined;
// @public (undocumented)
export function useServerData<T, B = T>(key: string, defaultValue: B): T | B;
// @public (undocumented)
export interface UseSignal {
// (undocumented)
<T>(): Signal<T | undefined>;
// (undocumented)
<T>(value: T | (() => T)): Signal<T>;
}
// @public (undocumented)
export const useSignal: UseSignal;
// @public
export const useStore: <STATE extends object>(initialState: STATE | (() => STATE), opts?: UseStoreOptions) => STATE;
// @public (undocumented)
export interface UseStoreOptions {
deep?: boolean;
reactive?: boolean;
}
// Warning: (ae-forgotten-export) The symbol "UseStyles" needs to be exported by the entry point index.d.ts
//
// @public
export const useStyles$: (first: string) => UseStyles;
// @public
export const useStylesQrl: (styles: QRL<string>) => UseStyles;
// @public
export const useStylesScoped$: (first: string) => UseStylesScoped;
// @public (undocumented)
export interface UseStylesScoped {
// (undocumented)
scopeId: string;
}
// @public
export const useStylesScopedQrl: (styles: QRL<string>) => UseStylesScoped;
// @public
export const useTask$: (first: TaskFn, opts?: UseTaskOptions | undefined) => void;
// @public (undocumented)
export interface UseTaskOptions {
eagerness?: EagernessOptions;
}
// @public
export const useTaskQrl: (qrl: QRL<TaskFn>, opts?: UseTaskOptions) => void;
// @public
export const useVisibleTask$: (first: TaskFn, opts?: OnVisibleTaskOptions | undefined) => void;
// @public
export const useVisibleTaskQrl: (qrl: QRL<TaskFn>, opts?: OnVisibleTaskOptions) => void;
// @public
export type ValueOrPromise<T> = T | Promise<T>;
// @internal (undocumented)
export const _VAR_PROPS: unique symbol;
// @internal (undocumented)
export const _verifySerializable: <T>(value: T, preMessage?: string) => T;
// @public
export const version: string;
// @public (undocumented)
export interface VideoHTMLAttributes<T extends Element> extends Attrs<'video', T> {
}
// @public (undocumented)
export type VisibleTaskStrategy = 'intersection-observer' | 'document-ready' | 'document-idle';
// @internal (undocumented)
export const _waitUntilRendered: (elm: Element) => Promise<void>;
// Warning: (ae-forgotten-export) The symbol "SSRContainer" needs to be exported by the entry point index.d.ts
//
// @internal (undocumented)
export function _walkJSX(ssr: SSRContainer, value: JSXOutput, allowPromises: true, currentStyleScoped: string | null): ValueOrPromise<void>;
// @internal (undocumented)
export function _walkJSX(ssr: SSRContainer, value: JSXOutput, allowPromises: false, currentStyleScoped: string | null): false;
// @internal (undocumented)
export const _weakSerialize: <T extends object>(input: T) => Partial<T>;
// @public @deprecated (undocumented)
export interface WebViewHTMLAttributes<T extends Element> extends HTMLAttributes<T> {
// (undocumented)
allowFullScreen?: boolean | undefined;
// (undocumented)
allowpopups?: boolean | undefined;
// (undocumented)
autoFocus?: boolean | undefined;
// (undocumented)
autosize?: boolean | undefined;
// (undocumented)
blinkfeatures?: string | undefined;
// (undocumented)
disableblinkfeatures?: string | undefined;
// (undocumented)
disableguestresize?: boolean | undefined;
// (undocumented)
disablewebsecurity?: boolean | undefined;
// (undocumented)
guestinstance?: string | undefined;
// (undocumented)
httpreferrer?: string | undefined;
// (undocumented)
nodeintegration?: boolean | undefined;
// (undocumented)
partition?: string | undefined;
// (undocumented)
plugins?: boolean | undefined;
// (undocumented)
preload?: string | undefined;
// (undocumented)
src?: string | undefined;
// (undocumented)
useragent?: string | undefined;
// (undocumented)
webpreferences?: string | undefined;
}
// Warning: (ae-internal-missing-underscore) The name "withLocale" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export function withLocale<T>(locale: string, fn: () => T): T;
// @internal (undocumented)
export const _wrapProp: <T extends Record<any, any>, P extends keyof T>(obj: T, prop: P) => any;
// (No @packageDocumentation comment for this package)