quasar/ui/src/plugins/Screen.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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
{
  "meta": {
    "docsUrl": "https://v1.quasar.dev/options/screen-plugin"
  },

  "injection": "$q.screen",

  "props": {
    "width": {
      "type": "Number",
      "desc": "Screen width (in pixels)",
      "reactive": true,
      "examples": [ 452 ]
    },

    "height": {
      "type": "Number",
      "desc": "Screen height (in pixels)",
      "reactive": true,
      "examples": [ 721 ]
    },

    "name": {
      "type": "String",
      "desc": "Tells current window breakpoint",
      "values": [ "xs", "sm", "md", "lg", "xl" ],
      "reactive": true,
      "addedIn": "v1.5.2"
    },

    "sizes": {
      "type": "Object",
      "desc": "Breakpoints (in pixels)",
      "definition": {
        "sm": {
          "type": "Number",
          "desc": "Breakpoint width size (minimum size)",
          "examples": [ 600 ]
        },
        "md": {
          "type": "Number",
          "desc": "Breakpoint width size (minimum size)",
          "examples": [ 1024 ]
        },
        "lg": {
          "type": "Number",
          "desc": "Breakpoint width size (minimum size)",
          "examples": [ 1440 ]
        },
        "xl": {
          "type": "Number",
          "desc": "Breakpoint width size (minimum size)",
          "examples": [ 1920 ]
        }
      },
      "reactive": true,
      "examples": [
        "{ sm: 600, md: 1024, lg: 1440, xl: 1920 }"
      ]
    },

    "lt": {
      "type": "Object",
      "desc": "Tells if current screen width is lower than breakpoint-name",
      "reactive": true,
      "definition": {
        "sm": {
          "type": "Boolean",
          "desc": "Is current screen width lower than this breakpoint's lowest limit?"
        },
        "md": {
          "type": "Boolean",
          "desc": "Is current screen width lower than this breakpoint's lowest limit?"
        },
        "lg": {
          "type": "Boolean",
          "desc": "Is current screen width lower than this breakpoint's lowest limit?"
        },
        "xl": {
          "type": "Boolean",
          "desc": "Is current screen width lower than this breakpoint's lowest limit?"
        }
      },
      "examples": [
        "{ sm: false, md: true, lg: true, xl: true }"
      ]
    },

    "gt": {
      "type": "Object",
      "desc": "Tells if current screen width is greater than breakpoint-name",
      "reactive": true,
      "definition": {
        "xs": {
          "type": "Boolean",
          "desc": "Is current screen width greater than this breakpoint's max limit?"
        },
        "sm": {
          "type": "Boolean",
          "desc": "Is current screen width greater than this breakpoint's max limit?"
        },
        "md": {
          "type": "Boolean",
          "desc": "Is current screen width greater than this breakpoint's max limit?"
        },
        "lg": {
          "type": "Boolean",
          "desc": "Is current screen width greater than this breakpoint's max limit?"
        }
      },
      "examples": [
        "{ xs: true, sm: true, md: false, lg: false, xl: false }"
      ]
    },

    "xs": {
      "type": "Boolean",
      "desc": "Current screen width fits exactly 'xs' breakpoint",
      "reactive": true
    },

    "sm": {
      "type": "Boolean",
      "desc": "Current screen width fits exactly 'sm' breakpoint",
      "reactive": true
    },

    "md": {
      "type": "Boolean",
      "desc": "Current screen width fits exactly 'md' breakpoint",
      "reactive": true
    },

    "lg": {
      "type": "Boolean",
      "desc": "Current screen width fits exactly 'lg' breakpoint",
      "reactive": true
    },

    "xl": {
      "type": "Boolean",
      "desc": "Current screen width fits exactly 'xl' breakpoint",
      "reactive": true
    }
  },

  "methods": {
    "setSizes": {
      "desc": "Override default breakpoint sizes",
      "params": {
        "breakpoints": {
          "type": "Object",
          "desc": "Pick what you want to override",
          "definition": {
            "sm": {
              "type": "Number",
              "desc": "Breakpoint width size (minimum size)",
              "examples": [ 600 ]
            },
            "md": {
              "type": "Number",
              "desc": "Breakpoint width size (minimum size)",
              "examples": [ 1024 ]
            },
            "lg": {
              "type": "Number",
              "desc": "Breakpoint width size (minimum size)",
              "examples": [ 1440 ]
            },
            "xl": {
              "type": "Number",
              "desc": "Breakpoint width size (minimum size)",
              "examples": [ 1920 ]
            }
          },
          "required": true
        }
      }
    },

    "setDebounce": {
      "desc": "Debounce update of all props when screen width/height changes",
      "params": {
        "amount": {
          "type": "Number",
          "desc": "Amount in milliseconds",
          "required": true,
          "examples": [ 300 ]
        }
      }
    }
  }
}