docs_helpers.svelte.ts

Declarations
#

9 declarations

DOCS_API_PATH
#

string import {DOCS_API_PATH} from '@fuzdev/fuz_ui/docs_helpers.svelte.js';

docs_links_context
#

{ get: (error_message?: string | undefined) => DocsLinks; get_maybe: () => DocsLinks | undefined; set: (value: DocsLinks) => DocsLinks; }

import {docs_links_context} from '@fuzdev/fuz_ui/docs_helpers.svelte.js';

DOCS_PATH
#

docs_helpers.svelte.ts view source

"/docs" | "/" | "/about" | "/docs/Alert" | "/docs/Breadcrumb" | "/docs/Breadcrumb/a" | "/docs/Breadcrumb/a/b" | "/docs/Breadcrumb/a/b/c" | "/docs/Breadcrumb/a/b/c/d" | "/docs/Card" | ... 59 more ... | `/${string}${`/docs/api/${string}` & {}}`

type "/docs" | "/" | "/about" | "/docs/Alert" | "/docs/Breadcrumb" | "/docs/Breadcrumb/a" | "/docs/Breadcrumb/a/b" | "/docs/Breadcrumb/a/b/c" | "/docs/Breadcrumb/a/b/c/d" | "/docs/Card" | "/docs/Contextmenu" | "/docs/Details" | "/docs/Dialog" | "/docs/Docs" | "/docs/HueInput" | "/docs/LibraryDetail" | "/docs/LibrarySummary" | "/docs/Library" | "/docs/PendingAnimation" | "/docs/PendingButton" | "/docs/Redirect" | "/docs/Sparkline" | "/docs/Svg" | "/docs/Teleport" | "/docs/ThemeRoot" | "/docs/api" | "/docs/csp" | "/docs/icons" | "/docs/intersect" | "/docs/introduction" | "/docs/logos" | "/docs/theming" | "/docs/vite_plugin_pkg_json" | "/help" | (`${`/docs/api/${string}` & {}}`) | `/${string}/docs` | `/${string}/` | `/${string}/about` | `/${string}/docs/Alert` | `/${string}/docs/Breadcrumb` | `/${string}/docs/Breadcrumb/a` | `/${string}/docs/Breadcrumb/a/b` | `/${string}/docs/Breadcrumb/a/b/c` | `/${string}/docs/Breadcrumb/a/b/c/d` | `/${string}/docs/Card` | `/${string}/docs/Contextmenu` | `/${string}/docs/Details` | `/${string}/docs/Dialog` | `/${string}/docs/Docs` | `/${string}/docs/HueInput` | `/${string}/docs/LibraryDetail` | `/${string}/docs/LibrarySummary` | `/${string}/docs/Library` | `/${string}/docs/PendingAnimation` | `/${string}/docs/PendingButton` | `/${string}/docs/Redirect` | `/${string}/docs/Sparkline` | `/${string}/docs/Svg` | `/${string}/docs/Teleport` | `/${string}/docs/ThemeRoot` | `/${string}/docs/api` | `/${string}/docs/csp` | `/${string}/docs/icons` | `/${string}/docs/intersect` | `/${string}/docs/introduction` | `/${string}/docs/logos` | `/${string}/docs/theming` | `/${string}/docs/vite_plugin_pkg_json` | `/${string}/help` | (`/${string}${`/docs/api/${string}` & {}}`)

import {DOCS_PATH} from '@fuzdev/fuz_ui/docs_helpers.svelte.js';

DOCS_PATH_DEFAULT
#

docs_helpers.svelte.ts view source

"/docs" import {DOCS_PATH_DEFAULT} from '@fuzdev/fuz_ui/docs_helpers.svelte.js';

docs_slugify
#

docs_helpers.svelte.ts view source

(str: string): string import {docs_slugify} from '@fuzdev/fuz_ui/docs_helpers.svelte.js';

Convert a string to a URL-safe fragment identifier, preserving case. Unlike slugify from @fuzdev/fuz_util/path.ts which lowercases, this keeps the original casing so API declarations like AsyncStatus and async_status produce distinct fragment IDs. Used by the Tome documentation system for heading and section anchors.

`str`

the string to convert to a fragment

type string

returns

string

a URL-safe fragment identifier with case preserved

DocsLinkInfo
#

docs_helpers.svelte.ts view source

DocsLinkInfo import type {DocsLinkInfo} from '@fuzdev/fuz_ui/docs_helpers.svelte.js';

`id`

type string

`text`

type string

`fragment`

type string

`tag`

type DocsLinkTag | undefined

`depth`

type number

`order`

type number

`parent_id`

type string | undefined

DocsLinks
#

docs_helpers.svelte.ts view source

import {DocsLinks} from '@fuzdev/fuz_ui/docs_helpers.svelte.js';

`root_path`

type string

readonly

`links`

type SvelteMap<string, DocsLinkInfo>

readonly

`docs_links`

type DocsLinkInfo[]

$derived.by

`fragments_onscreen`

type SvelteSet<string>

readonly

`constructor`

type new (root_path?: string): DocsLinks

`root_path`

type string

default DOCS_PATH_DEFAULT

`add`

type (fragment: string, text: string, pathname: string, tag?: DocsLinkTag | undefined, depth?: number, parent_id?: string | undefined, explicit_id?: string | undefined): string

`fragment`

type string

`text`

type string

`pathname`

type string

`tag?`

type DocsLinkTag

optional

`depth`

type number

default 1

`parent_id?`

type string

optional

`explicit_id?`

type string

optional

returns string

`remove`

type (id: string): void

`id`

type string

returns void

`generate_section_id`

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

type (): string

returns string

DocsLinkTag
#

docs_helpers.svelte.ts view source

DocsLinkTag

type "h2" | "h3" | "h4"

import type {DocsLinkTag} from '@fuzdev/fuz_ui/docs_helpers.svelte.js';

to_docs_path_info
#

docs_helpers.svelte.ts view source

(path_slug: string, pathname: string, root_path?: string): { path: string; path_is_selected: boolean; path_segment: string | undefined; }

import {to_docs_path_info} from '@fuzdev/fuz_ui/docs_helpers.svelte.js';

`path_slug`

type string

`pathname`

type string

`root_path`

type string

default DOCS_PATH_DEFAULT

returns

{ path: string; path_is_selected: boolean; path_segment: string | undefined; }

Depends on
#

context_helpers.ts