swipe-back-control/dist/docs.json

Capacitor plugin to enable or disable the swipe back gesture on iOS devices for specific pages.

{
  "api": {
    "name": "SwipeBackControlPlugin",
    "slug": "swipebackcontrolplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "enableSwipeBack",
        "signature": "(options: { enabled: boolean; currentPage: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "Configuration options for swipe back control",
            "type": "{ enabled: boolean; currentPage: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options Configuration options for swipe back control"
          },
          {
            "name": "returns",
            "text": "Promise that resolves when the operation is completed"
          }
        ],
        "docs": "Enable or disable swipe back gesture for the current page",
        "complexTypes": [],
        "slug": "enableswipeback"
      },
      {
        "name": "disableSwipeBack",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "returns",
            "text": "Promise that resolves when the operation is completed"
          }
        ],
        "docs": "Disable swipe back gesture for the current page",
        "complexTypes": [],
        "slug": "disableswipeback"
      },
      {
        "name": "shouldBlockBackButton",
        "signature": "() => Promise<{ shouldBlock: boolean; currentPage: string; }>",
        "parameters": [],
        "returns": "Promise<{ shouldBlock: boolean; currentPage: string; }>",
        "tags": [
          {
            "name": "returns",
            "text": "Promise that resolves with information about whether back should be blocked"
          }
        ],
        "docs": "Check if back button should be blocked for the current page (Android only)",
        "complexTypes": [],
        "slug": "shouldblockbackbutton"
      }
    ],
    "properties": []
  },
  "interfaces": [],
  "enums": [],
  "typeAliases": [],
  "pluginConfigs": []
}