quasar/ui/src/plugins/Loading.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
{
  "meta": {
    "docsUrl": "https://v1.quasar.dev/quasar-plugins/loading"
  },

  "injection": "$q.loading",

  "quasarConfOptions": {
    "propName": "loading",
    "definition": {
      "delay": {
        "type": "Number",
        "desc": "Wait a number of millisecond before showing; Not worth showing for 100ms for example then hiding it, so wait until you're sure it's a process that will take some considerable amount of time",
        "examples": [ 400 ]
      },
      "message": {
        "type": "String",
        "desc": "Message to display",
        "examples": [ "Processing your request" ]
      },
      "sanitize": {
        "extends": "sanitize",
        "desc": "Force use of textContent instead of innerHTML to render message; Use it when the message might be unsafe (from user input)"
      },
      "spinnerSize": {
        "type": "Number",
        "desc": "Spinner size (in pixels)",
        "examples": [ 60 ]
      },
      "spinnerColor": {
        "extends": "color",
        "desc": "Color name for spinner from the Quasar Color Palette"
      },
      "messageColor": {
        "extends": "color",
        "desc": "Color name for text from the Quasar Color Palette"
      },
      "backgroundColor": {
        "extends": "color",
        "desc": "Color name for background from the Quasar Color Palette"
      },
      "spinner": {
        "type": "Component",
        "desc": "One of the QSpinners"
      },
      "customClass": {
        "type": "String",
        "desc": "Add a CSS class to easily customize the component",
        "examples": [ "my-class" ]
      }
    }
  },

  "props": {
    "isActive": {
      "type": "Boolean",
      "desc": "Is Loading active?",
      "reactive": true
    }
  },

  "methods": {
    "show": {
      "desc": "Activate and show",
      "params": {
        "opts": {
          "type": "Object",
          "desc": "All props are optional",
          "definition": {
            "delay": {
              "type": "Number",
              "desc": "Wait a number of millisecond before showing; Not worth showing for 100ms for example then hiding it, so wait until you're sure it's a process that will take some considerable amount of time",
              "examples": [ 400 ]
            },
            "message": {
              "type": "String",
              "desc": "Message to display",
              "examples": [ "Processing your request" ]
            },
            "sanitize": {
              "extends": "sanitize",
              "desc": "Force use of textContent instead of innerHTML to render message; Use it when the message might be unsafe (from user input)"
            },
            "spinnerSize": {
              "type": "Number",
              "desc": "Spinner size (in pixels)",
              "examples": [ 60 ]
            },
            "spinnerColor": {
              "extends": "color",
              "desc": "Color name for spinner from the Quasar Color Palette"
            },
            "messageColor": {
              "extends": "color",
              "desc": "Color name for text from the Quasar Color Palette"
            },
            "backgroundColor": {
              "extends": "color",
              "desc": "Color name for background from the Quasar Color Palette"
            },
            "spinner": {
              "type": "Component",
              "desc": "One of the QSpinners"
            },
            "customClass": {
              "type": "String",
              "desc": "Add a CSS class to easily customize the component",
              "examples": [ "my-class" ]
            },
            "ignoreDefaults": {
              "type": "Boolean",
              "desc": "Ignore the default configuration (set by setDefaults()) for this instance only",
              "addedIn": "v1.1.0"
            }
          }
        }
      }
    },

    "hide": {
      "desc": "Hide it"
    },

    "setDefaults": {
      "desc": "Merge options into the default ones",
      "params": {
        "opts": {
          "type": "Object",
          "desc": "Pick the subprop you want to define",
          "required": true,
          "definition": {
            "delay": {
              "type": "Number",
              "desc": "Wait a number of millisecond before showing; Not worth showing for 100ms for example then hiding it, so wait until you're sure it's a process that will take some considerable amount of time",
              "examples": [ 400 ]
            },
            "message": {
              "type": "String",
              "desc": "Message to display",
              "examples": [ "Processing your request" ]
            },
            "spinnerSize": {
              "type": "Number",
              "desc": "Spinner size (in pixels)",
              "examples": [ 60 ]
            },
            "spinnerColor": {
              "extends": "color",
              "desc": "Color name for spinner from the Quasar Color Palette"
            },
            "messageColor": {
              "extends": "color",
              "desc": "Color name for text from the Quasar Color Palette"
            },
            "backgroundColor": {
              "extends": "color",
              "desc": "Color name for background from the Quasar Color Palette"
            },
            "spinner": {
              "type": "Component",
              "desc": "One of the QSpinners"
            },
            "customClass": {
              "type": "String",
              "desc": "Add a CSS class to easily customize the component",
              "examples": [ "my-class" ]
            }
          }
        }
      }
    }
  }
}