class_docstr: Creates a textarea for user to enter string input or display string output.
  Preprocessing: passes textarea value as a {str} into the function.
  Postprocessing: expects a {str} returned from function and sets textarea value to it.
  Examples-format: a {str} representing the textbox input.
  
  Demos: hello_world, diff_texts, sentence_builder
  Guides: creating-a-chatbot, real-time-speech-recognition
class_docstr_tok: ["Creates","a","textarea","for","user","to","enter","string","input","or","display","string","output",".","Preprocessing",":","passes","textarea","value","as","a","{","str","}","into","the","function",".","Postprocessing",":","expects","a","{","str","}","returned","from","function","and","sets","textarea","value","to","it",".","Examples-format",":","a","{","str","}","representing","the","textbox","input",".","Demos",":","hello_world",",","diff_texts",",","sentence_builder","Guides",":","creating-a-chatbot",",","real-time-speech-recognition"]
docstr: Parameters:
      value: default text to provide in textarea. If callable, the function will be called whenever the app loads to set the initial value of the component.
      lines: minimum number of line rows to provide in textarea.
      max_lines: maximum number of line rows to provide in textarea.
      placeholder: placeholder hint to provide behind textarea.
      label: The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
      info: additional component description.
      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.
      container: If True, will place the component in a container - providing some extra padding around the border.
      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.
      autofocus: If True, will focus on the textbox when the page loads. Use this carefully, as it can cause usability issues for sighted and non-sighted users.
      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.
      render: If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
      type: The type of textbox. One of: 'text', 'password', 'email', Default is 'text'.
      text_align: How to align the text in the textbox, can be: "left", "right", or None (default). If None, the alignment is left if `rtl` is False, or right if `rtl` is True. Can only be changed if `type` is "text".
      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.
      show_copy_button: If True, includes a copy button to copy the text in the textbox. Only applies if show_label is True.
      autoscroll: If True, will automatically scroll to the bottom of the textbox when the value changes, unless the user scrolls up. If False, will not scroll to the bottom of the textbox when the value changes.
docstr_tok: ["Parameters",":","value",":","default","text","to","provide","in","textarea",".","If","callable",",","the","function","will","be","called","whenever","the","app","loads","to","set","the","initial","value","of","the","component",".","lines",":","minimum","number","of","line","rows","to","provide","in","textarea",".","max_lines",":","maximum","number","of","line","rows","to","provide","in","textarea",".","placeholder",":","placeholder","hint","to","provide","behind","textarea",".","label",":","The","label","for","this","component",".","Appears","above","the","component","and","is","also","used","as","the","header","if","there","are","a","table","of","examples","for","this","component",".","If","None","and","used","in","a","`","gr.Interface","`",",","the","label","will","be","the","name","of","the","parameter","this","component","is","assigned","to",".","info",":","additional","component","description",".","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",".","container",":","If","True",",","will","place","the","component","in","a","container","-","providing","some","extra","padding","around","the","border",".","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",".","autofocus",":","If","True",",","will","focus","on","the","textbox","when","the","page","loads",".","Use","this","carefully",",","as","it","can","cause","usability","issues","for","sighted","and","non-sighted","users",".","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",".","render",":","If","False",",","component","will","not","render","be","rendered","in","the","Blocks","context",".","Should","be","used","if","the","intention","is","to","assign","event","listeners","now","but","render","the","component","later",".","type",":","The","type","of","textbox",".","One","of",":","'text","'",",","'password","'",",","'email","'",",","Default","is","'text","'",".","text_align",":","How","to","align","the","text","in","the","textbox",",","can","be",":","``","left","''",",","``","right","''",",","or","None","(","default",")",".","If","None",",","the","alignment","is","left","if","`","rtl","`","is","False",",","or","right","if","`","rtl","`","is","True",".","Can","only","be","changed","if","`","type","`","is","``","text","''",".","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",".","show_copy_button",":","If","True",",","includes","a","copy","button","to","copy","the","text","in","the","textbox",".","Only","applies","if","show_label","is","True",".","autoscroll",":","If","True",",","will","automatically","scroll","to","the","bottom","of","the","textbox","when","the","value","changes",",","unless","the","user","scrolls","up",".","If","False",",","will","not","scroll","to","the","bottom","of","the","textbox","when","the","value","changes","."]
code: def __init__(
      self,
      value: str | Callable | None = "",
      *,
      lines: int = 1,
      max_lines: int = 20,
      placeholder: str | None = None,
      label: str | None = None,
      info: str | None = None,
      every: float | None = None,
      show_label: bool | None = None,
      container: bool = True,
      scale: int | None = None,
      min_width: int = 160,
      interactive: bool | None = None,
      visible: bool = True,
      elem_id: str | None = None,
      autofocus: bool = False,
      autoscroll: bool = True,
      elem_classes: list[str] | str | None = None,
      render: bool = True,
      type: Literal["text", "password", "email"] = "text",
      text_align: Literal["left", "right"] | None = None,
      rtl: bool = False,
      show_copy_button: bool = False,
  ):
      """
      Parameters:
          value: default text to provide in textarea. If callable, the function will be called whenever the app loads to set the initial value of the component.
          lines: minimum number of line rows to provide in textarea.
          max_lines: maximum number of line rows to provide in textarea.
          placeholder: placeholder hint to provide behind textarea.
          label: The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
          info: additional component description.
          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.
          container: If True, will place the component in a container - providing some extra padding around the border.
          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.
          autofocus: If True, will focus on the textbox when the page loads. Use this carefully, as it can cause usability issues for sighted and non-sighted users.
          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.
          render: If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
          type: The type of textbox. One of: 'text', 'password', 'email', Default is 'text'.
          text_align: How to align the text in the textbox, can be: "left", "right", or None (default). If None, the alignment is left if `rtl` is False, or right if `rtl` is True. Can only be changed if `type` is "text".
          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.
          show_copy_button: If True, includes a copy button to copy the text in the textbox. Only applies if show_label is True.
          autoscroll: If True, will automatically scroll to the bottom of the textbox when the value changes, unless the user scrolls up. If False, will not scroll to the bottom of the textbox when the value changes.
      """
      if type not in ["text", "password", "email"]:
          raise ValueError(
              '`type` must be one of "text", "password", or "email".'
          )
  
      self.lines = lines
      if type == "text":
          self.max_lines = max(lines, max_lines)
      else:
          self.max_lines = 1
      self.placeholder = placeholder
      self.show_copy_button = show_copy_button
      self.autofocus = autofocus
      self.autoscroll = autoscroll
      super().__init__(
          label=label,
          info=info,
          every=every,
          show_label=show_label,
          container=container,
          scale=scale,
          min_width=min_width,
          interactive=interactive,
          visible=visible,
          elem_id=elem_id,
          elem_classes=elem_classes,
          render=render,
          value=value,
      )
      self.type = type
      self.rtl = rtl
      self.text_align = text_align
  
file_path: gradio/gradio/components/textbox.py
imports: from __future__ import annotations
  from typing import Any, Callable, Literal
  from gradio_client.documentation import document, set_documentation_group
  from gradio.components.base import FormComponent
  from gradio.events import Events
label_desc: Use image node_id 1 to create a new Textbox object from inherited base classes: FormComponent with example: obj = Textbox(value)