@gitlab/ui/dist/components/base/button/button.documentation.js

GitLab UI Components

import examples from './examples';

var description = "### Button\n\nButtons execute an action, either in the background or foreground of an experience. Different button categories help guide users through certain actions. Buttons express what action will occur when the user clicks or touches it either by text, icon, or both. Additional meaning can be derived from the button variant.\n\n### Button link\n\nA button link is a link that is styled to look like a button, semantically speaking it's a `<a>` tag\nwith the necessary classes added to make it look like a button, it shares the same functionality as [`<gl-link>`]\n\n> Note: Setting a `target` attribute without a `href` attribute, will not create any side effects. Without the presence of a `href` attribute, this component will render a `<button>`.\n\n[`<gl-link>`]: ./?path=/story/base-link--default-link\n";

var button_documentation = {
  description: description,
  examples: examples,
  followsDesignSystem: true,
  bootstrapComponent: 'b-button',
  bootstrapPropsInfo: {
    category: {
      enum: 'newButtonCategoryOptions'
    },
    variant: {
      enum: 'newButtonVariantOptions'
    },
    size: {
      enum: 'newButtonSizeOptions'
    }
  },
  events: [{
    event: 'click',
    description: 'Emitted when clicked on button'
  }]
};

export default button_documentation;