quasar/ui/src/components/option-group/QOptionGroup.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
{
  "mixins": [ "mixins/size" ],

  "meta": {
    "docsUrl": "https://v1.quasar.dev/vue-components/option-group"
  },

  "behavior": {
    "$listeners": true
  },

  "props": {
    "value": {
      "extends": "value",
      "type": "Any",
      "examples": [ "v-model=\"group\"" ],
      "category": "model"
    },

    "options": {
      "type": "Array",
      "desc": "Array of objects with value, label, and disable (optional) props. The binary components will be created according to this array; Props from QToggle, QCheckbox or QRadio can also be added as key/value pairs to control the components singularly",
      "definition": {
        "label": {
          "type": "String",
          "desc": "Label to display along the component",
          "required": true,
          "examples": [ "Option 1", "Option 2", "Option 3" ]
        },
        "value": {
          "type": "Any",
          "desc": "Value of the option that will be used by the component model",
          "required": true,
          "examples": [ "op1", "op2", "op3" ]
        },
        "disable": {
          "type": "Boolean",
          "desc": "If true, the option will be disabled"
        },
        "...props": {
          "type": "Any",
          "desc": "Any other props from QToggle, QCheckbox, or QRadio",
          "examples": [ "val=\"car\"", ":true-value=\"trueValue\"", "checked-icon=\"visibility\"" ]
        }
      },
      "examples": [
        ":options=\"[ { label: 'Option 1', value: 'op1' }, { label: 'Option 2', value: 'op2' }, { label: 'Option 3', value: 'op3', disable: true } ]\""
      ],
      "category": "model"
    },

    "name": {
      "type": "String",
      "desc": "Used to specify the name of the controls; Useful if dealing with forms submitted directly to a URL",
      "examples": [ "car_id" ],
      "category": "behavior",
      "addedIn": "v1.9.0"
    },

    "type": {
      "type": "String",
      "desc": "The type of input component to be used",
      "values": [ "radio", "checkbox", "toggle" ],
      "default": "radio",
      "examples": [ "checkbox" ],
      "category": "content"
    },

    "color": {
      "extends": "color"
    },

    "keep-color": {
      "type": "Boolean",
      "desc": "Should the color (if specified any) be kept when input components are unticked?",
      "category": "behavior"
    },

    "size": {
      "addedIn": "v1.8.0"
    },

    "dark": {
      "extends": "dark"
    },

    "dense": {
      "extends": "dense"
    },

    "left-label":  {
      "type": "Boolean",
      "desc": "Label (if any specified) should be displayed on the left side of the input components",
      "category": "content"
    },

    "inline": {
      "type": "Boolean",
      "desc": "Show input components as inline-block rather than each having their own row",
      "category": "content"
    },

    "disable": {
      "extends": "disable"
    }
  },

  "scopedSlots": {
    "label": {
      "desc": "Generic slot for all labels",
      "scope": {
        "opt": {
          "type": "Object",
          "desc": "The corresponding option entry from the 'options' prop",
          "__exemption": [ "examples" ]
        }
      },
      "addedIn": "v1.17"
    },

    "label-[name]": {
      "desc": "Slot to define the specific label for the option at '[name]' where name is a 0-based index; Overrides the generic 'label' slot if used",
      "scope": {
        "opt": {
          "type": "Object",
          "desc": "The corresponding option entry from the 'options' prop",
          "__exemption": [ "examples" ]
        }
      },
      "addedIn": "v1.17"
    }
  },

  "events": {
    "input": {
      "extends": "input"
    }
  }
}