api #

The library instance to render API docs for. Defaults to getting from library_context.

The tome for the API docs page. Defaults to looking up the 'api' tome.

Whether to show minimal content (just a link to full API docs). Used when the API index is shown on a parent docs page.

The module path parameter from the route (e.g., "lib/Button.svelte").

The library instance to render API docs for. Defaults to getting from library_context.

The tome for the API docs page. Defaults to looking up the 'api' tome.

Prefixed with a slash and relative to the base path.

Prefixed with a slash and relative to the base path. null means none and undefined is detected from the current url.

Sets a custom base path of path and selected_path. Defaults to base from $app/paths.

Contextmenu parameters or nullish to disable

Getter function that returns the current scoped value

the leaf element from which to open the contextmenu

the page X coordinate at which to open the contextmenu, typically the mouse pageX

the page Y coordinate at which to open the contextmenu, typically the mouse pageY

the contextmenu store

optional configuration for filtering entries and haptic feedback

The contextmenu prop is not reactive because that's a rare corner case and it's easier to put the contextmenu directly in the context rather than wrapping with a store or other reactivity. If you need to change the contextmenu prop for some reason, use a {#key contextmenu} block: https://svelte.dev/docs#template-syntax-key

The number of pixels to offset from the pointer X position when opened. Useful to ensure the first menu item is immediately under the pointer.

The number of pixels to offset from the pointer Y position when opened. Useful to ensure the first menu item is immediately under the pointer.

Whether to detect tap-then-longpress to bypass the Fuz contextmenu. This allows access to the system contextmenu by tapping once then rightclicking/long-pressing. Setting to false disables the gesture.

The number of milliseconds between taps to detect a gesture that bypasses the Fuz contextmenu. Used only when bypass_with_tap_then_longpress is true. If the duration is too long, it'll detect more false positives and interrupt normal usage, but too short and some people will have difficulty performing the gesture.

The number of pixels the pointer can be moved between taps to detect a tap-then-longpress. Used only when bypass_with_tap_then_longpress is true.

If true, wraps children with a div and listens to events on it instead of the window.

Snippet for rendering link entries. Set to null to disable automatic link detection. Defaults to link_entry_default which renders ContextmenuLinkEntry.

Snippet for rendering copy text entries. Set to null to disable automatic copy text detection. Defaults to text_entry_default which renders ContextmenuTextEntry.

Snippet for rendering separator entries. Set to null to disable automatic separator rendering. Defaults to separator_entry_default which renders ContextmenuSeparator.

The contextmenu prop is not reactive because that's a rare corner case and it's easier to put the contextmenu directly in the context rather than wrapping with a store or other reactivity. If you need to change the contextmenu prop for some reason, use a {#key contextmenu} block: https://svelte.dev/docs#template-syntax-key

The number of pixels the pointer can be moved without canceling longpress.

The number of milliseconds after a touch starts before opening the Fuz contextmenu.

Whether to detect tap-then-longpress to bypass the Fuz contextmenu. This allows access to the system contextmenu by tapping once then long-pressing. Setting to false disables the gesture.

The number of milliseconds between taps to detect a gesture that bypasses the Fuz contextmenu. Used only when bypass_with_tap_then_longpress is true. If the duration is too long, it'll detect more false positives and interrupt normal usage, but too short and some people will have difficulty performing the gesture.

The number of pixels the pointer can be moved between taps to detect a tap-then-longpress. Used only when bypass_with_tap_then_longpress is true.

The number of pixels to offset from the pointer X position when opened. Useful to ensure the first menu item is immediately under the pointer.

The number of pixels to offset from the pointer Y position when opened. Useful to ensure the first menu item is immediately under the pointer.

If true, wraps children with a div and listens to events on it instead of the window.

Snippet for rendering link entries. Set to null to disable automatic link detection. Defaults to link_entry_default which renders ContextmenuLinkEntry.

Snippet for rendering copy text entries. Set to null to disable automatic copy text detection. Defaults to text_entry_default which renders ContextmenuTextEntry.

Snippet for rendering separator entries. Set to null to disable automatic separator rendering. Defaults to separator_entry_default which renders ContextmenuSeparator.

If an initial layout is provided, control is deferred externally. Otherwise the layout syncs to the page dimensions.

Activates the selected entry, or if none, selects the first.

Used by ContextmenuEntry and custom entry components

Defaults to true, ignored if children is provided.

Override or transform specific directives. Returning null or undefined from a transform function will remove the directive.

Sources to include based on their trust levels.

Override default values for specific directives, merging with value_defaults_base (or replacing if that directive is null in the base).

Base values for directive defaults. Set to null or {} to start with no defaults. Defaults to csp_directive_value_defaults.

Override trust requirements for specific directives, merging with required_trust_defaults_base (or replacing if that directive is null in the base).

Base values for directive trust requirements. Set to null or {} to start with no trust requirements. Defaults to csp_directive_required_trust_defaults.

Module path where this declaration is defined.

GitHub source URL with line number.

API documentation URL.

Generated TypeScript import statement.

Public documentation link (if homepage_url is available).

Display name with generic parameters.

Children are lazily rendered by default, enabling transitions and improving performance, sometimes significantly. Pass true to render children eagerly to gain ctrl+f functionality while trading away the benefits. Consider a <details> element instead of making this component eager.

index 0 is under 1 is under 2 etc -- the topmost dialog is the last in the array

If provided, prevents clicks that would close the dialog from bubbling past any elements matching this selector.

- The string to convert to a fragment

Generate a unique section ID for the current page render. This counter is instance-scoped, ensuring SSR/client consistency.

GitHub path - can be a full URL or a relative path like owner/repo or owner/repo/blob/main/file.ts

Sets both the width and height of the svg. Overridden by the width and height props.

Sets the width of the svg. Overrides size.

Sets the height of the svg. Overrides size.

Shared attributes for both img and svg.

Function that returns callback, params object, or nullish to disable

Called when the element enters or leaves the viewport until disconnected.

Called when the attachment's observer is disconnected, either by the user calling disconnect or the attachment being destroyed.

A value of 1 disconnects after el enters and leaves the viewport one time, similar to 'once' for an event. 0 disables and undefined or a negative number like -1 never disconnects.

Same as the options param to IntersectionObserver

Organization URL (e.g., 'https://github.com/ryanatkn').

All modules as rich Module instances.

All modules sorted alphabetically by path.

All declarations across all modules as a flat array.

Declaration lookup map by name. Provides O(1) lookup.

Look up a declaration by name.

Check if a declaration exists.

Look up a module by its canonical path.

Search declarations by query string with multi-term AND logic.