quasar/src/composables/private.use-fullscreen/use-fullscreen.json

Build high-performance VueJS user interfaces (SPA, PWA, SSR, Mobile and Desktop) in record time

{
  "props": {
    "fullscreen": {
      "type": "Boolean",
      "sync": true,
      "desc": "Fullscreen mode",
      "examples": [ "# v-model:fullscreen=\"isFullscreen\"" ],
      "category": "behavior"
    },

    "no-route-fullscreen-exit": {
      "type": "Boolean",
      "desc": "Changing route app won't exit fullscreen",
      "category": "behavior"
    }
  },

  "events": {
    "fullscreen": {
      "desc": "Emitted when fullscreen state changes",
      "params": {
        "value": {
          "type": "Boolean",
          "desc": "Fullscreen state (showing/hidden)"
        }
      }
    },

    "update:fullscreen": {
      "desc": "Used by Vue on 'v-model:fullscreen' prop for updating its value",
      "params": {
        "value": {
          "type": "Boolean",
          "desc": "Fullscreen state (showing/hidden)"
        }
      }
    }
  },

  "methods": {
    "toggleFullscreen": {
      "desc": "Toggle the view to be fullscreen or not fullscreen",
      "params": null,
      "returns": null
    },
    "setFullscreen": {
      "desc": "Enter the fullscreen view",
      "params": null,
      "returns": null
    },

    "exitFullscreen": {
      "desc": "Leave the fullscreen view",
      "params": null,
      "returns": null
    }
  }
}