quasar/dist/api/QStep.json

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

{
  "type": "component",
  "meta": {
    "docsUrl": "https://v1.quasar.dev/vue-components/stepper"
  },
  "behavior": {
    "$listeners": {
      "desc": "All native events are being propagated (you don't need the '.native' modifier)"
    }
  },
  "props": {
    "name": {
      "type": "Any",
      "desc": "Panel name",
      "required": true,
      "examples": [
        "accounts",
        "firstPanel",
        ":name=\"1\""
      ],
      "category": "general"
    },
    "disable": {
      "type": "Boolean",
      "desc": "Put component in disabled mode",
      "category": "state"
    },
    "icon": {
      "type": "String",
      "desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix",
      "examples": [
        "map",
        "ion-add",
        "img:https://cdn.quasar.dev/logo/svg/quasar-logo.svg",
        "img:statics/path/to/some_image.png"
      ],
      "category": "header"
    },
    "color": {
      "type": "String",
      "desc": "Color name for component from the Quasar Color Palette",
      "examples": [
        "primary",
        "teal-10"
      ],
      "category": "style"
    },
    "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": {
      "type": "String",
      "desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix",
      "examples": [
        "map",
        "ion-add",
        "img:https://cdn.quasar.dev/logo/svg/quasar-logo.svg",
        "img:statics/path/to/some_image.png"
      ],
      "category": "header"
    },
    "done-color": {
      "type": "String",
      "desc": "Color name for component from the Quasar Color Palette",
      "examples": [
        "primary",
        "teal-10"
      ],
      "category": "header"
    },
    "active-icon": {
      "type": "String",
      "desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix",
      "examples": [
        "map",
        "ion-add",
        "img:https://cdn.quasar.dev/logo/svg/quasar-logo.svg",
        "img:statics/path/to/some_image.png"
      ],
      "category": "header"
    },
    "active-color": {
      "type": "String",
      "desc": "Color name for component from the Quasar Color Palette",
      "examples": [
        "primary",
        "teal-10"
      ],
      "category": "header"
    },
    "error-icon": {
      "type": "String",
      "desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix",
      "examples": [
        "map",
        "ion-add",
        "img:https://cdn.quasar.dev/logo/svg/quasar-logo.svg",
        "img:statics/path/to/some_image.png"
      ],
      "category": "header"
    },
    "error-color": {
      "type": "String",
      "desc": "Color name for component from the Quasar Color Palette",
      "examples": [
        "primary",
        "teal-10"
      ],
      "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"
    }
  }
}