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

GitLab UI Components

import examples from './examples';

var description = "> Note: This component is deprecated. Please `<gl-button>` instead as it conforms to the\n> [design specs](https://design.gitlab.com/components/button/). More information can be found in\n> this [migration issue](https://gitlab.com/gitlab-org/gitlab-ui/-/issues/608).\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>`]: https://gitlab.com/gitlab-org/gitlab-ui/blob/master/documentation/link.md\n\n#### Deprecated Prop Values\n\nWe are deprecating certain `variant` values in order to align this component with the [Pajamas design specs]. The following `variant` values have been deprecated:\n\n| Deprecated Value  | Current Equivalent                |\n| ----------------- | --------------------------------- |\n| `primary`         | `info` (category: `primary`)      |\n| `secondary`       | `null` (category: `tertiary`)     |\n| `outline-info`    | `info` (category: `secondary`)    |\n| `outline-success` | `success` (category: `secondary`) |\n| `outline-warning` | `warning` (category: `secondary`) |\n| `outline-danger`  | `danger` (category: `secondary`)  |\n| `dark`            | _no equivalent_                   |\n| `light`           | _no equivalent_                   |\n\n[pajamas design specs]: https://design.gitlab.com/components/buttons\n";

var deprecated_button_documentation = {
  description: description,
  examples: examples,
  bootstrapComponent: 'b-button',
  bootstrapPropsInfo: {
    variant: {
      enum: 'buttonVariantOptions'
    }
  },
  events: [{
    event: 'click',
    description: 'Emitted when clicked on button'
  }]
};

export default deprecated_button_documentation;