package.web-types.lit.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of avatar Show documentation
vaadin-avatar
The newest version!
{
  "$schema": "https://json.schemastore.org/web-types",
  "name": "@vaadin/avatar",
  "version": "24.6.0",
  "description-markup": "markdown",
  "framework": "lit",
  "framework-config": {
    "enable-when": {
      "node-packages": [
        "lit"
      ]
    }
  },
  "contributions": {
    "html": {
      "elements": [
        {
          "name": "vaadin-avatar",
          "description": "`` is a Web Component providing avatar displaying functionality.\n\n```html\n\n```\n\n### Styling\n\nThe following shadow DOM parts are exposed for styling:\n\nPart name | Description\n--------- | ---------------\n`abbr`    | The abbreviation element\n`icon`    | The icon element\n\nThe following state attributes are available for styling:\n\nAttribute         | Description\n------------------|-------------\n`focus-ring`      | Set when the avatar is focused using the keyboard.\n`focused`         | Set when the avatar is focused.\n`has-color-index` | Set when the avatar has `colorIndex` and the corresponding custom CSS property exists.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
          "extension": true,
          "attributes": [
            {
              "name": "?withTooltip",
              "description": "When true, the avatar has tooltip shown on hover and focus.\nThe tooltip text is based on the `name` and `abbr` properties.\nWhen neither is provided, `i18n.anonymous` is used instead.",
              "value": {
                "kind": "expression"
              }
            },
            {
              "name": ".img",
              "description": "The path to the image",
              "value": {
                "kind": "expression"
              }
            },
            {
              "name": ".abbr",
              "description": "A shortened form of name that is displayed\nin the avatar when `img` is not provided.",
              "value": {
                "kind": "expression"
              }
            },
            {
              "name": ".name",
              "description": "Full name of the user\nused for the tooltip of the avatar.",
              "value": {
                "kind": "expression"
              }
            },
            {
              "name": ".colorIndex",
              "description": "Color index used for avatar background.",
              "value": {
                "kind": "expression"
              }
            },
            {
              "name": ".i18n",
              "description": "The object used to localize this component.\nTo change the default localization, replace the entire\n_i18n_ object or just the property you want to modify.\n\nThe object has the following JSON structure and default values:\n\n```\n{\n  // Translation of the anonymous user avatar tooltip.\n  anonymous: 'anonymous'\n}\n```",
              "value": {
                "kind": "expression"
              }
            }
          ]
        }
      ]
    }
  }
}