quasar/src/components/circular-progress/QCircularProgress.json

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

{
  "mixins": [ "composables/private/use-size" ],

  "meta": {
    "docsUrl": "https://v2.quasar.dev/vue-components/circular-progress"
  },

  "props": {
    "value": {
      "type": "Number",
      "default": 0,
      "desc": "Current progress (must be between min/max)",
      "category": "model"
    },

    "min": {
      "type": "Number",
      "default": 0,
      "desc": "Minimum value defining 'no progress' (must be lower than 'max')",
      "category": "model"
    },

    "max": {
      "type": "Number",
      "default": 100,
      "desc": "Maximum value defining 100% progress made (must be higher than 'min')",
      "category": "model"
    },

    "color": {
      "extends": "color",
      "desc": "Color name for the arc progress from the Quasar Color Palette"
    },

    "center-color": {
      "extends": "color",
      "desc": "Color name for the center part of the component from the Quasar Color Palette"
    },

    "track-color": {
      "extends": "color",
      "desc": "Color name for the track of the component from the Quasar Color Palette"
    },

    "font-size": {
      "type": "String",
      "desc": "Size of text in CSS units, including unit name. Suggestion: use 'em' units to sync with component size",
      "default": "0.25em",
      "examples": [ "1em", "16px", "2rem" ],
      "category": "style"
    },

    "rounded": {
      "type": "Boolean",
      "desc": "Rounding the arc of progress",
      "category": "style",
      "addedIn": "v2.8.4"
    },

    "thickness": {
      "type": "Number",
      "default": 0.2,
      "desc": "Thickness of progress arc as a ratio (0.0 < x < 1.0) of component size",
      "category": "style"
    },

    "angle": {
      "type": "Number",
      "desc": "Angle to rotate progress arc by",
      "default": 0,
      "category": "content"
    },

    "indeterminate": {
      "type": "Boolean",
      "desc": "Put component into 'indeterminate' state; Ignores 'value' prop",
      "category": "behavior"
    },

    "show-value": {
      "type": "Boolean",
      "desc": "Enables the default slot and uses it (if available), otherwise it displays the 'value' prop as text; Make sure the text has enough space to be displayed inside the component",
      "category": "content|behavior"
    },

    "reverse": {
      "type": "Boolean",
      "desc": "Reverses the direction of progress; Only for determined state",
      "category": "behavior"
    },

    "instant-feedback": {
      "type": "Boolean",
      "desc": "No animation when model changes",
      "category": "behavior"
    },

    "animation-speed": {
      "extends": "animation-speed",
      "default": 600,
      "addedIn": "v2.3"
    }
  },

  "slots": {
    "default": {
      "desc": "Used for component content only if 'show-value' prop is set; Make sure the content has enough space to be displayed inside the component"
    },

    "internal": {
      "desc": "Used by QKnob internally",
      "internal": true
    }
  }
}