quasar/ui/src/components/field/QField.json at 7097f56f0e5a9ec9ca87c89520f1e7af58e941c6 · quasarframework/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
{
  "mixins": ["composables/private.use-field/use-field"],

  "meta": {
    "docsUrl": "https://v2.quasar.dev/vue-components/field"
  },

  "props": {
    "maxlength": {
      "type": ["String", "Number"],
      "desc": "Specify a max length of model",
      "category": "model"
    },

    "tag": {
      "extends": "tag",
      "default": "'label'",
      "examples": ["'div'", "'label'"],
      "addedIn": "v2.13.1"
    }
  },

  "slots": {
    "control": {
      "desc": "Slot for controls; Suggestion QSlider, QRange, QKnob, ...",
      "scope": {
        "id": {
          "type": "String",
          "desc": "Element id used in the 'for' attribute of the field label. Can be used to link the control to the label",
          "examples": ["'qf_363270c0-7a83-62b1-8dcf-6dfd64ee38fa'"]
        },
        "field": {
          "type": "Element",
          "desc": "DOM element of the field"
        },
        "editable": {
          "type": "Boolean",
          "desc": "Field is editable"
        },
        "focused": {
          "type": "Boolean",
          "desc": "Field has focus"
        },
        "floatingLabel": {
          "type": "Boolean",
          "desc": "Field's label is floating"
        },
        "modelValue": {
          "type": "Any",
          "desc": "Field's value",
          "examples": ["0.241", "'Text'"]
        },
        "emitValue": {
          "type": "Function",
          "desc": "Function that emits an @input event in the context of the field",
          "params": {
            "value": {
              "type": "Any",
              "required": true,
              "desc": "Value to be emitted",
              "examples": ["0", "'Changed text'"]
            }
          },
          "returns": null
        },
        "ariaInvalid": {
          "type": "String",
          "desc": "Value for the control's 'aria-invalid' attribute when the field has an error",
          "examples": ["'true'"]
        },
        "ariaDescribedby": {
          "type": "String",
          "desc": "Element id for the field error message; Use it for the control's 'aria-describedby' attribute when rendering a custom control",
          "examples": ["'qf_363270c0-7a83-62b1-8dcf-6dfd64ee38fa_error'"]
        },
        "ariaErrormessage": {
          "type": "String",
          "desc": "Element id for the field error message; Use it for the control's 'aria-errormessage' attribute when rendering a custom control",
          "examples": ["'qf_363270c0-7a83-62b1-8dcf-6dfd64ee38fa_error'"]
        }
      }
    },

    "rawControl": {
      "internal": true
    }
  },

  "events": {
    "update:model-value": {
      "desc": "Emitted when the model changes, only when used with 'clearable' or the 'control' scoped slot."
    }
  }
}