V4: Simple textbox (#5990)

* Simple textbox

* add changeset

* Trim down events

* Trim

* Clean up change event

* Add comment

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>

.changeset/thick-rabbits-wonder.md

@@ -0,0 +1,7 @@
+---
+"@gradio/app": minor
+"@gradio/simpletextbox": minor
+"gradio": minor
+---
+
+feat:V4: Simple textbox

gradio/__init__.py

@@ -1,5 +1,6 @@
 import json
 
+import gradio._simple_templates
 import gradio.components as components
 import gradio.layouts as layouts
 import gradio.processing_utils

gradio/_simple_templates/__init__.py

@@ -0,0 +1,3 @@
+from .simpletextbox import SimpleTextbox
+
+__all__ = ["SimpleTextbox"]

gradio/_simple_templates/simpletextbox.py

@@ -0,0 +1,95 @@
+from __future__ import annotations
+
+from typing import Any, Callable
+
+from gradio.components.base import FormComponent
+from gradio.events import Events
+
+
+class SimpleTextbox(FormComponent):
+    """
+    Creates a textbox for user to enter string input or display string output.
+    Preprocessing: passes textbox value as a {str} into the function.
+    Postprocessing: expects a {str} returned from function and sets textbox value to it.
+    Examples-format: a {str} representing the textbox input.
+    """
+
+    EVENTS = [
+        Events.change,
+        Events.input,
+        Events.submit,
+    ]
+
+    def __init__(
+        self,
+        value: str | Callable | None = "",
+        *,
+        placeholder: str | None = None,
+        label: str | None = None,
+        every: float | None = None,
+        show_label: bool | None = None,
+        scale: int | None = None,
+        min_width: int = 160,
+        interactive: bool | None = None,
+        visible: bool = True,
+        rtl: bool = False,
+        elem_id: str | None = None,
+        elem_classes: list[str] | str | None = None,
+        **kwargs,
+    ):
+        """
+        Parameters:
+            value: default text to provide in textbox. If callable, the function will be called whenever the app loads to set the initial value of the component.
+            placeholder: placeholder hint to provide behind textbox.
+            label: component name in interface.
+            every: If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.
+            show_label: if True, will display label.
+            scale: relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.
+            min_width: minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.
+            interactive: if True, will be rendered as an editable textbox; if False, editing will be disabled. If not provided, this is inferred based on whether the component is used as an input or output.
+            visible: If False, component will be hidden.
+            rtl: If True and `type` is "text", sets the direction of the text to right-to-left (cursor appears on the left of the text). Default is False, which renders cursor on the right.
+            elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
+            elem_classes: An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.
+        """
+        self.placeholder = placeholder
+        self.rtl = rtl
+        super().__init__(
+            label=label,
+            every=every,
+            show_label=show_label,
+            scale=scale,
+            min_width=min_width,
+            interactive=interactive,
+            visible=visible,
+            elem_id=elem_id,
+            elem_classes=elem_classes,
+            value=value,
+            **kwargs,
+        )
+
+    def preprocess(self, x: str | None) -> str | None:
+        """
+        Preprocesses input (converts it to a string) before passing it to the function.
+        Parameters:
+            x: text
+        Returns:
+            text
+        """
+        return None if x is None else str(x)
+
+    def postprocess(self, y: str | None) -> str | None:
+        """
+        Postproccess the function output y by converting it to a str before passing it to the frontend.
+        Parameters:
+            y: function output to postprocess.
+        Returns:
+            text
+        """
+        return None if y is None else str(y)
+
+    def api_info(self) -> dict[str, Any]:
+        return {"type": "string"}
+
+    def example_inputs(self) -> Any:
+        return "Hello!!"

gradio/cli/commands/components/_create_utils.py

@@ -235,6 +235,8 @@ def _create_backend(
         module = "components"
     elif component.template in gradio.layouts.__all__:
         module = "layouts"
+    elif component.template in gradio._simple_templates.__all__:  # type: ignore
+        module = "_simple_templates"
     else:
         raise ValueError(
             f"Cannot find {component.template} in gradio.components or gradio.layouts. "

js/app/package.json

@@ -70,6 +70,7 @@
 		"@gradio/utils": "workspace:^",
 		"@gradio/video": "workspace:^",
 		"@gradio/wasm": "workspace:^",
+		"@gradio/simpletextbox": "workspace:^",
 		"cross-env": "^7.0.3",
 		"d3-dsv": "^3.0.1",
 		"mime-types": "^2.1.34",

js/simpletextbox/Example.svelte

@@ -0,0 +1,46 @@
+<script lang="ts">
+	import { onMount } from "svelte";
+
+	export let value: string;
+	export let type: "gallery" | "table";
+	export let selected = false;
+
+	let size: number;
+	let el: HTMLDivElement;
+
+	function set_styles(element: HTMLElement, el_width: number): void {
+		if (!element || !el_width) return;
+		el.style.setProperty(
+			"--local-text-width",
+			`${el_width < 150 ? el_width : 200}px`
+		);
+		el.style.whiteSpace = "unset";
+	}
+
+	onMount(() => {
+		set_styles(el, size);
+	});
+</script>
+
+<div
+	bind:clientWidth={size}
+	bind:this={el}
+	class:table={type === "table"}
+	class:gallery={type === "gallery"}
+	class:selected
+>
+	{value}
+</div>
+
+<style>
+	.gallery {
+		padding: var(--size-1) var(--size-2);
+	}
+
+	div {
+		overflow: hidden;
+		min-width: var(--local-text-width);
+
+		white-space: nowrap;
+	}
+</style>

js/simpletextbox/Index.svelte

@@ -0,0 +1,127 @@
+<svelte:options accessors={true} />
+
+<script lang="ts">
+	import type { Gradio } from "@gradio/utils";
+	import { BlockTitle } from "@gradio/atoms";
+	import { Block } from "@gradio/atoms";
+	import { StatusTracker } from "@gradio/statustracker";
+	import type { LoadingStatus } from "@gradio/statustracker";
+	import { tick } from "svelte";
+
+	export let gradio: Gradio<{
+		change: never;
+		submit: never;
+		input: never;
+	}>;
+	export let label = "Textbox";
+	export let elem_id = "";
+	export let elem_classes: string[] = [];
+	export let visible = true;
+	export let value = "";
+	export let placeholder = "";
+	export let show_label: boolean;
+	export let scale: number | null = null;
+	export let min_width: number | undefined = undefined;
+	export let loading_status: LoadingStatus | undefined = undefined;
+	export let value_is_output = false;
+	export let mode: "static" | "interactive";
+	export let rtl = false;
+
+	let el: HTMLTextAreaElement | HTMLInputElement;
+	const container = true;
+
+	function handle_change(): void {
+		gradio.dispatch("change");
+		if (!value_is_output) {
+			gradio.dispatch("input");
+		}
+	}
+
+	async function handle_keypress(e: KeyboardEvent): Promise<void> {
+		await tick();
+		if (e.key === "Enter") {
+			e.preventDefault();
+			gradio.dispatch("submit");
+		}
+	}
+
+	$: if (value === null) value = "";
+
+	// When the value changes, dispatch the change event via handle_change()
+	// See the docs for an explanation: https://svelte.dev/docs/svelte-components#script-3-$-marks-a-statement-as-reactive
+	$: value, handle_change();
+</script>
+
+<Block
+	{visible}
+	{elem_id}
+	{elem_classes}
+	{scale}
+	{min_width}
+	allow_overflow={false}
+	padding={true}
+>
+	{#if loading_status}
+		<StatusTracker
+			autoscroll={gradio.autoscroll}
+			i18n={gradio.i18n}
+			{...loading_status}
+		/>
+	{/if}
+
+	<label class:container>
+		<BlockTitle {show_label} info={undefined}>{label}</BlockTitle>
+
+		<input
+			data-testid="textbox"
+			type="text"
+			class="scroll-hide"
+			bind:value
+			bind:this={el}
+			{placeholder}
+			disabled={mode === "static"}
+			dir={rtl ? "rtl" : "ltr"}
+			on:keypress={handle_keypress}
+		/>
+	</label>
+</Block>
+
+<style>
+	label {
+		display: block;
+		width: 100%;
+	}
+
+	input {
+		display: block;
+		position: relative;
+		outline: none !important;
+		box-shadow: var(--input-shadow);
+		background: var(--input-background-fill);
+		padding: var(--input-padding);
+		width: 100%;
+		color: var(--body-text-color);
+		font-weight: var(--input-text-weight);
+		font-size: var(--input-text-size);
+		line-height: var(--line-sm);
+		border: none;
+	}
+	.container > input {
+		border: var(--input-border-width) solid var(--input-border-color);
+		border-radius: var(--input-radius);
+	}
+	input:disabled {
+		-webkit-text-fill-color: var(--body-text-color);
+		-webkit-opacity: 1;
+		opacity: 1;
+	}
+
+	input:focus {
+		box-shadow: var(--input-shadow-focus);
+		border-color: var(--input-border-color-focus);
+	}
+
+	input::placeholder {
+		color: var(--input-placeholder-color);
+	}
+</style>

js/simpletextbox/package.json

@@ -0,0 +1,21 @@
+{
+	"name": "@gradio/simpletextbox",
+	"version": "0.0.1-beta.0",
+	"description": "Gradio UI packages",
+	"type": "module",
+	"author": "",
+	"license": "ISC",
+	"private": false,
+	"main_changeset": true,
+	"exports": {
+		".": "./Index.svelte",
+		"./example": "./Example.svelte",
+		"./package.json": "./package.json"
+	},
+	"dependencies": {
+		"@gradio/atoms": "workspace:^",
+		"@gradio/icons": "workspace:^",
+		"@gradio/statustracker": "workspace:^",
+		"@gradio/utils": "workspace:^"
+	}
+}