Globals / "src/renderer/navigation"
Module: "src/renderer/navigation"#
Index#
Interfaces#
Variables#
Functions#
- getDetails
- getDetailsUrl
- getMatchedClusterId
- getQueryString
- getSearch
- getSelectedDetails
- hideDetails
- navigate
- setQueryParams
- setSearch
- showDetails
Variables#
history#
• Const history: History\<{}> = typeof window !== "undefined" ? createBrowserHistory() : createMemoryHistory()
Defined in src/renderer/navigation.ts:11
navigation#
• Const navigation: IObservableHistory\<{}> = createObservableHistory(history)
Defined in src/renderer/navigation.ts:12
Functions#
getDetails#
▸ getDetails(): string
Defined in src/renderer/navigation.ts:47
Returns: string
getDetailsUrl#
▸ getDetailsUrl(details: string): string
Defined in src/renderer/navigation.ts:55
Parameters:
| Name | Type |
|---|---|
details |
string |
Returns: string
getMatchedClusterId#
▸ getMatchedClusterId(): string
Defined in src/renderer/navigation.ts:84
Returns: string
getQueryString#
▸ getQueryString(params?: Partial\<IQueryParams>, merge?: boolean): string
Defined in src/renderer/navigation.ts:32
Parameters:
| Name | Type | Default value |
|---|---|---|
params? |
Partial\<IQueryParams> | - |
merge |
boolean | true |
Returns: string
getSearch#
▸ getSearch(): string
Defined in src/renderer/navigation.ts:80
Returns: string
getSelectedDetails#
▸ getSelectedDetails(): string
Defined in src/renderer/navigation.ts:51
Returns: string
hideDetails#
▸ hideDetails(): void
Defined in src/renderer/navigation.ts:70
Returns: void
navigate#
▸ navigate(location: LocationDescriptor): void
Defined in src/renderer/navigation.ts:14
Parameters:
| Name | Type |
|---|---|
location |
LocationDescriptor |
Returns: void
setQueryParams#
▸ setQueryParams\params?: T & IQueryParams, __namedParameters?: { merge: boolean = true; replace: boolean = false }): void
Defined in src/renderer/navigation.ts:42
Type parameters:
| Name |
|---|
T |
Parameters:
| Name | Type | Default value |
|---|---|---|
params? |
T & IQueryParams | - |
__namedParameters |
{ merge: boolean = true; replace: boolean = false } | {} |
Returns: void
setSearch#
▸ setSearch(text: string): void
Defined in src/renderer/navigation.ts:74
Parameters:
| Name | Type |
|---|---|
text |
string |
Returns: void
showDetails#
▸ showDetails(path: string, resetSelected?: boolean): void
Defined in src/renderer/navigation.ts:63
Parameters:
| Name | Type | Default value |
|---|---|---|
path |
string | - |
resetSelected |
boolean | true |
Returns: void