@taiga-ui/addon-doc 4.0.1 → 4.2.0

package/fesm2022/taiga-ui-addon-doc-tokens.mjs

@@ -133,6 +133,28 @@ const TUI_DOC_TITLE = tuiCreateToken('');
 const TUI_DOC_TYPE_REFERENCE_HANDLER = tuiCreateToken(null);
 const TUI_DOC_TYPE_REFERENCE_PARSER = tuiCreateToken(tuiTypeReferenceParser);
 
+/**
+ * TODO: delete it in 5.0
+ * Replace the following approach to append query params
+ * ```ts
+ * urlStateHandler = inject(TUI_DOC_URL_STATE_HANDLER);
+ * locationRef = inject(Location);
+ *
+ * this.locationRef.go(this.urlStateHandler(tree));
+ * ```
+ * with this one:
+ * ```ts
+ * router = inject(Router);
+ * activatedRoute = inject(ActivatedRoute);
+ *
+ * void this.router.navigate([], {
+ *     relativeTo: this.activatedRoute,
+ *     queryParams: {sandboxWidth: 300},
+ *     queryParamsHandling: 'merge',
+ * });
+ * ```
+ * It is more robust to the cases when application has base href.
+ */
 const TUI_DOC_URL_STATE_HANDLER = tuiCreateToken(String);
 
 /**

package/fesm2022/taiga-ui-addon-doc-tokens.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"taiga-ui-addon-doc-tokens.mjs","sources":["../../../projects/addon-doc/tokens/code-actions.ts","../../../projects/addon-doc/tokens/code-editor.ts","../../../projects/addon-doc/tokens/default-tabs.ts","../../../projects/addon-doc/tokens/doc-icons.ts","../../../projects/addon-doc/tokens/example-content-processor.ts","../../../projects/addon-doc/tokens/excluded-properties.ts","../../../projects/addon-doc/tokens/i18n.ts","../../../projects/addon-doc/tokens/logo.ts","../../../projects/addon-doc/tokens/page-loaded.ts","../../../projects/addon-doc/tokens/pages.ts","../../../projects/addon-doc/tokens/see-also.ts","../../../projects/addon-doc/tokens/source-code.ts","../../../projects/addon-doc/tokens/title.ts","../../../projects/addon-doc/tokens/type-reference-handler.ts","../../../projects/addon-doc/tokens/url-state-handler.ts","../../../projects/addon-doc/tokens/taiga-ui-addon-doc-tokens.ts"],"sourcesContent":["import type {TuiContext} from '@taiga-ui/cdk/types';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\nimport type {PolymorpheusContent} from '@taiga-ui/polymorpheus';\n\n/**\n * Code actions for the opened tab with code example\n */\nexport const TUI_DOC_CODE_ACTIONS =\n    tuiCreateToken<PolymorpheusContent<TuiContext<string>>>('');\n","import {InjectionToken} from '@angular/core';\nimport type {TuiCodeEditor} from '@taiga-ui/addon-doc/types';\n\n/**\n * Service for opening online IDE e.g. Stackblitz\n */\nexport const TUI_DOC_CODE_EDITOR = new InjectionToken<TuiCodeEditor>(\n    '[TUI_DOC_CODE_EDITOR]',\n);\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * Array of default tab names\n */\nexport const TUI_DOC_DEFAULT_TABS = tuiCreateToken<readonly string[]>([]);\n","import type {Provider} from '@angular/core';\nimport {tuiCreateToken, tuiProvideOptions} from '@taiga-ui/cdk/utils/miscellaneous';\n\nexport interface TuiDocIcons {\n    readonly code: string;\n    readonly light: string;\n    readonly menu: string;\n    readonly dark: string;\n    readonly search: string;\n    readonly copy: string;\n    readonly check: string;\n    readonly link: string;\n}\n\nexport const TUI_DOC_DEFAULT_ICONS: TuiDocIcons = {\n    search: '@tui.search',\n    light: '@tui.sun',\n    dark: '@tui.moon',\n    code: '@tui.code',\n    menu: '@tui.menu',\n    copy: '@tui.copy',\n    check: '@tui.check',\n    link: '@tui.link',\n};\n\nexport const TUI_DOC_ICONS = tuiCreateToken(TUI_DOC_DEFAULT_ICONS);\n\nexport function tuiDocIconsProvider(icons: Partial<TuiDocIcons>): Provider {\n    return tuiProvideOptions(TUI_DOC_ICONS, icons, TUI_DOC_DEFAULT_ICONS);\n}\n","import {tuiTryParseMarkdownCodeBlock} from '@taiga-ui/addon-doc/utils';\nimport type {TuiHandler} from '@taiga-ui/cdk/types';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\nimport {identity} from 'rxjs';\n\n/**\n * Processes content in example\n */\nexport const TUI_DOC_EXAMPLE_CONTENT_PROCESSOR =\n    tuiCreateToken<TuiHandler<Record<string, string>, Record<string, string>>>(identity);\n\n/**\n * Processes markdown in code block\n */\nexport const TUI_DOC_EXAMPLE_MARKDOWN_CODE_PROCESSOR = tuiCreateToken<\n    TuiHandler<string, string[]>\n>(tuiTryParseMarkdownCodeBlock);\n","import type {Provider} from '@angular/core';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * Token to exclude inherited documentation properties\n */\nexport const TUI_DOC_EXCLUDED_PROPERTIES = tuiCreateToken<Set<string>>(new Set([]));\n\nexport function tuiDocExcludeProperties(properties: readonly string[]): Provider {\n    return {provide: TUI_DOC_EXCLUDED_PROPERTIES, useValue: new Set(properties)};\n}\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * TODO: think about reorganization in @taiga-ui/i18n way\n */\n\n/**\n * tui-doc-demo i18n texts\n * Works with a tuple\n */\nexport const TUI_DOC_DEMO_TEXTS = tuiCreateToken<[string, string, string]>([\n    'Dark mode',\n    'Background',\n    'Form value',\n]);\n\n/**\n * tui-doc-documentation i18n texts\n * Works with a tuple\n * [\n * @string word 'argument',\n * @string word 'type',\n * @string 'name and description',\n * @string word 'value'\n * @string message for tooltip about ng-polymorpheus\n * ]\n */\nexport const TUI_DOC_DOCUMENTATION_TEXTS = tuiCreateToken<\n    [string, string, string, string, string]\n>([\n    'Argument',\n    'Type',\n    'Name and description',\n    'Value',\n    'Learn about our dynamic templates from ',\n]);\n\n/**\n * tui-doc-example i18n texts\n * Works with a tuple\n * [\n * @string default tab name,\n * @string link to a sample copied message text,\n * @string link to a sample copied message label\n * ]\n */\nexport const TUI_DOC_EXAMPLE_TEXTS = tuiCreateToken<[string, string, string]>([\n    'Preview',\n    'Link to a sample was successfully copied',\n    'Done',\n]);\n\nexport const TUI_DOC_MENU_TEXT = tuiCreateToken('Menu');\nexport const TUI_DOC_SEARCH_TEXT = tuiCreateToken('Search');\nexport const TUI_DOC_SEE_ALSO_TEXT = tuiCreateToken('See also');\nexport const TUI_DOC_SOURCE_CODE_TEXT = tuiCreateToken('Source code');\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\nimport type {PolymorpheusContent} from '@taiga-ui/polymorpheus';\n\n/**\n * Main logo\n */\nexport const TUI_DOC_LOGO = tuiCreateToken<PolymorpheusContent>('');\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\nimport {defer, of, switchMap, timer} from 'rxjs';\n/**\n * Stream that emits if loading of page is over (for example, to begin scrollIntoView)\n */\nexport const TUI_DOC_PAGE_LOADED = tuiCreateToken(\n    defer(() => timer(200).pipe(switchMap(() => of(true)))),\n);\n","import type {InjectionToken} from '@angular/core';\nimport {inject} from '@angular/core';\nimport type {TuiDocRoutePage, TuiDocRoutePages} from '@taiga-ui/addon-doc/types';\nimport {tuiToFlatMapPages} from '@taiga-ui/addon-doc/utils';\nimport {\n    tuiCreateToken,\n    tuiCreateTokenFromFactory,\n} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * Documentation pages\n */\nexport const TUI_DOC_PAGES = tuiCreateToken<TuiDocRoutePages>([]);\n\nexport const TUI_DOC_MAP_PAGES: InjectionToken<Map<string, TuiDocRoutePage>> =\n    tuiCreateTokenFromFactory(() => tuiToFlatMapPages(inject(TUI_DOC_PAGES)));\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * Array of arrays of related pages\n */\nexport const TUI_DOC_SEE_ALSO = tuiCreateToken<ReadonlyArray<readonly string[]>>([]);\n","import type {TuiDocSourceCodePathOptions} from '@taiga-ui/addon-doc/types';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\nimport type {PolymorpheusContent} from '@taiga-ui/polymorpheus';\n\n/**\n * Source code link\n */\nexport const TUI_DOC_SOURCE_CODE =\n    tuiCreateToken<PolymorpheusContent<TuiDocSourceCodePathOptions>>(null);\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * Page title prefix\n */\nexport const TUI_DOC_TITLE = tuiCreateToken('');\n","import type {TuiDocTypeReferenceParsed} from '@taiga-ui/addon-doc/utils';\nimport {tuiTypeReferenceParser} from '@taiga-ui/addon-doc/utils';\nimport type {TuiHandler, TuiStringHandler} from '@taiga-ui/cdk/types';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\nexport const TUI_DOC_TYPE_REFERENCE_HANDLER = tuiCreateToken<TuiStringHandler<\n    string | null\n> | null>(null);\n\nexport const TUI_DOC_TYPE_REFERENCE_PARSER =\n    tuiCreateToken<TuiHandler<string, TuiDocTypeReferenceParsed>>(tuiTypeReferenceParser);\n","import type {UrlTree} from '@angular/router';\nimport type {TuiStringHandler} from '@taiga-ui/cdk/types';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\nexport const TUI_DOC_URL_STATE_HANDLER =\n    tuiCreateToken<TuiStringHandler<UrlTree>>(String);\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;;;;AAIA;;AAEG;MACU,oBAAoB,GAC7B,cAAc,CAA0C,EAAE;;ACL9D;;AAEG;MACU,mBAAmB,GAAG,IAAI,cAAc,CACjD,uBAAuB;;ACL3B;;AAEG;MACU,oBAAoB,GAAG,cAAc,CAAoB,EAAE;;ACS3D,MAAA,qBAAqB,GAAgB;AAC9C,IAAA,MAAM,EAAE,aAAa;AACrB,IAAA,KAAK,EAAE,UAAU;AACjB,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,KAAK,EAAE,YAAY;AACnB,IAAA,IAAI,EAAE,WAAW;EACnB;MAEW,aAAa,GAAG,cAAc,CAAC,qBAAqB,EAAE;AAE7D,SAAU,mBAAmB,CAAC,KAA2B,EAAA;IAC3D,OAAO,iBAAiB,CAAC,aAAa,EAAE,KAAK,EAAE,qBAAqB,CAAC,CAAC;AAC1E;;ACxBA;;AAEG;MACU,iCAAiC,GAC1C,cAAc,CAA6D,QAAQ,EAAE;AAEzF;;AAEG;MACU,uCAAuC,GAAG,cAAc,CAEnE,4BAA4B;;ACb9B;;AAEG;AACI,MAAM,2BAA2B,GAAG,cAAc,CAAc,IAAI,GAAG,CAAC,EAAE,CAAC,EAAE;AAE9E,SAAU,uBAAuB,CAAC,UAA6B,EAAA;AACjE,IAAA,OAAO,EAAC,OAAO,EAAE,2BAA2B,EAAE,QAAQ,EAAE,IAAI,GAAG,CAAC,UAAU,CAAC,EAAC,CAAC;AACjF;;ACRA;;AAEG;AAEH;;;AAGG;AACI,MAAM,kBAAkB,GAAG,cAAc,CAA2B;IACvE,WAAW;IACX,YAAY;IACZ,YAAY;AACf,CAAA,EAAE;AAEH;;;;;;;;;;AAUG;AACI,MAAM,2BAA2B,GAAG,cAAc,CAEvD;IACE,UAAU;IACV,MAAM;IACN,sBAAsB;IACtB,OAAO;IACP,yCAAyC;AAC5C,CAAA,EAAE;AAEH;;;;;;;;AAQG;AACI,MAAM,qBAAqB,GAAG,cAAc,CAA2B;IAC1E,SAAS;IACT,0CAA0C;IAC1C,MAAM;AACT,CAAA,EAAE;MAEU,iBAAiB,GAAG,cAAc,CAAC,MAAM,EAAE;MAC3C,mBAAmB,GAAG,cAAc,CAAC,QAAQ,EAAE;MAC/C,qBAAqB,GAAG,cAAc,CAAC,UAAU,EAAE;MACnD,wBAAwB,GAAG,cAAc,CAAC,aAAa;;ACpDpE;;AAEG;MACU,YAAY,GAAG,cAAc,CAAsB,EAAE;;ACJlE;;AAEG;AACI,MAAM,mBAAmB,GAAG,cAAc,CAC7C,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;;ACG3D;;AAEG;MACU,aAAa,GAAG,cAAc,CAAmB,EAAE,EAAE;AAErD,MAAA,iBAAiB,GAC1B,yBAAyB,CAAC,MAAM,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;;ACb5E;;AAEG;MACU,gBAAgB,GAAG,cAAc,CAAmC,EAAE;;ACDnF;;AAEG;MACU,mBAAmB,GAC5B,cAAc,CAAmD,IAAI;;ACNzE;;AAEG;MACU,aAAa,GAAG,cAAc,CAAC,EAAE;;MCAjC,8BAA8B,GAAG,cAAc,CAElD,IAAI,EAAE;MAEH,6BAA6B,GACtC,cAAc,CAAgD,sBAAsB;;MCN3E,yBAAyB,GAClC,cAAc,CAA4B,MAAM;;ACLpD;;AAEG;;;;"}
+{"version":3,"file":"taiga-ui-addon-doc-tokens.mjs","sources":["../../../projects/addon-doc/tokens/code-actions.ts","../../../projects/addon-doc/tokens/code-editor.ts","../../../projects/addon-doc/tokens/default-tabs.ts","../../../projects/addon-doc/tokens/doc-icons.ts","../../../projects/addon-doc/tokens/example-content-processor.ts","../../../projects/addon-doc/tokens/excluded-properties.ts","../../../projects/addon-doc/tokens/i18n.ts","../../../projects/addon-doc/tokens/logo.ts","../../../projects/addon-doc/tokens/page-loaded.ts","../../../projects/addon-doc/tokens/pages.ts","../../../projects/addon-doc/tokens/see-also.ts","../../../projects/addon-doc/tokens/source-code.ts","../../../projects/addon-doc/tokens/title.ts","../../../projects/addon-doc/tokens/type-reference-handler.ts","../../../projects/addon-doc/tokens/url-state-handler.ts","../../../projects/addon-doc/tokens/taiga-ui-addon-doc-tokens.ts"],"sourcesContent":["import type {TuiContext} from '@taiga-ui/cdk/types';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\nimport type {PolymorpheusContent} from '@taiga-ui/polymorpheus';\n\n/**\n * Code actions for the opened tab with code example\n */\nexport const TUI_DOC_CODE_ACTIONS =\n    tuiCreateToken<PolymorpheusContent<TuiContext<string>>>('');\n","import {InjectionToken} from '@angular/core';\nimport type {TuiCodeEditor} from '@taiga-ui/addon-doc/types';\n\n/**\n * Service for opening online IDE e.g. Stackblitz\n */\nexport const TUI_DOC_CODE_EDITOR = new InjectionToken<TuiCodeEditor>(\n    '[TUI_DOC_CODE_EDITOR]',\n);\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * Array of default tab names\n */\nexport const TUI_DOC_DEFAULT_TABS = tuiCreateToken<readonly string[]>([]);\n","import type {Provider} from '@angular/core';\nimport {tuiCreateToken, tuiProvideOptions} from '@taiga-ui/cdk/utils/miscellaneous';\n\nexport interface TuiDocIcons {\n    readonly code: string;\n    readonly light: string;\n    readonly menu: string;\n    readonly dark: string;\n    readonly search: string;\n    readonly copy: string;\n    readonly check: string;\n    readonly link: string;\n}\n\nexport const TUI_DOC_DEFAULT_ICONS: TuiDocIcons = {\n    search: '@tui.search',\n    light: '@tui.sun',\n    dark: '@tui.moon',\n    code: '@tui.code',\n    menu: '@tui.menu',\n    copy: '@tui.copy',\n    check: '@tui.check',\n    link: '@tui.link',\n};\n\nexport const TUI_DOC_ICONS = tuiCreateToken(TUI_DOC_DEFAULT_ICONS);\n\nexport function tuiDocIconsProvider(icons: Partial<TuiDocIcons>): Provider {\n    return tuiProvideOptions(TUI_DOC_ICONS, icons, TUI_DOC_DEFAULT_ICONS);\n}\n","import {tuiTryParseMarkdownCodeBlock} from '@taiga-ui/addon-doc/utils';\nimport type {TuiHandler} from '@taiga-ui/cdk/types';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\nimport {identity} from 'rxjs';\n\n/**\n * Processes content in example\n */\nexport const TUI_DOC_EXAMPLE_CONTENT_PROCESSOR =\n    tuiCreateToken<TuiHandler<Record<string, string>, Record<string, string>>>(identity);\n\n/**\n * Processes markdown in code block\n */\nexport const TUI_DOC_EXAMPLE_MARKDOWN_CODE_PROCESSOR = tuiCreateToken<\n    TuiHandler<string, string[]>\n>(tuiTryParseMarkdownCodeBlock);\n","import type {Provider} from '@angular/core';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * Token to exclude inherited documentation properties\n */\nexport const TUI_DOC_EXCLUDED_PROPERTIES = tuiCreateToken<Set<string>>(new Set([]));\n\nexport function tuiDocExcludeProperties(properties: readonly string[]): Provider {\n    return {provide: TUI_DOC_EXCLUDED_PROPERTIES, useValue: new Set(properties)};\n}\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * TODO: think about reorganization in @taiga-ui/i18n way\n */\n\n/**\n * tui-doc-demo i18n texts\n * Works with a tuple\n */\nexport const TUI_DOC_DEMO_TEXTS = tuiCreateToken<[string, string, string]>([\n    'Dark mode',\n    'Background',\n    'Form value',\n]);\n\n/**\n * tui-doc-documentation i18n texts\n * Works with a tuple\n * [\n * @string word 'argument',\n * @string word 'type',\n * @string 'name and description',\n * @string word 'value'\n * @string message for tooltip about ng-polymorpheus\n * ]\n */\nexport const TUI_DOC_DOCUMENTATION_TEXTS = tuiCreateToken<\n    [string, string, string, string, string]\n>([\n    'Argument',\n    'Type',\n    'Name and description',\n    'Value',\n    'Learn about our dynamic templates from ',\n]);\n\n/**\n * tui-doc-example i18n texts\n * Works with a tuple\n * [\n * @string default tab name,\n * @string link to a sample copied message text,\n * @string link to a sample copied message label\n * ]\n */\nexport const TUI_DOC_EXAMPLE_TEXTS = tuiCreateToken<[string, string, string]>([\n    'Preview',\n    'Link to a sample was successfully copied',\n    'Done',\n]);\n\nexport const TUI_DOC_MENU_TEXT = tuiCreateToken('Menu');\nexport const TUI_DOC_SEARCH_TEXT = tuiCreateToken('Search');\nexport const TUI_DOC_SEE_ALSO_TEXT = tuiCreateToken('See also');\nexport const TUI_DOC_SOURCE_CODE_TEXT = tuiCreateToken('Source code');\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\nimport type {PolymorpheusContent} from '@taiga-ui/polymorpheus';\n\n/**\n * Main logo\n */\nexport const TUI_DOC_LOGO = tuiCreateToken<PolymorpheusContent>('');\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\nimport {defer, of, switchMap, timer} from 'rxjs';\n/**\n * Stream that emits if loading of page is over (for example, to begin scrollIntoView)\n */\nexport const TUI_DOC_PAGE_LOADED = tuiCreateToken(\n    defer(() => timer(200).pipe(switchMap(() => of(true)))),\n);\n","import type {InjectionToken} from '@angular/core';\nimport {inject} from '@angular/core';\nimport type {TuiDocRoutePage, TuiDocRoutePages} from '@taiga-ui/addon-doc/types';\nimport {tuiToFlatMapPages} from '@taiga-ui/addon-doc/utils';\nimport {\n    tuiCreateToken,\n    tuiCreateTokenFromFactory,\n} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * Documentation pages\n */\nexport const TUI_DOC_PAGES = tuiCreateToken<TuiDocRoutePages>([]);\n\nexport const TUI_DOC_MAP_PAGES: InjectionToken<Map<string, TuiDocRoutePage>> =\n    tuiCreateTokenFromFactory(() => tuiToFlatMapPages(inject(TUI_DOC_PAGES)));\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * Array of arrays of related pages\n */\nexport const TUI_DOC_SEE_ALSO = tuiCreateToken<ReadonlyArray<readonly string[]>>([]);\n","import type {TuiDocSourceCodePathOptions} from '@taiga-ui/addon-doc/types';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\nimport type {PolymorpheusContent} from '@taiga-ui/polymorpheus';\n\n/**\n * Source code link\n */\nexport const TUI_DOC_SOURCE_CODE =\n    tuiCreateToken<PolymorpheusContent<TuiDocSourceCodePathOptions>>(null);\n","import {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * Page title prefix\n */\nexport const TUI_DOC_TITLE = tuiCreateToken('');\n","import type {TuiDocTypeReferenceParsed} from '@taiga-ui/addon-doc/utils';\nimport {tuiTypeReferenceParser} from '@taiga-ui/addon-doc/utils';\nimport type {TuiHandler, TuiStringHandler} from '@taiga-ui/cdk/types';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\nexport const TUI_DOC_TYPE_REFERENCE_HANDLER = tuiCreateToken<TuiStringHandler<\n    string | null\n> | null>(null);\n\nexport const TUI_DOC_TYPE_REFERENCE_PARSER =\n    tuiCreateToken<TuiHandler<string, TuiDocTypeReferenceParsed>>(tuiTypeReferenceParser);\n","import type {UrlTree} from '@angular/router';\nimport type {TuiStringHandler} from '@taiga-ui/cdk/types';\nimport {tuiCreateToken} from '@taiga-ui/cdk/utils/miscellaneous';\n\n/**\n * TODO: delete it in 5.0\n * Replace the following approach to append query params\n * ```ts\n * urlStateHandler = inject(TUI_DOC_URL_STATE_HANDLER);\n * locationRef = inject(Location);\n *\n * this.locationRef.go(this.urlStateHandler(tree));\n * ```\n * with this one:\n * ```ts\n * router = inject(Router);\n * activatedRoute = inject(ActivatedRoute);\n *\n * void this.router.navigate([], {\n *     relativeTo: this.activatedRoute,\n *     queryParams: {sandboxWidth: 300},\n *     queryParamsHandling: 'merge',\n * });\n * ```\n * It is more robust to the cases when application has base href.\n */\nexport const TUI_DOC_URL_STATE_HANDLER =\n    tuiCreateToken<TuiStringHandler<UrlTree>>(String);\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;;;;AAIA;;AAEG;MACU,oBAAoB,GAC7B,cAAc,CAA0C,EAAE;;ACL9D;;AAEG;MACU,mBAAmB,GAAG,IAAI,cAAc,CACjD,uBAAuB;;ACL3B;;AAEG;MACU,oBAAoB,GAAG,cAAc,CAAoB,EAAE;;ACS3D,MAAA,qBAAqB,GAAgB;AAC9C,IAAA,MAAM,EAAE,aAAa;AACrB,IAAA,KAAK,EAAE,UAAU;AACjB,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,KAAK,EAAE,YAAY;AACnB,IAAA,IAAI,EAAE,WAAW;EACnB;MAEW,aAAa,GAAG,cAAc,CAAC,qBAAqB,EAAE;AAE7D,SAAU,mBAAmB,CAAC,KAA2B,EAAA;IAC3D,OAAO,iBAAiB,CAAC,aAAa,EAAE,KAAK,EAAE,qBAAqB,CAAC,CAAC;AAC1E;;ACxBA;;AAEG;MACU,iCAAiC,GAC1C,cAAc,CAA6D,QAAQ,EAAE;AAEzF;;AAEG;MACU,uCAAuC,GAAG,cAAc,CAEnE,4BAA4B;;ACb9B;;AAEG;AACI,MAAM,2BAA2B,GAAG,cAAc,CAAc,IAAI,GAAG,CAAC,EAAE,CAAC,EAAE;AAE9E,SAAU,uBAAuB,CAAC,UAA6B,EAAA;AACjE,IAAA,OAAO,EAAC,OAAO,EAAE,2BAA2B,EAAE,QAAQ,EAAE,IAAI,GAAG,CAAC,UAAU,CAAC,EAAC,CAAC;AACjF;;ACRA;;AAEG;AAEH;;;AAGG;AACI,MAAM,kBAAkB,GAAG,cAAc,CAA2B;IACvE,WAAW;IACX,YAAY;IACZ,YAAY;AACf,CAAA,EAAE;AAEH;;;;;;;;;;AAUG;AACI,MAAM,2BAA2B,GAAG,cAAc,CAEvD;IACE,UAAU;IACV,MAAM;IACN,sBAAsB;IACtB,OAAO;IACP,yCAAyC;AAC5C,CAAA,EAAE;AAEH;;;;;;;;AAQG;AACI,MAAM,qBAAqB,GAAG,cAAc,CAA2B;IAC1E,SAAS;IACT,0CAA0C;IAC1C,MAAM;AACT,CAAA,EAAE;MAEU,iBAAiB,GAAG,cAAc,CAAC,MAAM,EAAE;MAC3C,mBAAmB,GAAG,cAAc,CAAC,QAAQ,EAAE;MAC/C,qBAAqB,GAAG,cAAc,CAAC,UAAU,EAAE;MACnD,wBAAwB,GAAG,cAAc,CAAC,aAAa;;ACpDpE;;AAEG;MACU,YAAY,GAAG,cAAc,CAAsB,EAAE;;ACJlE;;AAEG;AACI,MAAM,mBAAmB,GAAG,cAAc,CAC7C,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;;ACG3D;;AAEG;MACU,aAAa,GAAG,cAAc,CAAmB,EAAE,EAAE;AAErD,MAAA,iBAAiB,GAC1B,yBAAyB,CAAC,MAAM,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;;ACb5E;;AAEG;MACU,gBAAgB,GAAG,cAAc,CAAmC,EAAE;;ACDnF;;AAEG;MACU,mBAAmB,GAC5B,cAAc,CAAmD,IAAI;;ACNzE;;AAEG;MACU,aAAa,GAAG,cAAc,CAAC,EAAE;;MCAjC,8BAA8B,GAAG,cAAc,CAElD,IAAI,EAAE;MAEH,6BAA6B,GACtC,cAAc,CAAgD,sBAAsB;;ACNxF;;;;;;;;;;;;;;;;;;;;;AAqBG;MACU,yBAAyB,GAClC,cAAc,CAA4B,MAAM;;AC3BpD;;AAEG;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taiga-ui/addon-doc",
-  "version": "4.0.1",
+  "version": "4.2.0",
   "description": "Taiga UI based library for developing documentation portals for Angular libraries.",
   "keywords": [
     "angular",
@@ -20,10 +20,10 @@
     "@angular/forms": ">=16.0.0",
     "@angular/router": ">=16.0.0",
     "@ng-web-apis/common": "^4.2.1",
-    "@taiga-ui/addon-mobile": "^4.0.1",
-    "@taiga-ui/cdk": "^4.0.1",
-    "@taiga-ui/core": "^4.0.1",
-    "@taiga-ui/kit": "^4.0.1",
+    "@taiga-ui/addon-mobile": "^4.2.0",
+    "@taiga-ui/cdk": "^4.2.0",
+    "@taiga-ui/core": "^4.2.0",
+    "@taiga-ui/kit": "^4.2.0",
     "@taiga-ui/polymorpheus": "^4.6.4",
     "markdown-it": ">=14.1.0",
     "ngx-highlightjs": ">=10.0.0"

package/tokens/url-state-handler.d.ts

@@ -1,3 +1,25 @@
 import type { UrlTree } from '@angular/router';
 import type { TuiStringHandler } from '@taiga-ui/cdk/types';
+/**
+ * TODO: delete it in 5.0
+ * Replace the following approach to append query params
+ * ```ts
+ * urlStateHandler = inject(TUI_DOC_URL_STATE_HANDLER);
+ * locationRef = inject(Location);
+ *
+ * this.locationRef.go(this.urlStateHandler(tree));
+ * ```
+ * with this one:
+ * ```ts
+ * router = inject(Router);
+ * activatedRoute = inject(ActivatedRoute);
+ *
+ * void this.router.navigate([], {
+ *     relativeTo: this.activatedRoute,
+ *     queryParams: {sandboxWidth: 300},
+ *     queryParamsHandling: 'merge',
+ * });
+ * ```
+ * It is more robust to the cases when application has base href.
+ */
 export declare const TUI_DOC_URL_STATE_HANDLER: import("@angular/core").InjectionToken<TuiStringHandler<UrlTree>>;