api #

Renders the alert as a <button> when provided.

Button attributes, applied only when onclick renders the alert as a <button>.

Div attributes, applied only when the alert renders as a <div> (no onclick).

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.

The modules to display.

The current search query for highlighting.

focus options forwarded to element.focus(); defaults to {focusVisible: true} to show focus indicators on programmatic focus

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.

Content of the root link. Defaults to the site_context icon rendered as an Svg, then the site_context glyph, then •.

Renders the card as an <a> when provided.

Anchor attributes, applied only when href renders the card as an <a>.

contextmenu parameters or nullish to disable

getter function that returns the current scoped value

the contextmenu state

getter for the open menu element, if any

guard that identifies presses belonging to the gesture that opened the menu

the leaf element from which to open the contextmenu

the client (viewport) X coordinate at which to open the contextmenu, typically the mouse clientX - the menu positions with fixed

the client (viewport) Y coordinate at which to open the contextmenu, typically the mouse clientY - the menu positions with fixed

the contextmenu state

optional configuration for filtering entries and haptic feedback

the contextmenu event

the contextmenu state

the open menu element, if any, so events inside it are ignored

offsets and entry filtering forwarded to contextmenu_open

the contextmenu event

the contextmenu state

the open menu element, if any

guard that identifies presses belonging to the gesture that opened the menu

offsets and entry filtering forwarded to contextmenu_open

the element the menu was opened from

Set when a tap-then-longpress is detected, telling the next contextmenu event handler to let the system contextmenu through.

Records a single-touch touchstart at the given coordinates. Detects a tap-then-longpress when the previous tap happened within bypass_window milliseconds and moved less than bypass_move_tolerance pixels, setting bypassed and returning true. Otherwise records the tap for future detection and returns false.

Consumes a pending bypass, returning true and resetting all state if bypassed was set, otherwise returning false with no effect so tap tracking is preserved.

Clears all tracking state including any pending bypass.

Appends item, publishing a new immutable items.

Removes item if present, publishing a new immutable items. Safe to call from effect teardown - it reads only the non-reactive source array.

The contextmenu state owned by the root.

Guards the menu from the residual events of the gesture that opened it. Owned by the root, which arms it when its gesture detection opens the menu.

Snippet for rendering link entries, or null to disable them.

Snippet for rendering copy text entries, or null to disable them.

Snippet for rendering separator entries, or null to disable them.

The menu element while opened - bound by the roots for their gesture handlers.

The number of pixels to offset from the pointer X position when opened.

The number of pixels to offset from the pointer Y position when opened.

Begins a new gesture on touchstart, clearing stale flags from the previous one.

Arms the touch release guard for the gesture that just opened the menu. Call after a successful open.

Tracks the physical secondary button's release - call from an always-on window mouseup capture listener. The release may never be delivered (the native contextmenu's pointer grab eats it), which is why press_belongs_to_open_gesture never depends on it alone.

Returns true when a press belongs to the gesture that opened the menu rather than being a deliberate response to it: secondary-button presses (their own contextmenu event resolves them), presses during or predating an active touch (synthesized compatibility events), and presses overlapping the secondary button in hardware time - the press's own buttons bitmask shows the secondary button still down at generation time, or its timeStamp predates the release tracked by track_mouseup.

Handles a mousedown that landed on the menu element: when a primary-button press belongs to the opening gesture, its click is blocked from activating the entry that the open offsets placed under the pointer. Non-primary presses never arm the blocker - they produce no click, so an armed blocker would linger and eat the next deliberate click on the menu.

Handles touchend: when the release belongs to the gesture that opened the menu, swallows it (stopping mouse event synthesis) and arms the click blocker, returning true.

Clears gesture state, including any armed click blocker. Call on touchcancel. The secondary release timestamp persists - it mirrors hardware history, not gesture state.

Consumes an armed click blocker, returning true if the click should be swallowed. Call from the menu element's click capture handler.

The contextmenu state. Each root defaults to its own new instance - pass one to control or observe the menu externally.

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 content the root listens over for contextmenu gestures.

The contextmenu state. Each root defaults to its own new instance - pass one to control or observe the menu externally.

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 content the root listens over for contextmenu gestures.

The contextmenu state. Each root defaults to its own new instance - pass one to control or observe the menu externally.

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 content the root listens over for contextmenu gestures.

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.

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

The element the menu was opened from, while opened, else undefined. Resolves the popover host when the menu opens inside a modal <dialog> - see contextmenu_resolve_popover_host. Deliberately not reactive - read it in event handlers and attachments, not in templates.

Whether select_next and select_previous can move the selection - the selected menu has more than one item.

Activates item - expanding submenus, running entries.

for async runs, the activation promise; for sync runs, false when the activation didn't run (disabled) or failed (a throw or {ok: false}), else true

Activates the selected item, or if none is selected, selects the first. Returns false without activating when the selected item has unregistered out from under the selection (e.g. its component unmounted).

Selects item and its ancestor menus, deselecting everything else.

Used by ContextmenuEntry.svelte and custom entry components.

The submenu's untranslated viewport x - the parent menu's left edge.

The submenu's untranslated viewport y.

The submenu's width.

The submenu's height.

The parent menu's width.

The layout's width.

The layout's height.

Defaults to true, ignored if children is provided.

Wraps Svelte's setContext and getContext for better ergonomics. When no value is set in the context, get throws an error and get_maybe returns undefined. If a fallback is provided, the value argument to set is optional and get_maybe is omitted from the type.

Starting values per directive — *wholesale replaces* the library defaults.

• Omitted: uses csp_directive_value_defaults (the curated library defaults).
• Provided: exactly the directives you list, nothing else inherited. Anything not listed is absent from the starting state — including security defaults like default-src: 'none'. To tweak a single directive while keeping the rest, use extend (to append) or overrides (to replace per-key) instead.
• {}: starts blank with no directives.

null is not accepted (top-level or per-key) — omit the option to use library defaults, pass {} to start blank, or use overrides to remove a specific directive.

Per-key undefined is treated as omitted (no-op).

Sources to append per directive, layered left to right. Each entry is a partial map; values append to the result of replace_defaults and prior entries. Values are deduplicated within and across layers.

Only array-typed directives can be extended (boolean directives like upgrade-insecure-requests are excluded by the type). Throws if any entry attempts to extend a directive whose current value is ['none'] — use replace_defaults or overrides to opt into default-deny directives.

Per-key undefined is treated as omitted (no-op) — supports conditional patterns like {'connect-src': is_prod ? [API_URL] : undefined}. Per-key null throws — extend only appends; use overrides: { 'X': null } to remove a directive.

Final-pass per-directive overrides. Replaces the directive value or removes it entirely. Pass null to remove a directive from the output.

Highest precedence — wins over replace_defaults and extend.

Per-key undefined is treated as omitted (no-op) — distinct from null, which removes.

commit times as Unix epoch seconds

UTC date (YYYY-MM-DD) of the final bucket; later timestamps clamp into it

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.

Structured type tree beside type_signature, absent when the flat string is the whole story. Present on variable and type kinds only.

Default value documented via @default; the authoritative initializer (when human-readable) is in type_signature. Present on variable kind only — parameters, props, and members carry their own.

Structured return type beside return_type, absent when the flat string is the whole story. Present on function kind only.

Nested members for classes, interfaces, types, and enums.

External types whose contributions are filtered out of props/members — the attribute bags a component forwards, however the author composed them (intersection, heritage clause, bare or indexed-access reference). On interface/class kinds it records the external reach of the heritage chain, whose contributions members (own-only) never enumerate. Present on component, type, interface, and class kinds.

Whether a component accepts children via props or template usage. Present on component kind only.

Function overload signatures when multiple public overloads exist. Present on function and snippet kinds, and on function/constructor members.

Re-export alias info when this declaration is a renamed re-export.

Other modules that also export this declaration (re-export paths relative to src/lib). Absent when only exported from its defining module. The back-link of those modules' Module.re_exports edges.

Mutation documentation from @mutates tags, mapping parameter names to descriptions.

Svelte reactivity flavor ($state, $state.raw, $derived, $derived.by) when this variable is initialized with a value-producing rune. Present on variable kind only.

Module path of the declaration's defining module. When provided, resolution is scoped to that module's declarations — exact even when names collide across modules. Without it, resolution falls back to the library-wide by-name map.

URL fragment to append, with or without the #.

Link to the library's own deployed docs (url_api_full) instead of a site-local path (url_api). Use when rendering a foreign library on a different site, e.g. an aggregator, so links don't dangle locally.

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.