docs_helpers.svelte.ts view source
string docs_helpers.svelte.ts
Declarations #
9 declarations
DOCS_API_PATH #
DOCS_API_PATH
docs_links_context #
docs_links_context
docs_helpers.svelte.ts view source
{ get: (error_message?: string | undefined) => DocsLinks; get_maybe: () => DocsLinks | undefined; set: (value: DocsLinks) => DocsLinks; } DOCS_PATH #
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" | ... 94 more ... | `/${string}/help/` DOCS_PATH_DEFAULT #
DOCS_PATH_DEFAULT
docs_helpers.svelte.ts view source
"/docs" docs_slugify #
docs_slugify
docs_helpers.svelte.ts view source
(str: string): string Convert a string to a URL-safe fragment identifier, preserving case for API declarations. Only transforms spaces and special characters, keeping valid identifier characters intact. Used for hash anchors in documentation.
str
- The string to convert to a fragment
type
stringreturns
string A URL-safe fragment identifier
DocsLinkInfo #
DocsLinkInfo
docs_helpers.svelte.ts view source
DocsLinkInfo id
type
stringtext
type
stringfragment
type
stringtag
type
DocsLinkTag | undefineddepth
type
numberorder
type
numberparent_id
type
string | undefinedDocsLinks #
DocsLinks
docs_helpers.svelte.ts view source
root_path
type string
readonly
links
type SvelteMap<string, DocsLinkInfo>
readonly
docs_links
fragments_onscreen
type SvelteSet<string>
readonly
constructor
type new (root_path?: string): DocsLinks
root_path
type
string default
DOCS_PATH_DEFAULTadd
type (fragment: string, text: string, pathname: string, tag?: DocsLinkTag | undefined, depth?: number, parent_id?: string | undefined, explicit_id?: string | undefined): string
fragment
type
stringtext
type
stringpathname
type
stringtag?
type
DocsLinkTag | undefinedoptional
depth
type
number default
1parent_id?
type
string | undefinedoptional
explicit_id?
type
string | undefinedoptional
returns
stringremove
type (id: string): void
id
type
stringreturns
voidgenerate_section_id
Generate a unique section ID for the current page render. This counter is instance-scoped, ensuring SSR/client consistency.
type (): string
returns
stringDocsLinkTag #
DocsLinkTag
docs_helpers.svelte.ts view source
DocsLinkTag to_docs_path_info #
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; } path_slug
type
stringpathname
type
stringroot_path
type
string default
DOCS_PATH_DEFAULTreturns
{ path: string; path_is_selected: boolean; path_segment: string | undefined; }