Skip to main content
Community Hub

Input

TL;DR

Use the input widget to collect plain-text values—such as hostnames, usernames, or schema names—in your app's setup form.

Your AI can read this via Docs MCPcurl -fsSL "https://docs.atlan.com/install-docs-mcp" | bashConnect

The input widget provides a text input field for capturing user data in your Atlan app. It supports placeholder text, validation rules, help text, and feedback messages. Use the input widget whenever you need users to enter text values that are displayed in plain text.

Input widget screenshot

How it works​

The input widget:

  • Displays a single-line text input field
  • Supports placeholder text and help messages
  • Provides validation feedback for user input
  • Integrates with form validation rules
  • Supports responsive grid layout

Props​

The input widget supports placeholder, maxLength, help, feedback, grid, label, id, required, and rules. For more information, see Widget properties.

How to use​

The input widget is configured using standard widget properties. In the example below, the widget captures a database username with validation rules and responsive grid layout:

{
  "dbuser": {
    "type": "string",
    "required": true,
    "ui": {
      "widget": "input",
      "label": "Username",
      "placeholder": "Username",
      "help": "Redshift database username",
      "feedback": true,
      "message": "Please enter a valid username",
      "grid": 4,
      "rules": [
        {
          "required": true,
          "message": "Please enter a valid username"
        }
      ]
    }
  }
}

See also​

  • Password—Use for sensitive input that requires masking
  • Credential—Use for secure credential storage
  • Widget properties—Complete reference for properties shared across all widgets

Need help​

If you face any issues or need help with input widget configuration, contact Atlan support by submitting a support request.