bootstrap-vue/src/components/avatar/package.json

With more than 85 components, over 45 available plugins, several directives, and 1000+ icons, BootstrapVue provides one of the most comprehensive implementations of the Bootstrap v4 component and grid system available for Vue.js v2.6, complete with extens

{
  "name": "@bootstrap-vue/avatar",
  "version": "1.0.0",
  "meta": {
    "title": "Avatar",
    "version": "2.8.0",
    "description": "Avatars are typically used to display a user profile as a picture, an icon, or short text.",
    "components": [
      {
        "component": "BAvatar",
        "version": "2.8.0",
        "props": [
          {
            "prop": "alt",
            "version": "2.9.0",
            "description": "Value to place in the 'alt' attribute for image and icon avatars"
          },
          {
            "prop": "badge",
            "version": "2.12.0",
            "description": "When `true` shows an empty badge on the avatar, alternatively set to a string for content in the badge"
          },
          {
            "prop": "badgeLeft",
            "version": "2.12.0",
            "description": "When `true` places the badge at the left instead of the right"
          },
          {
            "prop": "badgeOffset",
            "version": "2.12.0",
            "description": "CSS length to offset the badge. Positive values move the badge inwards, while negative values move the badge outwards"
          },
          {
            "prop": "badgeTop",
            "version": "2.12.0",
            "description": "When `true` places the badge at the top instead of the bottom"
          },
          {
            "prop": "badgeVariant",
            "version": "2.12.0",
            "description": "Applies one of the Bootstrap theme color variants to the badge"
          },
          {
            "prop": "button",
            "description": "When set to `true`, renders the avatar as a button"
          },
          {
            "prop": "buttonType",
            "description": "Type of button to render (i.e. `button`, `submit`, `reset`). Has no effect if prop button is not set"
          },
          {
            "prop": "icon",
            "description": "Icon name to use for the avatar. Must be all lowercase. Defaults to `person-fill` if `text` or `src` props not provided"
          },
          {
            "prop": "rounded",
            "description": "Specifies the type of rounding to apply to the avatar. The `square` prop takes precedence. Refer to the documentation for details"
          },
          {
            "prop": "size",
            "description": "Size of the avatar. Refer to the documentation for details"
          },
          {
            "prop": "square",
            "description": "Disables rounding of the avatar, rending the avatar with square corners"
          },
          {
            "prop": "src",
            "description": "Image URL to use for the avatar"
          },
          {
            "prop": "text",
            "description": "Text to place in the avatar"
          },
          {
            "prop": "variant",
            "description": "Applies one of the Bootstrap theme color variants to the component"
          }
        ],
        "slots": [
          {
            "name": "badge",
            "version": "2.12.0",
            "description": "Content to place in the avatars optional badge. Overrides the `badge` prop"
          },
          {
            "name": "default",
            "description": "Content to place in the avatar. Overrides props `text`, `src`, and `icon-name`"
          }
        ],
        "events": [
          {
            "event": "click",
            "description": "Emitted when the avatar is clicked when rendered as a button or link. Not emitted otherwise",
            "args": [
              {
                "arg": "event",
                "description": "Native Event object"
              }
            ]
          },
          {
            "event": "img-error",
            "version": "2.11.0",
            "description": "Emitted if an image `src` is provided and the image fails to load",
            "args": [
              {
                "arg": "event",
                "description": "Native Event object"
              }
            ]
          }
        ]
      },
      {
        "component": "BAvatarGroup",
        "version": "2.14.0",
        "props": [
          {
            "prop": "overlap",
            "description": "Floating point number specifying the amount of overlap where `0` is no overlap and `1` is 100% overlap"
          },
          {
            "prop": "rounded",
            "description": "Specifies the type of rounding to apply to the child avatars. The `square` prop takes precedence. Refer to the documentation for details"
          },
          {
            "prop": "size",
            "description": "Size of all the child avatars. Refer to the documentation for details"
          },
          {
            "prop": "square",
            "description": "Disables rounding of the child avatars, rendering each avatar with square corners"
          },
          {
            "prop": "variant",
            "description": "Applies one of the Bootstrap theme color variants to all child avatars"
          }
        ],
        "slots": [
          {
            "name": "default",
            "description": "Content (avatars) to place in the avatar group"
          }
        ]
      }
    ]
  }
}