bootstrap-vue/src/components/form-checkbox/package.json

BootstrapVue, with over 40 plugins and more than 80 custom components, custom directives, and over 300 icons, provides one of the most comprehensive implementations of Bootstrap v4 components and grid system for Vue.js. With extensive and automated WAI-AR

{
  "name": "@bootstrap-vue/form-checkbox",
  "version": "1.0.0",
  "meta": {
    "title": "Form Checkbox",
    "description": "Custom checkbox input and checkbox group to replace the browser default checkbox input, built on top of semantic and accessible markup. Optionally supports switch styling.",
    "components": [
      {
        "component": "BFormCheckboxGroup",
        "aliases": [
          "BCheckboxGroup",
          "BCheckGroup"
        ],
        "props": [
          {
            "prop": "stacked",
            "description": "When set, renders the checkbox group in stacked mode"
          },
          {
            "prop": "switches",
            "description": "When set, renders the checkboxes in the group with switch styling"
          },
          {
            "prop": "buttons",
            "description": "When set, renderes the checkboxes in this group with button styling"
          },
          {
            "prop": "buttonVariant",
            "description": "Specifies the Bootstrap contextual color theme variant the apply to the button style checkboxes"
          },
          {
            "prop": "checked",
            "description": "The current value of the checked checkboxes in the group. Must be an array when there are multiple checkboxes"
          },
          {
            "prop": "validated",
            "description": "When set, adds the Bootstrap class 'was-validated' to the group wrapper"
          },
          {
            "prop": "ariaInvalid",
            "description": "Sets the 'aria-invalid' attribute value on the wrapper element. When not provided, the 'state' prop will control the attribute"
          }
        ],
        "slots": [
          {
            "name": "first",
            "description": "Slot to place b-form-checks so that they appear before checks generated from options prop"
          }
        ],
        "events": [
          {
            "event": "input",
            "description": "Emitted when the checked value is changed",
            "args": [
              {
                "arg": "checked",
                "type": "Array",
                "description": "Value of checkboxes. Value will be an array."
              }
            ]
          },
          {
            "event": "change",
            "description": "Emitted when selected value(s) is changed due to user interaction",
            "args": [
              {
                "arg": "checked",
                "type": "Array",
                "description": "Value of checkboxes. Value will be an array."
              }
            ]
          }
        ]
      },
      {
        "component": "BFormCheckbox",
        "aliases": [
          "BCheckbox",
          "BCheck"
        ],
        "props": [
          {
            "prop": "checked",
            "description": "The current value of the checkbox(es). Must be an array when there are multiple checkboxes bound to the same v-model"
          },
          {
            "prop": "value",
            "description": "Value returned when this checkbox is checked"
          },
          {
            "prop": "uncheckedValue",
            "description": "Value returned when this checkbox is unchecked. Note not applicable when multiple checkboxes bound to the same v-model array"
          },
          {
            "prop": "inline",
            "description": "When set, renders the checkbox as an inline element rather than as a 100% width block"
          },
          {
            "prop": "switch",
            "description": "When set, renders the checkbox with the appearance of a switch"
          },
          {
            "prop": "button",
            "description": "When set, renders the checkbox with the appearance of a button"
          },
          {
            "prop": "buttonVariant",
            "description": "Applies on of Bootstrap's theme colors when in 'button' mode"
          },
          {
            "prop": "indeterminate",
            "description": "Renders the checkbox in an indeterminate state. Syncable via the .sync modifier"
          }
        ],
        "events": [
          {
            "event": "input",
            "description": "Emitted when the selected value(s) is changed",
            "args": [
              {
                "arg": "checked",
                "type": [
                  "Boolean",
                  "String",
                  "Number",
                  "Object",
                  "Array"
                ],
                "description": "Value of checkbox(es). When bound to multiple checkboxes, value will be an array."
              }
            ]
          },
          {
            "event": "change",
            "description": "Emitted when selected value(s) is changed due to user interaction",
            "args": [
              {
                "arg": "checked",
                "type": [
                  "Boolean",
                  "String",
                  "Number",
                  "Object",
                  "Array"
                ],
                "description": "Value of checkbox(es). When bound to multiple checkboxes, value will be an array."
              }
            ]
          }
        ]
      }
    ]
  }
}