package.json 3.23 KB
{
  "name": "@bootstrap-vue/button",
  "version": "1.0.0",
  "meta": {
    "title": "Button",
    "description": "Use BootstrapVue's <b-button> component for actions in forms, dialogs, and more. Includes support for a handful of contextual variations, sizes, states, and more.",
    "components": [
      {
        "component": "BButton",
        "aliases": [
          "BBtn"
        ],
        "props": [
          {
            "prop": "block",
            "description": "Renders a 100% width button (expands to the width of its parent container)"
          },
          {
            "prop": "pill",
            "description": "Renders the button with the pill style appearance when set to 'true'"
          },
          {
            "prop": "pressed",
            "description": "When set to 'true', gives the button the appearance of being pressed and adds attribute 'aria-pressed=\"true\"'. When set to `false` adds attribute 'aria-pressed=\"false\"'. Tri-state prop. Syncable with the .sync modifier"
          },
          {
            "prop": "size",
            "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'"
          },
          {
            "prop": "squared",
            "description": "Renders the button with non-rounded corners when set to 'true'"
          },
          {
            "prop": "type",
            "description": "The value to set the button's 'type' attribute to. Can be one of 'button', 'submit', or 'reset'"
          },
          {
            "prop": "variant",
            "description": "Applies one of the Bootstrap theme color variants to the component"
          }
        ],
        "events": [
          {
            "event": "click",
            "description": "Emitted when non-disabled button clicked",
            "args": [
              {
                "name": "event",
                "type": "MouseEvent",
                "description": "Native click event object"
              }
            ]
          }
        ],
        "slots": [
          {
            "name": "default",
            "description": "Content to place in the button"
          }
        ]
      },
      {
        "component": "BButtonClose",
        "aliases": [
          "BBtnClose"
        ],
        "props": [
          {
            "prop": "ariaLabel",
            "description": "Sets the value of 'aria-label' attribute on the rendered element"
          },
          {
            "prop": "content",
            "version": "2.3.0",
            "description": "The content of the close button"
          },
          {
            "prop": "textVariant",
            "description": "Applies one of the Bootstrap theme color variants to the text"
          }
        ],
        "events": [
          {
            "event": "click",
            "description": "Emitted when non-disabled button clicked",
            "args": [
              {
                "name": "event",
                "type": "MouseEvent",
                "description": "Native click event object"
              }
            ]
          }
        ],
        "slots": [
          {
            "name": "default",
            "description": "Content to place in the button. Overrides the `content` prop"
          }
        ]
      }
    ]
  }
}