text-tool.md

Text

A text dev tool allows you to store, update, and consume string, integer, and floating-point configuration values.

🤖 Android	🍏 iOS
	Not ready yet.

Parameters

Name	Type	Default	Optional	Description
title	string	""	➕	A tool title that will be displayed inside the configuration screen.
description	string	""	➕	A short description explaining what the configuration value is doing and what changes might bring its update.
canBeDisabled	boolean	false	➕	Will add a checkbox to the tool, which will allow disabling it.
defaultEnabledValue	boolean	true	➕	The tool will be enabled by default if true and disabled vice-versa.
isCritical	boolean	false	➕	The tool which will have it set to true will trigger critical updates.
hint	string	""	➕	A short configuration value description. It will be shown as a hint inside the input field whenever it will be empty.
default	string integer float	n/a	➖	The default configuration value, any text or number.

Sources

Yaml

Below is an example of a text tool configuration in YML format. Note that you should use the !text type.

text-tool: !text {
  title: "Text tool (String)",
  description: "A text configuration value tool",
  canBeDisabled: true,
  defaultEnabledValue: false,
  isCritical: false,
  default: "Here can go any text value",
  hint: "String config value"
}

Json

Below is an example of a text tool configuration in JSON Schema format. Note that you should add the "type": "string" to the configuration object to make it map to a text tool.

"text-tool": {
  "type": "string",
  "title": "Text tool (String)",
  "description": "A text configuration value tool",
  "canBeDisabled": true,
  "defaultEnabledValue": false,
  "isCritical": false,
  "default": "String config value",
  "hint": "String config value"
}

Memory

🍏 iOS

TBA 

🤖 Android

val tool = TextTool(default = "Here can go any text value", hint = "String config value")

tool.title = "Text tool (String)"
tool.description = "A text configuration value tool"
tool.canBeDisabled = true
tool.defaultEnabledValue = false
tool.isCritical = false