GTKX

API Reference / @gtkx/navigation / StackActions

Variable: StackActions ​

const StackActions: object

Type Declaration ​

pop() ​

pop(count?): object

Parameters ​

count? ​

number

Returns ​

object

payload ​

readonly payload: object

payload.count ​

readonly count: number

type ​

readonly type: "POP"

popTo() ​

popTo(name, params?, options?): object

Parameters ​

name ​

string

params? ​

object

options? ​
merge? ​

boolean

Returns ​

object

payload ​

readonly payload: object

payload.merge ​

readonly merge: boolean | undefined

payload.name ​

readonly name: string

payload.params ​

readonly params: object | undefined

type ​

readonly type: "POP_TO"

popToTop() ​

popToTop(): object

Returns ​

object

type ​

readonly type: "POP_TO_TOP"

push() ​

push(name, params?): object

Parameters ​

name ​

string

params? ​

object

Returns ​

object

payload ​

readonly payload: object

payload.name ​

readonly name: string

payload.params ​

readonly params: object | undefined

type ​

readonly type: "PUSH"

replace() ​

replace(name, params?): object

Parameters ​

name ​

string

params? ​

object

Returns ​

object

payload ​

readonly payload: object

payload.name ​

readonly name: string

payload.params ​

readonly params: object | undefined

type ​

readonly type: "REPLACE"