Skip to content

path ​

path navigates the user to another route, opens an external URL, or retargets an existing BetterForms window.

The old rule that "path must always be the last action" is too absolute for the current runtime.

What actually happens depends on which navigation mode you use.

KeyTypeDescription
action"path"Action Name
options.windowNamestring

{ optional } If specified, BetterForms updates the target card/modal window with the matching name instead of opening a normal route or URL navigation. This is useful when you want to retarget an existing BetterForms window.

ver 0.8.2+

options.pathstring

{ optional } Internal BetterForms route, for example /, /dash, or /form/:id.

options.url{ optional } External URL to open.
options.sameWindow{ optional } If true with options.url, BetterForms replaces the current browser tab instead of opening a new one.
options.namestringTarget name used by window.open() when opening an external URL. If omitted, BetterForms uses _blank. ( Ver 0.10.22+ )
options.featuresstringWindow features as described in MDN here. ( Ver 0.10.22+ )

Runtime Behavior ​

ModeKey(s) usedWhat BetterForms doesAction thread continues?
Internal routeoptions.pathCalls the Vue routerYes
External URL, new tab/windowoptions.urlCalls window.open()Yes
External URL, same taboptions.url + sameWindow: trueReplaces the current browser locationNo
Existing BetterForms windowoptions.windowNameUpdates the target BetterForms windowYes

For same-window external navigation, treat path as the last meaningful action because the browser is leaving the BetterForms app.

For internal routes and new-tab external links, the action queue can continue after navigation.

json
{
  "action": "path",
  "options": {
    "path": "/invoiceList"
  }
}
json
{
  "action": "path",
  "options": {
    "url": "https://docs.fmbetterforms.com/",
    "sameWindow": true
  }
}
json
{
  "action": "path",
  "options": {
    "url": "https://example.com/report.pdf",
    "name": "_blank",
    "features": "noopener,noreferrer"
  }
}

FileMaker Custom Function ​

text
BF_SetAction_Path("/form/123-1234-5678")

Klai Studio documentation