@gitlab/ui/dist/components/base/form/form_input/form_input.documentation.js

GitLab UI Components

import examples from './examples/form_input';

var description = "# Form Input\n\nGeneral user input to be used in forms.\n";

var form_input_documentation = {
  description,
  examples,
  bootstrapComponent: 'b-form-input',
  followsDesignSystem: true,
  propsInfo: {
    size: {
      additionalInfo: 'Maximum width of the input',
      enum: 'formInputSizes'
    }
  },
  events: [{
    event: 'input',
    args: [{
      arg: 'value',
      description: '(String)'
    }],
    description: 'Emitted to update the v-model'
  }, {
    event: 'update',
    args: [{
      arg: 'value',
      description: '(String)'
    }],
    description: `Triggered by user interaction. Emitted after any formatting (not including 'trim' or 'number' props). Useful for getting the currently entered value when the 'debounce' or 'lazy' props are set.`
  }]
};

export default form_input_documentation;