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

GitLab UI Components

import examples from './examples';

var description = "# Avatar labeled\n\n<!-- STORY -->\n## Usage\n\nAvatars may also be adjacent to a text alternative, such as a user or project name. In these cases,\na null `alt` text should be used so that they can be ignored by assistive technologies.\n\nUse the `avatar-labeled` component in those scenarios. It will set a null `alt` text by default.\nIt allows to display a `label` and/or a `sub-label` next to the avatar image. It accepts the same\nproperties as the avatar component to modify the avatar’s shape and size.\n\n## Using the component\n\n~~~js\n<gl-avatar-labeled\n  :shape=\"shape\"\n  :size=\"size\"\n  :src=\"src\"\n  :label=\"label\"\n  :sub-label=\"subLabel\"\n/>\n~~~\n";

var avatar_labeled_documentation = {
  followsDesignSystem: true,
  description,
  examples,
  slots: [{
    name: 'meta',
    description: 'Meta data to add to the avatar. Generally used for badges or user status emoji.'
  }]
};

export default avatar_labeled_documentation;