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

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

{
  "name": "@bootstrap-vue/form-input",
  "version": "1.1.0",
  "meta": {
    "title": "Form Input",
    "description": "Create various type inputs such as: text, password, number, url, email, search, range, date and more.",
    "components": [
      {
        "component": "BFormInput",
        "aliases": [
          "BInput"
        ],
        "props": [
          {
            "prop": "value",
            "description": "The current value of the input.  Result will always be a string, except when the 'number' prop is used"
          },
          {
            "prop": "ariaInvalid",
            "description": "Sets the 'aria-invalid' attribute with the specified value"
          },
          {
            "prop": "trim",
            "description": "When set, trims any leading and trailing white space from the input value. Emulates the Vue '.trim' v-model modifier"
          },
          {
            "prop": "number",
            "description": "When set attempts to convert the input value to a native number. Emulates the Vue '.number' v-model modifier"
          },
          {
            "prop": "lazy",
            "version": "2.1.0",
            "description": "When set, updates the v-model on 'change'/'blur' events instead of 'input'. Emulates the Vue '.lazy' v-model modifier"
          },
          {
            "prop": "debounce",
            "version": "2.1.0",
            "description": "When set to a number of milliseconds greater than zero, will debounce the user input. Has no effect if prop 'lazy' is set"
          },
          {
            "prop": "type",
            "description": "The type of input to render. See the docs for supported types"
          },
          {
            "prop": "noWheel",
            "description": "For number-like inputs, disables the mouse wheel from incrementing or decrementing the value"
          },
          {
            "prop": "list",
            "description": "The ID of the associated datalist element or component"
          },
          {
            "prop": "formatter",
            "description": "reference to a function for formatting the input"
          },
          {
            "prop": "lazyFormatter",
            "description": "When set, the input is formatted on blur instead of each keystroke (if there is a formatter specified)"
          },
          {
            "prop": "min",
            "description": "Value to set in the 'min' attribute on the input. Used by number-like inputs"
          },
          {
            "prop": "max",
            "description": "Value to set in the 'max' attribute on the input. Used by number-like inputs"
          },
          {
            "prop": "step",
            "description": "Value to set in the 'step' attribute on the input. Used by number-like inputs"
          }
        ],
        "events": [
          {
            "event": "input",
            "description": "Input event triggered by user interaction. Emitted after any formatting (not including 'trim' or 'number' props) and after the v-model is updated",
            "args": [
              {
                "arg": "value",
                "type": [
                  "String",
                  "Number"
                ],
                "description": "Current value of input"
              }
            ]
          },
          {
            "event": "change",
            "description": "Change event triggered by user interaction. Emitted after any formatting (not including 'trim' or 'number' props) and after the v-model is updated.",
            "args": [
              {
                "arg": "value",
                "type": [
                  "String",
                  "Number"
                ],
                "description": "Current value of input"
              }
            ]
          },
          {
            "event": "update",
            "description": "Emitted to update the v-model",
            "args": [
              {
                "arg": "value",
                "type": [
                  "String",
                  "Number"
                ],
                "description": "Value of input, after any formatting. Not emitted if the value does not change"
              }
            ]
          },
          {
            "event": "blur",
            "description": "Emitted after the input looses focus",
            "args": [
              {
                "arg": "event",
                "type": "FocusEvent",
                "description": "Native blur event (before any formatting)"
              }
            ]
          }
        ]
      }
    ]
  }
}