quasar/dist/api/QIcon.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/icon"
  },
  "behavior": {
    "$listeners": {
      "desc": "All native events are being propagated (you don't need the '.native' modifier)"
    }
  },
  "props": {
    "tag": {
      "type": "String",
      "desc": "HTML tag to render, unless no icon is supplied or it's an svg icon",
      "default": "i",
      "category": "content",
      "examples": [
        "div",
        "i"
      ],
      "addedIn": "v1.8.4"
    },
    "size": {
      "type": "String",
      "desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
      "examples": [
        "16px",
        "2rem",
        "xs",
        "md"
      ],
      "category": "style"
    },
    "name": {
      "type": "String",
      "desc": "Name of the icon, following Quasar convention",
      "examples": [
        "map",
        "ion-add"
      ],
      "category": "model"
    },
    "color": {
      "type": "String",
      "desc": "Color name for component from the Quasar Color Palette",
      "examples": [
        "primary",
        "teal-10"
      ],
      "category": "style"
    },
    "left": {
      "type": "Boolean",
      "desc": "Useful if icon is on the left side of something: applies a standard margin on the right side of Icon",
      "category": "content"
    },
    "right": {
      "type": "Boolean",
      "desc": "Useful if icon is on the right side of something: applies a standard margin on the left side of Icon",
      "category": "content"
    }
  },
  "slots": {
    "default": {
      "desc": "Suggestions: QTooltip or QMenu"
    }
  }
}