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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of message-input Show documentation
vaadin-message-input
There is a newer version: 24.6.0
{
  "$schema": "https://json.schemastore.org/web-types",
  "name": "@vaadin/message-input",
  "version": "24.5.3",
  "description-markup": "markdown",
  "contributions": {
    "html": {
      "elements": [
        {
          "name": "vaadin-message-input",
          "description": "`` is a Web Component for sending messages.\nIt consists of a text area that grows on along with the content, and a send button to send message.\n\nThe message can be sent by one of the following actions:\n- by pressing Enter (use Shift + Enter to add a new line)\n- by clicking `submit` button.\n\n```html\n\n```",
          "attributes": [
            {
              "name": "value",
              "description": "Current content of the text input field",
              "value": {
                "type": [
                  "string",
                  "null",
                  "undefined"
                ]
              }
            },
            {
              "name": "disabled",
              "description": "Set to true to disable this element.",
              "value": {
                "type": [
                  "boolean"
                ]
              }
            },
            {
              "name": "theme",
              "description": "The theme variants to apply to the component.",
              "value": {
                "type": [
                  "string",
                  "null",
                  "undefined"
                ]
              }
            }
          ],
          "js": {
            "properties": [
              {
                "name": "value",
                "description": "Current content of the text input field",
                "value": {
                  "type": [
                    "string",
                    "null",
                    "undefined"
                  ]
                }
              },
              {
                "name": "i18n",
                "description": "The object used to localize this component.\nFor changing the default localization, change the entire\n`i18n` object.\n\nThe object has the following JSON structure and default values:\n\n```\n{\n  // Used as the button label\n  send: 'Send',\n\n  // Used as the input field's placeholder and aria-label\n  message: 'Message'\n}\n```",
                "value": {
                  "type": [
                    "MessageInputI18n"
                  ]
                }
              },
              {
                "name": "disabled",
                "description": "Set to true to disable this element.",
                "value": {
                  "type": [
                    "boolean"
                  ]
                }
              }
            ],
            "events": [
              {
                "name": "submit",
                "description": "Fired when a new message is submitted with ``, either\nby clicking the \"send\" button, or pressing the Enter key."
              }
            ]
          }
        }
      ]
    }
  }
}