Widgets reference

There are a number of input widgets you can use when defining your inputs. For more details about the configurable options of each of these individual widgets, use hover-over context help in your IDE when writing your package.

APITokenSelector

inputs {
  ["var_name_a"] = new APITokenSelector {
    title = "API Token Selector (title)"
    required = false
    helpText = "Example for API token selector widget (helpText)."
    showAll = true // (1)!
  }
}

1. Controls whether to show all API tokens (true) or only the API tokens created by the user configuring the package (false).

BooleanInput

inputs {
  ["var_name_b"] = new BooleanInput {
    title = "Boolean Input (title)"
    required = false
    helpText = "Example for boolean input widget (helpText)."
    defaultSelection = true
  }
}

ConnectionCreator

inputs {
  ["var_name_c"] = new ConnectionCreator {
    title = "Connection Creator (title)"
    required = false
    helpText = "Example for connection creator widget (helpText)."
    width = 8
  }
}

ConnectionSelector

inputs {
  ["var_name_d"] = new ConnectionSelector {
    title = "Connection Selector single (title)"
    required = false
    helpText = "Example for connection selector widget (helpText)."
    multiSelect = false
    limitToConnectors = "snowflake" // (1)!
  }
  ["var_name_e"] = new ConnectionSelector {
    title = "Connection Selector multi (title)"
    required = false
    helpText = "Example for connection selector widget (helpText)."
    multiSelect = true
    limitToConnectors = { "snowflake" "bigquery" }
  }
}

1. Limits the connections listed to only those with the specified connector type, which can either be a single string or a list. (If this limitToConnectors is left out entirely, all connections will be included in the drop-down.)

ConnectorTypeSelector

inputs {
  ["var_name_f"] = new ConnectorTypeSelector {
    title = "Connector Type Selector (title)"
    required = false
    helpText = "Example for connector type selector widget (helpText)."
    width = 8
  }
}

CredentialInput

inputs {
  ["var_name_g"] = new CredentialInput {
    title = "Credential (title)"
    credType = "atlan-connectors-snowflake" // (1)
    helpText = "Example for connector type selector widget (helpText)."
    allowTestAuthentication = true // (2)
  }
}

1. The value used for credType must match an existing credential defined in packages/atlan/connectors/configmaps/*.yaml, whether pre-existing or generated through the use of credentialConfig and placed there yourself.
2. You can remove the green Test Authentication button by setting allowTestAuthentication to false. (If left out entirely, it will default to true.)

DateInput

inputs {
  ["var_name_h"] = new DateInput {
    title = "Date Input (title)"
    required = false
    helpText = "Example for date input widget (helpText)."
    past = -14 // (1)
    future = 14 // (2)
    defaultDay = -1 // (3)
    width = 8
  }
}

1. An offset from today (0) that indicates how far back in the calendar can be selected (-1 is yesterday, 1 is tomorrow, and so on).
2. An offset from today (0) that indicates how far forward in the calendar can be selected (-1 is yesterday, 1 is tomorrow, and so on).
3. An offset from today that indicates the default date that should be selected in the calendar (0 is today, -1 is yesterday, 1 is tomorrow, and so on).

DropDown

inputs {
  ["var_name_i"] = new DropDown {
    title = "Drop Down single (title)"
    required = false
    helpText = "Example for drop down widget (restricted to a single) (helpText)."
    possibleValues {
      ["ONE"] = "One"
      ["TWO"] = "Two"
      ["THREE"] = "Three"
    }
    multiSelect = false
    width = 4
  }
  ["var_name_j"] = new DropDown {
    title = "Drop Down multi (title)"
    required = false
    helpText = "Example for drop down widget (allowing multiple) (helpText)."
    possibleValues {
      ["ONE"] = "One"
      ["TWO"] = "Two"
      ["THREE"] = "Three"
    }
    multiSelect = true
    width = 4
  }
}

FileCopier

inputs {
  ["var_name_k"] = new FileCopier {
    title = "File Copier (title)"
    required = false
    helpText = "Example for file copier widget (helpText)."
    placeholderText = "path/file.csv (placeholderText)"
    width = 8
  }
}

FileUploader

inputs {
  ["var_name_l"] = new FileUploader {
    title = "File Uploader (title)"
    required = false
    helpText = "Example for file uploader widget (helpText)."
    placeholderText = "Sample CSV file (placeholderText)"
    fileTypes { // (1)!
      "text/csv"
    }
    width = 8
  }
}

1. A list of the mime-types that the upload widget will accept. If someone tries to upload a file of a different type, it will be rejected automatically by the UI itself.

KeygenInput

inputs {
  ["var_name_m"] = new KeygenInput {
    title = "Keygen Input (title)"
    required = false
    helpText = "Example for keygen input widget (helpText)."
    width = 8
  }
}

MultipleGroups / SingleGroup

inputs {
  ["var_name_n"] = new SingleGroup {
    title = "Single Group (title)"
    required = false
    helpText = "Example for single group widget (helpText)."
    width = 4
  }
  ["var_name_o"] = new MultipleGroups {
    title = "Multiple Groups (title)"
    required = false
    helpText = "Example for multiple groups widget (helpText)."
    width = 4
  }
}

MultipleUsers / SingleUser

inputs {
  ["var_name_p"] = new SingleUser {
    title = "Single User (title)"
    required = false
    helpText = "Example for single user widget (helpText)."
    width = 4
  }
  ["var_name_q"] = new MultipleUsers {
    title = "Multiple Users (title)"
    required = false
    helpText = "Example for multiple users widget (helpText)."
    width = 4
  }
}

NumericInput

inputs {
  ["var_name_r"] = new NumericInput {
    title = "Numeric Input (title)"
    required = false
    helpText = "Example for numeric input widget (helpText)."
    placeholderValue = 50
    width = 8
  }
}

PasswordInput

inputs {
  ["var_name_s"] = new PasswordInput {
    title = "Password Input (title)"
    required = false
    helpText = "Example for password input widget (helpText)."
    width = 8
  }
}

Radio

inputs {
  ["var_name_t"] = new Radio {
    title = "Radio (title)"
    required = false
    helpText = "Example for radio widget (helpText)."
    possibleValues {
      ["ONE"] = "One (value)"
      ["TWO"] = "Two (value)"
      ["THREE"] = "Three (value)"
    }
    default = "TWO"
  }
}

TextInput

inputs {
  ["var_name_u"] = new TextInput {
    title = "Text Input (title)"
    required = false
    helpText = "Example for text input widget (helpText)."
    width = 8
  }
}

---