quasar/ui/src/plugins/AppFullscreen.json at v1 · hipertracker/quasar · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{
  "meta": {
    "docsUrl": "https://v1.quasar.dev/quasar-plugins/app-fullscreen"
  },

  "injection": "$q.fullscreen",

  "props": {
    "isCapable": {
      "type": "Boolean",
      "desc": "Does browser support it?"
    },

    "isActive": {
      "type": "Boolean",
      "desc": "Is Fullscreen active?"
    },

    "activeEl": {
      "type": "Object",
      "desc": "The DOM element used as root for fullscreen, otherwise 'null'",
      "__exemption": [ "examples" ],
      "addedIn": "v1.12.5"
    }
  },

  "methods": {
    "request": {
      "desc": "Request going into Fullscreen (with optional target)",
      "params": {
        "target": {
          "type": "Element",
          "desc": "Optional Element of target to request Fullscreen on",
          "examples": [ "document.getElementById('example')" ]
        }
      },
      "returns": {
        "type": "Promise<any>",
        "desc": "A Promise with the outcome (true -> validation was a success, false -> invalid models detected)",
        "examples": [
          "request().then(response => { ... }).catch(err => { ... })"
        ]
      }
    },

    "exit": {
      "desc": "Request exiting out of Fullscreen mode",
      "returns": {
        "type": "Promise<any>",
        "desc": "A Promise with the outcome (true -> validation was a success, false -> invalid models detected)",
        "examples": [
          "exit().then(response => { ... }).catch(err => { ... })"
        ]
      }
    },

    "toggle": {
      "desc": "Request toggling Fullscreen mode (with optional target if requesting going into Fullscreen only)",
      "params": {
        "target": {
          "type": "Element",
          "desc": "Optional Element of target to request Fullscreen on",
          "examples": [ "document.getElementById('example')" ]
        }
      },
      "returns": {
        "type": "Promise<any>",
        "desc": "A Promise with the outcome (true -> validation was a success, false -> invalid models detected)",
        "examples": [
          "toggle().then(response => { ... }).catch(err => { ... })"
        ]
      }
    }
  }
}