quasar/src/components/checkbox/use-checkbox.json

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

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

  "props": {
    "model-value": {
      "extends": "model-value",
      "type": ["Any", "Array"],
      "default": "null",
      "examples": ["false", "['car', 'building']"]
    },

    "val": {
      "type": "Any",
      "desc": "Works when model ('value') is Array. It tells the component which value should add/remove when ticked/unticked",
      "examples": ["'car'"],
      "category": "model"
    },

    "true-value": {
      "type": "Any",
      "desc": "What model value should be considered as checked/ticked/on?",
      "default": "true",
      "examples": ["'Agreed'"],
      "category": "model"
    },

    "false-value": {
      "type": "Any",
      "desc": "What model value should be considered as unchecked/unticked/off?",
      "default": "false",
      "examples": ["'Disagree'"],
      "category": "model"
    },

    "indeterminate-value": {
      "type": "Any",
      "desc": "What model value should be considered as 'indeterminate'?",
      "default": "null",
      "examples": ["0", "'not_answered'"],
      "category": "model"
    },

    "toggle-order": {
      "type": "String",
      "desc": "Determines toggle order of the two states ('t' stands for state of true, 'f' for state of false); If 'toggle-indeterminate' is true, then the order is: indet -> first state -> second state -> indet (and repeat), otherwise: indet -> first state -> second state -> first state -> second state -> ...",
      "values": ["'tf'", "'ft'"],
      "category": "behavior"
    },

    "toggle-indeterminate": {
      "type": "Boolean",
      "desc": "When user clicks/taps on the component, should we toggle through the indeterminate state too?",
      "category": "behavior"
    },

    "label": {
      "type": "String",
      "desc": "Label to display along the component (or use the default slot instead of this prop)",
      "examples": ["'I agree with the Terms and Conditions'"],
      "category": "label"
    },

    "left-label": {
      "type": "Boolean",
      "desc": "Label (if any specified) should be displayed on the left side of the component",
      "category": "label"
    },

    "checked-icon": {
      "type": "String",
      "examples": ["'visibility'"],
      "category": "icons"
    },

    "unchecked-icon": {
      "type": "String",
      "examples": ["'visibility_off'"],
      "category": "icons"
    },

    "indeterminate-icon": {
      "type": "String",
      "examples": ["'help'"],
      "category": "icons"
    },

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

    "keep-color": {
      "type": "Boolean",
      "desc": "Should the color (if specified any) be kept when the component is unticked/ off?",
      "category": "behavior"
    },

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

    "dense": {
      "extends": "dense"
    },

    "disable": {
      "extends": "disable"
    },

    "tabindex": {
      "extends": "tabindex"
    }
  },

  "events": {
    "update:model-value": {
      "desc": "Emitted when the component needs to change the model; Is also used by v-model",
      "params": {
        "value": {
          "type": "Any",
          "desc": "New model value",
          "required": true
        },
        "evt": {
          "extends": "evt",
          "required": true
        }
      }
    }
  },

  "methods": {
    "toggle": {
      "desc": "Toggle the state (of the model)",
      "params": null,
      "returns": null
    }
  },

  "slots": {
    "default": {
      "desc": "Default slot can be used as label, unless 'label' prop is specified; Suggestion: string"
    }
  }
}