ui/client/features/pages-editor/domain/OpenPage
Pure (DOMAIN-001): a request to open one page file in the Pages editor (e.g.
Cockpit client (features), next. Source: ui/client/features/pages-editor/domain/OpenPage.ts.
Type Aliases#
OpenPageTarget#
OpenPageTarget =
object
Defined in: ui/client/features/pages-editor/domain/OpenPage.ts:4
Properties#
feature
feature:
string
Defined in: ui/client/features/pages-editor/domain/OpenPage.ts:4
file
file:
string
Defined in: ui/client/features/pages-editor/domain/OpenPage.ts:4
Variables#
OPEN_PAGE_EVENT#
constOPEN_PAGE_EVENT:"construct:open-page"='construct:open-page'
Defined in: ui/client/features/pages-editor/domain/OpenPage.ts:7
Event name used when the editor is already on screen (a router push would not remount it).
Functions#
openPageQuery()#
openPageQuery(
target):string
Defined in: ui/client/features/pages-editor/domain/OpenPage.ts:10
?feature=<f>&file=<path> for the Pages editor route.
Parameters#
target
Returns#
string
parseOpenPage()#
parseOpenPage(
search):OpenPageTarget|null
Defined in: ui/client/features/pages-editor/domain/OpenPage.ts:15
The target encoded in a URL query string, or null when absent/incomplete.
Parameters#
search
string
Returns#
OpenPageTarget | null
withOpenPage()#
withOpenPage(
search,target):string
Defined in: ui/client/features/pages-editor/domain/OpenPage.ts:23
The query string after setting (or, with null, clearing) the open page; other params are kept.
Parameters#
search
string
target
OpenPageTarget | null
Returns#
string