quasar/src/components/stepper/QStepper.json

Build high-performance VueJS user interfaces (SPA, PWA, SSR, Mobile and Desktop) in record time

{
  "mixins": [ "mixins/panel-parent" ],

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

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

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

    "flat": {
      "extends": "flat"
    },

    "bordered": {
      "extends": "bordered"
    },

    "vertical": {
      "type": "Boolean",
      "desc": "Put Stepper in vertical mode (instead of horizontal by default)",
      "category": "behavior"
    },

    "alternative-labels": {
      "type": "Boolean",
      "desc": "Use alternative labels - stacks the icon on top of the label (applies only to horizontal stepper)",
      "category": "header"
    },

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

    "contracted": {
      "type": "Boolean",
      "desc": "Hide header labels on narrow windows",
      "category": "header|behavior"
    },

    "inactive-icon": {
      "extends": "icon",
      "category": "header"
    },

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

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

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

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

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

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

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

    "header-class": {
      "type": "String",
      "desc": "Class definitions to be attributed to the header",
      "examples": [
        "my-special-class"
      ],
      "category": "style"
    }
  },

  "slots": {
    "default": {
      "desc": "Suggestion: QStep"
    },

    "navigation": {
      "desc": "Slot specific for the global navigation; Suggestion: QStepperNavigation"
    },

    "message": {
      "desc": "Slot specific for putting a message on top of each step (if horizontal stepper) or above steps (if vertical); Suggestion: QBanner, div.q-pa-lg"
    }
  }
}