quasar/ui/src/components/stepper/QStep.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
{
  "meta": {
    "docsUrl": "https://v1.quasar.dev/vue-components/stepper"
  },

  "mixins": [ "mixins/panel-child" ],

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

  "props": {
    "icon": {
      "extends": "icon",
      "category": "header"
    },

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

    "title": {
      "type": "String",
      "desc": "Step title",
      "required": true,
      "examples": [
        "Ad Groups", "Payment"
      ],
      "category": "header"
    },

    "caption": {
      "type": "String",
      "desc": "Step’s additional information that appears beneath the title",
      "examples": [
        "Create an account", "Payment details"
      ],
      "category": "header"
    },

    "prefix": {
      "type": [ "String", "Number" ],
      "desc": "Step's prefix (max 2 characters) which replaces the icon if step does not has error, is being edited or is marked as done",
      "examples": [
        "1", "2", "A", "B"
      ],
      "category": "header"
    },

    "done-icon": {
      "extends": "icon",
      "desc": "Icon name following Quasar convention; If 'none' (String) is used as value, then it will defer to prefix or the regular icon for this state; Make sure you have the icon library installed unless you are using 'img:' prefix",
      "category": "header"
    },

    "done-color": {
      "extends": "color",
      "category": "header"
    },

    "active-icon": {
      "extends": "icon",
      "desc": "Icon name following Quasar convention; If 'none' (String) is used as value, then it will defer to prefix or the regular icon for this state; Make sure you have the icon library installed unless you are using 'img:' prefix",
      "category": "header"
    },

    "active-color": {
      "extends": "color",
      "category": "header"
    },

    "error-icon": {
      "extends": "icon",
      "desc": "Icon name following Quasar convention; If 'none' (String) is used as value, then it will defer to prefix or the regular icon for this state; Make sure you have the icon library installed unless you are using 'img:' prefix",
      "category": "header"
    },

    "error-color": {
      "extends": "color",
      "category": "header"
    },

    "header-nav": {
      "type": "Boolean",
      "default": true,
      "desc": "Allow navigation through the header",
      "category": "behavior"
    },

    "done": {
      "type": "Boolean",
      "desc": "Mark the step as 'done'",
      "category": "state"
    },

    "error": {
      "type": "Boolean",
      "desc": "Mark the step as having an error",
      "category": "state"
    }
  },

  "slots": {
    "default": {
      "desc": "The content of the step; Can also contain a QStepperNavigation if you want to handle step navigation and don't have a global navigation in place"
    }
  }
}