{
  "name": "alert",
  "componentName": "Alert",
  "displayName": "Alert",
  "regions": [
    {
      "name": "action",
      "description": "Specifies an action for the alert message.\nAlthough it is technically possible to insert any content, our UX guidelines only allow you to add a button.",
      "isDefault": false,
      "displayName": "action"
    },
    {
      "name": "children",
      "description": "Primary text displayed in the element.",
      "isDefault": true,
      "displayName": "content"
    },
    {
      "name": "header",
      "description": "Heading text.",
      "isDefault": false,
      "displayName": "header"
    }
  ],
  "functions": [
    {
      "name": "focus",
      "description": "Sets focus on the alert content.",
      "returnType": "void",
      "parameters": []
    }
  ],
  "properties": [
    {
      "name": "analyticsMetadata",
      "type": "AlertProps.AnalyticsMetadata",
      "inlineType": {
        "name": "AlertProps.AnalyticsMetadata",
        "type": "object",
        "properties": [
          {
            "name": "errorContext",
            "optional": true,
            "type": "ErrorContext",
            "inlineType": {
              "name": "ErrorContext",
              "type": "object",
              "properties": [
                {
                  "name": "errorCategory",
                  "optional": false,
                  "type": "string",
                  "inlineType": {
                    "name": "ErrorCategory",
                    "type": "union",
                    "values": [
                      "OTHER",
                      "INPUT_VALIDATION",
                      "PERMISSION_IAM",
                      "RESOURCE_AVAILABILITY",
                      "NETWORK_CONNECTIVITY",
                      "SERVICE_QUOTAS_LIMITS",
                      "CONFIGURATION_CONFLICTS",
                      "API_SPECIFIC"
                    ]
                  }
                },
                {
                  "name": "errorMessage",
                  "optional": false,
                  "type": "string"
                },
                {
                  "name": "errorSubCategory",
                  "optional": false,
                  "type": "string",
                  "inlineType": {
                    "name": "ErrorSubCategory",
                    "type": "union",
                    "values": [
                      "DATA_FORMAT_ISSUES",
                      "PARAMETER_VALIDATION_ISSUES",
                      "ACCESS_CONTROL_ISSUES",
                      "IDENTITY_MANAGEMENT_PROBLEMS",
                      "RESOURCE_STATE_ISSUES",
                      "RESOURCE_CAPACITY_PROBLEMS",
                      "CONNECTION_PROBLEMS",
                      "NETWORK_CONFIGURATION_ISSUES",
                      "RESOURCE_LIMIT_EXCEEDED",
                      "SERVICE_QUOTA_RESTRICTIONS",
                      "SERVICE_INTEGRATION_CONFLICTS",
                      "RESOURCE_CONFIGURATION_MISMATCHES",
                      "SERVICE_SPECIFIC_OPERATIONS",
                      "API_REQUEST_PROBLEMS",
                      "OTHER"
                    ]
                  }
                }
              ]
            }
          }
        ]
      },
      "optional": true,
      "description": "Specifies additional analytics-related metadata.\n* `errorContext` - Identifies the error category and sub-category.",
      "analyticsTag": "",
      "formattedType": "AlertProps.AnalyticsMetadata {\n  errorContext?: ErrorContext\n}"
    },
    {
      "name": "dismissible",
      "type": "boolean",
      "optional": true,
      "description": "Adds a close button to the alert when set to `true`.\nAn `onDismiss` event is fired when a user clicks the button.",
      "formattedType": "boolean"
    },
    {
      "name": "i18nStrings",
      "type": "AlertProps.I18nStrings",
      "inlineType": {
        "name": "AlertProps.I18nStrings",
        "type": "object",
        "properties": [
          {
            "name": "dismissAriaLabel",
            "optional": true,
            "type": "string"
          },
          {
            "name": "errorIconAriaLabel",
            "optional": true,
            "type": "string"
          },
          {
            "name": "infoIconAriaLabel",
            "optional": true,
            "type": "string"
          },
          {
            "name": "successIconAriaLabel",
            "optional": true,
            "type": "string"
          },
          {
            "name": "warningIconAriaLabel",
            "optional": true,
            "type": "string"
          }
        ]
      },
      "optional": true,
      "description": "An object containing all the necessary localized strings required by the component.",
      "i18nTag": true,
      "formattedType": "AlertProps.I18nStrings {\n  dismissAriaLabel?: string\n  errorIconAriaLabel?: string\n  infoIconAriaLabel?: string\n  successIconAriaLabel?: string\n  warningIconAriaLabel?: string\n}"
    },
    {
      "name": "style",
      "type": "AlertProps.Style",
      "inlineType": {
        "name": "AlertProps.Style",
        "type": "object",
        "properties": [
          {
            "name": "dismissButton",
            "optional": true,
            "type": "{ color?: { active?: string | undefined; default?: string | undefined; hover?: string | undefined; } | undefined; focusRing?: { borderColor?: string | undefined; borderRadius?: string | undefined; borderWidth?: string | undefined; } | undefined; }",
            "inlineType": {
              "name": "object",
              "type": "object",
              "properties": [
                {
                  "name": "color",
                  "optional": true,
                  "type": "{ active?: string | undefined; default?: string | undefined; hover?: string | undefined; }",
                  "inlineType": {
                    "name": "{ active?: string | undefined; default?: string | undefined; hover?: string | undefined; }",
                    "type": "object",
                    "properties": [
                      {
                        "name": "active",
                        "optional": true,
                        "type": "string"
                      },
                      {
                        "name": "default",
                        "optional": true,
                        "type": "string"
                      },
                      {
                        "name": "hover",
                        "optional": true,
                        "type": "string"
                      }
                    ]
                  }
                },
                {
                  "name": "focusRing",
                  "optional": true,
                  "type": "{ borderColor?: string | undefined; borderRadius?: string | undefined; borderWidth?: string | undefined; }",
                  "inlineType": {
                    "name": "object",
                    "type": "object",
                    "properties": [
                      {
                        "name": "borderColor",
                        "optional": true,
                        "type": "string"
                      },
                      {
                        "name": "borderRadius",
                        "optional": true,
                        "type": "string"
                      },
                      {
                        "name": "borderWidth",
                        "optional": true,
                        "type": "string"
                      }
                    ]
                  }
                }
              ]
            }
          },
          {
            "name": "icon",
            "optional": true,
            "type": "{ color?: string | undefined; }",
            "inlineType": {
              "name": "{ color?: string | undefined; }",
              "type": "object",
              "properties": [
                {
                  "name": "color",
                  "optional": true,
                  "type": "string"
                }
              ]
            }
          },
          {
            "name": "root",
            "optional": true,
            "type": "{ background?: string | undefined; borderColor?: string | undefined; borderRadius?: string | undefined; borderWidth?: string | undefined; color?: string | undefined; focusRing?: { ...; } | undefined; }",
            "inlineType": {
              "name": "object",
              "type": "object",
              "properties": [
                {
                  "name": "background",
                  "optional": true,
                  "type": "string"
                },
                {
                  "name": "borderColor",
                  "optional": true,
                  "type": "string"
                },
                {
                  "name": "borderRadius",
                  "optional": true,
                  "type": "string"
                },
                {
                  "name": "borderWidth",
                  "optional": true,
                  "type": "string"
                },
                {
                  "name": "color",
                  "optional": true,
                  "type": "string"
                },
                {
                  "name": "focusRing",
                  "optional": true,
                  "type": "{ borderColor?: string | undefined; borderRadius?: string | undefined; borderWidth?: string | undefined; }",
                  "inlineType": {
                    "name": "object",
                    "type": "object",
                    "properties": [
                      {
                        "name": "borderColor",
                        "optional": true,
                        "type": "string"
                      },
                      {
                        "name": "borderRadius",
                        "optional": true,
                        "type": "string"
                      },
                      {
                        "name": "borderWidth",
                        "optional": true,
                        "type": "string"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      },
      "optional": true,
      "description": "An object containing CSS properties to customize the alert's visual appearance.\nRefer to the [style](/components/alert/?tabId=style) tab for more details.",
      "systemTags": [
        "core"
      ],
      "formattedType": "Object"
    },
    {
      "name": "type",
      "type": "string",
      "inlineType": {
        "name": "AlertProps.Type",
        "type": "union",
        "values": [
          "error",
          "success",
          "warning",
          "info"
        ]
      },
      "optional": true,
      "description": "Specifies the type of message you want to display.",
      "defaultValue": "'info'",
      "formattedType": "string"
    }
  ],
  "events": [
    {
      "name": "onButtonClick",
      "description": "Fired when the user clicks the action button.\n**Deprecated** Replaced by `action`.",
      "cancelable": false
    },
    {
      "name": "onDismiss",
      "description": "Fired when the user clicks the close icon that is displayed\nwhen the `dismissible` property is set to `true`.",
      "cancelable": false
    }
  ],
  "path": "/components/alert"
}