diff --git a/404.html b/404.html index 18a5d32869..a203f761a9 100644 --- a/404.html +++ b/404.html @@ -11,14 +11,11 @@ - - - - + @@ -26,10 +23,10 @@ - + - + @@ -58,6 +55,7 @@ + @@ -219,7 +217,7 @@
-
+
Initializing search @@ -518,15 +516,9 @@ - - Home - - - - @@ -563,15 +555,9 @@ - - Introduction - - - - @@ -579,11 +565,7 @@
- + - + diff --git a/FAQ/index.html b/FAQ/index.html index 9d286703cb..48da350db8 100644 --- a/FAQ/index.html +++ b/FAQ/index.html @@ -17,14 +17,11 @@ - - - - + @@ -32,10 +29,10 @@ - + - + @@ -64,6 +61,7 @@ + @@ -230,7 +228,7 @@
-
+
Initializing search @@ -533,15 +531,9 @@ - - Home - - - - @@ -578,15 +570,9 @@ - - Introduction - - - - @@ -594,11 +580,7 @@
- + - + diff --git a/api/app/index.html b/api/app/index.html index 6f3c126acb..04b8ad564d 100644 --- a/api/app/index.html +++ b/api/app/index.html @@ -17,14 +17,11 @@ - - - - + @@ -32,10 +29,10 @@ - + - + @@ -64,6 +61,7 @@ + @@ -230,7 +228,7 @@
-
+
Initializing search @@ -531,15 +529,9 @@ - - Home - - - - @@ -576,15 +568,9 @@ - - Introduction - - - - @@ -592,11 +578,7 @@
-
-
- - - -
-
-
- - -
- - + + + + + +
+
+
+ + + +
+
+
+ + +
- + - + diff --git a/api/binding/index.html b/api/binding/index.html index defc9eab85..a3258f8447 100644 --- a/api/binding/index.html +++ b/api/binding/index.html @@ -17,14 +17,11 @@ - - - - + @@ -32,10 +29,10 @@ - + - + @@ -64,6 +61,7 @@ + @@ -230,7 +228,7 @@
-
+
Initializing search @@ -531,15 +529,9 @@ - - Home - - - - @@ -576,15 +568,9 @@ - - Introduction - - - - @@ -592,11 +578,7 @@
-
+
@@ -8719,7 +7182,7 @@

Made with - Material for MkDocs Insiders + Material for MkDocs

@@ -8762,10 +7225,10 @@

- + - + diff --git a/api/cache/index.html b/api/cache/index.html index d38c629d88..8b4b0ec98c 100644 --- a/api/cache/index.html +++ b/api/cache/index.html @@ -17,14 +17,11 @@ - - - - + @@ -32,10 +29,10 @@ - + - + @@ -64,6 +61,7 @@ + @@ -230,7 +228,7 @@
-
+
Initializing search @@ -531,15 +529,9 @@ - - Home - - - - @@ -576,15 +568,9 @@ - - Introduction - - - - @@ -592,11 +578,7 @@
-
-
- - - -
-
-
- - - +
+
+
+ + + +
+
+
+ + +
+
+
+ + + +
+
+
+ + + -
-
-
- - -
-
-
- - - +
+
+
+ + + +
+
+
+ + +
+
@@ -8194,7 +6710,7 @@

Made with - Material for MkDocs Insiders + Material for MkDocs

@@ -8237,10 +6753,10 @@

- + - + diff --git a/api/events/index.html b/api/events/index.html index f10c1fbcc4..fcfb58d35f 100644 --- a/api/events/index.html +++ b/api/events/index.html @@ -17,14 +17,11 @@ - - - - + @@ -32,10 +29,10 @@ - + - + @@ -64,6 +61,7 @@ + @@ -230,7 +228,7 @@
-
+
Initializing search @@ -531,15 +529,9 @@ - - Home - - - - @@ -576,15 +568,9 @@ - - Introduction - - - - @@ -592,11 +578,7 @@
@@ -10296,23 +8113,21 @@

- DescendantBlur - + DescendantBlur + dataclass

-
DescendantBlur(widget)
-
- -
-

- Bases: Event

+
+

+ Bases: Event

+

Sent when a child widget is blurred.

  • Bubbles
    • @@ -10321,11 +8136,7 @@

    - - - - - +
    @@ -10340,21 +8151,21 @@

    - control - + control + property

    -
    control
+
    control: Widget
 
    
 
-    
    
-
+  
    
+  
       
    The widget that was blurred (alias of widget).
    
-    
    
+
    @@ -10363,21 +8174,21 @@

    - widget - + widget + instance-attribute

    -
    widget
+
    widget: Widget
 
    
 
-    
    
-
+  
    
+  
       
    The widget that was blurred.
    
-    
    
+
    @@ -10387,7 +8198,7 @@

    -

+
@@ -10396,23 +8207,21 @@

- DescendantFocus - + DescendantFocus + dataclass

-
DescendantFocus(widget)
-
- -
-

- Bases: Event

+
+

+ Bases: Event

+

Sent when a child widget is focussed.

  • Bubbles
    • @@ -10421,11 +8230,7 @@

    - - - - - +
    @@ -10440,21 +8245,21 @@

    - control - + control + property

    -
    control
+
    control: Widget
 
    
 
-    
    
-
+  
    
+  
       
    The widget that was focused (alias of widget).
    
-    
    
+
    @@ -10463,21 +8268,21 @@

    - widget - + widget + instance-attribute

    -
    widget
+
    widget: Widget
 
    
 
-    
    
-
+  
    
+  
       
    The widget that was focused.
    
-    
    
+
    @@ -10487,7 +8292,7 @@

    -

+
@@ -10496,62 +8301,93 @@

- Enter + Enter

-
Enter()
+
Enter(node)
 

 
-    

-            

-              Bases: Event

-
-
+  

+      

+        Bases: Event

 
+  
       
Sent when the mouse is moved over a widget.

+
Note that this event bubbles, so a widget may receive this event when the mouse
+moves over a child widget. Check the node attribute for the widget directly under
+the mouse.

 
    
-
  •  Bubbles
    • 
+
  •  Bubbles
    • 
 
  •  Verbose
    • 
 

 
 
 
+  
+
+  

+
 
 
 
 
-    

 
-

 
-

+

 
 
 
-

-            Event
+

+        node
 
+  
+  
+      instance-attribute
+  
 
-

-
Event()
+
+
node = node
 

 
-    

-            

-              Bases: Message

+  

+  
+      
The node directly under the mouse.

+  

 
+

 
 
-      
The base class for all events.

 
 
 
+  

+
+  

+
+

 
+

 
 
 
-    

+

+        Event
+
+
+

+
+
+  

+      

+        Bases: Message

+
+  
+      
The base class for all events.

+
+
+
+  

 
 

 
@@ -10560,19 +8396,17 @@ 

 
 
 

-            Focus
+        Focus
 
 
 

-
Focus()
-

-
-    

-            

-              Bases: Event

 
 
+  

+      

+        Bases: Event

 
+  
       
Sent when a widget is focussed.

 
    
 
  •  Bubbles
    • 
@@ -10581,11 +8415,7 @@ 
    
 
 
 
-
-
-
-
-    

+
@@ -10594,19 +8424,17 @@

- Hide + Hide

-
Hide()
-
- -
-

- Bases: Event

+
+

+ Bases: Event

+

Sent when a widget has been hidden.

  • Bubbles
    • @@ -10622,11 +8450,7 @@

    - - - - -

+
@@ -10635,19 +8459,17 @@

- Idle + Idle

-
Idle()
-
- -
-

- Bases: Event

+
+

+ Bases: Event

+

Sent when there are no more items in the message queue.

This is a pseudo-event in that it is created by the Textual system and doesn't go through the usual message queue.

@@ -10658,11 +8480,7 @@

- - - - -

+
@@ -10671,28 +8489,22 @@

- InputEvent + InputEvent

-
InputEvent()
-
- -
-

- Bases: Event

+
+

+ Bases: Event

+

Base class for input events.

- - - - -
+
@@ -10701,79 +8513,61 @@

- Key + Key

-
Key(key, character)
+
Key(key, character)
 

 
-    

-            

-              Bases: InputEvent

-
-
+  

+      

+        Bases: InputEvent

 
+  
       
Sent when the user hits a key on the keyboard.

 
    
 
  •  Bubbles
    • 
 
  •  Verbose
    • 
 

 
-
-
Parameters:

-    
-      
+  
Parameters:

+  

+    
+      
+        
+        
+        
+        
+      
+    
+    
-          
-          
-          
-          
+          
+          
+          
+          
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
NameTypeDescriptionDefault

         
NameTypeDescriptionDefaultkey
+                str
+          
The key that was pressed.

+              required
+          
         

-
                  key
-
            		
-                  str
-            
-              

-                
The key that was pressed.

-              

-            		
-                required
-            

-
                  character
-
            		
-                  str | None
-            
-              

-                
A printable character or None if it is not printable.

-              

-            		
-                required
-            

-
-
-
-
-
+        
+          character
+          
+                str | None
+          
+          
A printable character or None if it is not printable.

+          
+              required
+          
+        
+    
+  
 
 
 
+  
 
   

 
@@ -10788,21 +8582,21 @@ 

-            aliases
-
+        aliases
 
+  
   
       instance-attribute
   
 
 

-
aliases = _get_key_aliases(key)
+
aliases: list[str] = _get_key_aliases(key)
 

 
-    

-
+  

+  
       
The aliases for the key, including the key itself.

-    

+  

 
 

 
@@ -10811,25 +8605,25 @@ 

 
 
 

-            character
-
+        character
 
+  
   
       instance-attribute
   
 
 

-
character = (
-    key
-    if len(key) == 1
-    else None if character is None else character
+
character = (
+    key
+    if len(key) == 1
+    else None if character is None else character
 )
 

 
-    

-
+  

+  
       
A printable character or None if it is not printable.

-    

+  

 
 

 
@@ -10838,44 +8632,39 @@ 

 
 
 

-            is_printable
-
+        is_printable
 
+  
   
       property
   
 
 

-
is_printable
+
is_printable: bool
 

 
-    

-
+  

+  
       
Check if the key is printable (produces a unicode character).

 
-
-    
Returns:

-    
-      
+  
Returns:

+  

+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
TypeDescription

         
TypeDescription
+                bool
+          
True if the key is printable.

         

-                  bool
-            
-              

-                
True if the key is printable.

-              

-            

-    

+    
+  
+  

 
 

 
@@ -10884,21 +8673,21 @@ 

 
 
 

-            key
-
+        key
 
+  
   
       instance-attribute
   
 
 

-
key = key
+
key = key
 

 
-    

-
+  

+  
       
The key that was pressed.

-    

+  

 
 

 
@@ -10907,21 +8696,21 @@ 

 
 
 

-            name
-
+        name
 
+  
   
       property
   
 
 

-
name
+
name: str
 

 
-    

-
+  

+  
       
Name of a key suitable for use as a Python identifier.

-    

+  

 
 

 
@@ -10930,21 +8719,21 @@ 

 
 
 

-            name_aliases
-
+        name_aliases
 
+  
   
       property
   
 
 

-
name_aliases
+
name_aliases: list[str]
 

 
-    

-
+  

+  
       
The corresponding name for every alias in aliases list.

-    

+  

 
 

 
@@ -10954,7 +8743,7 @@ 

 
   

 
-    

+
@@ -10963,33 +8752,69 @@

- Leave + Leave

-
Leave()
+
Leave(node)
 

 
-    

-            

-              Bases: Event

-
-
+  

+      

+        Bases: Event

 
+  
       
Sent when the mouse is moved away from a widget, or if a widget is
 programmatically disabled while hovered.

+
Note that this widget bubbles, so a widget may receive Leave events for any child widgets.
+Check the node parameter for the original widget that was previously under the mouse.

 
    
-
  •  Bubbles
    • 
+
  •  Bubbles
    • 
 
  •  Verbose
    • 
 

 
 
 
+  
+
+  

+
 
 
 
 
-    

+
+
+

+
+
+
+

+        node
+
+  
+  
+      instance-attribute
+  
+
+

+
node = node
+

+
+  

+  
+      
The node that was previously directly under the mouse.

+  

+
+

+
+
+
+
+
+  

+
+
@@ -10998,19 +8823,17 @@

- Load + Load

-
Load()
-
- -
-

- Bases: Event

+
+

+ Bases: Event

+

Sent when the App is running but before the terminal is in application mode.

Use this event to run any setup that doesn't require any visuals such as loading configuration and binding keys.

@@ -11021,11 +8844,7 @@

- - - - -

+
@@ -11034,19 +8853,17 @@

- Mount + Mount

-
Mount()
-
- -
-

- Bases: Event

+
+

+ Bases: Event

+

Sent when a widget is mounted and may receive messages.

  • Bubbles
    • @@ -11055,11 +8872,7 @@

    - - - - -

+
@@ -11068,19 +8881,18 @@

- MouseCapture + MouseCapture

-
MouseCapture(mouse_position)
+
MouseCapture(mouse_position)
 

 
-    

-            

-              Bases: Event

-
-
+  

+      

+        Bases: Event

 
+  
       
Sent when the mouse has been captured.

 
    
 
  •  Bubbles
    • 
@@ -11088,44 +8900,33 @@ 
    
 

 
When a mouse has been captured, all further mouse events will be sent to the capturing widget.

 
-
-
Parameters:

-    
-      
+  
Parameters:

+  

+    
+      
+        
+        
+        
+        
+      
+    
+    
-          
-          
-          
-          
+          
+          
+          
+          
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
NameTypeDescriptionDefault

         
NameTypeDescriptionDefaultmouse_position
+                Offset
+          
The position of the mouse when captured.

+              required
+          
         

-
                  mouse_position
-
            		
-                  Offset
-            
-              

-                
The position of the mouse when captured.

-              

-            		
-                required
-            

-
-
-
-
-
+    
+  
 
 
 
+  
 
   

 
@@ -11140,21 +8941,21 @@ 

-            mouse_position
-
+        mouse_position
 
+  
   
       instance-attribute
   
 
 

-
mouse_position = mouse_position
+
mouse_position = mouse_position
 

 
-    

-
+  

+  
       
The position of the mouse when captured.

-    

+  

 
 

 
@@ -11164,7 +8965,7 @@ 

 
   

 
-    

+
@@ -11173,31 +8974,17 @@

- MouseDown + MouseDown

-
MouseDown(
-    x,
-    y,
-    delta_x,
-    delta_y,
-    button,
-    shift,
-    meta,
-    ctrl,
-    screen_x=None,
-    screen_y=None,
-    style=None,
-)
-
- -
-

- Bases: MouseEvent

+
+

+ Bases: MouseEvent

+

Sent when a mouse button is pressed.

  • Bubbles
    • @@ -11206,11 +8993,7 @@

    - - - - -

+
@@ -11219,235 +9002,163 @@

- MouseEvent + MouseEvent

-
MouseEvent(
-    x,
-    y,
-    delta_x,
-    delta_y,
-    button,
-    shift,
-    meta,
-    ctrl,
-    screen_x=None,
-    screen_y=None,
-    style=None,
+
MouseEvent(
+    x,
+    y,
+    delta_x,
+    delta_y,
+    button,
+    shift,
+    meta,
+    ctrl,
+    screen_x=None,
+    screen_y=None,
+    style=None,
 )
 

 
-    

-            

-              Bases: InputEvent

-
-
+  

+      

+        Bases: InputEvent

 
+  
       
Sent in response to a mouse event.

 
    
 
  •  Bubbles
    • 
 
  •  Verbose
    • 
 

 
-
-
Parameters:

-    
-      
+  
Parameters:

+  

+    
+      
+        
+        
+        
+        
+      
+    
+    
-          
-          
-          
-          
+          
+          
+          
+          
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
NameTypeDescriptionDefault

         
NameTypeDescriptionDefaultx
+                int
+          
The relative x coordinate.

+              required
+          
         

-
                  x
-
            		
-                  int
-            
-              

-                
The relative x coordinate.

-              

-            		
-                required
-            

-
                  y
-
            		
-                  int
-            
-              

-                
The relative y coordinate.

-              

-            		
-                required
-            

-
                  delta_x
-
            		
-                  int
-            
-              

-                
Change in x since the last message.

-              

-            		
-                required
-            

-
                  delta_y
-
            		
-                  int
-            
-              

-                
Change in y since the last message.

-              

-            		
-                required
-            

-
                  button
-
            		
-                  int
-            
-              

-                
Indexed of the pressed button.

-              

-            		
-                required
-            

-
                  shift
-
            		
-                  bool
-            
-              

-                
True if the shift key is pressed.

-              

-            		
-                required
-            

-
                  meta
-
            		
-                  bool
-            
-              

-                
True if the meta key is pressed.

-              

-            		
-                required
-            

-
                  ctrl
-
            		
-                  bool
-            
-              

-                
True if the ctrl key is pressed.

-              

-            		
-                required
-            

-
                  screen_x
-
            		
-                  int | None
-            
-              

-                
The absolute x coordinate.

-              

-            		
-                  None
-            

-
                  screen_y
-
            		
-                  int | None
-            
-              

-                
The absolute y coordinate.

-              

-            		
-                  None
-            

-
                  style
-
            		
-                  Style | None
-            
-              

-                
The Rich Style under the mouse cursor.

-              

-            		
-                  None
-            

-
-
-
-
-
+        
+          y
+          
+                int
+          
+          
The relative y coordinate.

+          
+              required
+          
+        
+        
+          delta_x
+          
+                int
+          
+          
Change in x since the last message.

+          
+              required
+          
+        
+        
+          delta_y
+          
+                int
+          
+          
Change in y since the last message.

+          
+              required
+          
+        
+        
+          button
+          
+                int
+          
+          
Indexed of the pressed button.

+          
+              required
+          
+        
+        
+          shift
+          
+                bool
+          
+          
True if the shift key is pressed.

+          
+              required
+          
+        
+        
+          meta
+          
+                bool
+          
+          
True if the meta key is pressed.

+          
+              required
+          
+        
+        
+          ctrl
+          
+                bool
+          
+          
True if the ctrl key is pressed.

+          
+              required
+          
+        
+        
+          screen_x
+          
+                int | None
+          
+          
The absolute x coordinate.

+          
+                None
+          
+        
+        
+          screen_y
+          
+                int | None
+          
+          
The absolute y coordinate.

+          
+                None
+          
+        
+        
+          style
+          
+                Style | None
+          
+          
The Rich Style under the mouse cursor.

+          
+                None
+          
+        
+    
+  
 
 
 
+  
 
   

 
@@ -11462,21 +9173,21 @@ 

-            button
-
+        button
 
+  
   
       instance-attribute
   
 
 

-
button = button
+
button = button
 

 
-    

-
+  

+  
       
Indexed of the pressed button.

-    

+  

 
 

 
@@ -11485,21 +9196,21 @@ 

 
 
 

-            ctrl
-
+        ctrl
 
+  
   
       instance-attribute
   
 
 

-
ctrl = ctrl
+
ctrl = ctrl
 

 
-    

-
+  

+  
       
True if the ctrl key is pressed.

-    

+  

 
 

 
@@ -11508,21 +9219,21 @@ 

 
 
 

-            delta
-
+        delta
 
+  
   
       property
   
 
 

-
delta
+
delta: Offset
 

 
-    

-
+  

+  
       
Mouse coordinate delta (change since last event).

-    

+  

 
 

 
@@ -11531,21 +9242,21 @@ 

 
 
 

-            delta_x
-
+        delta_x
 
+  
   
       instance-attribute
   
 
 

-
delta_x = delta_x
+
delta_x = delta_x
 

 
-    

-
+  

+  
       
Change in x since the last message.

-    

+  

 
 

 
@@ -11554,21 +9265,21 @@ 

 
 
 

-            delta_y
-
+        delta_y
 
+  
   
       instance-attribute
   
 
 

-
delta_y = delta_y
+
delta_y = delta_y
 

 
-    

-
+  

+  
       
Change in y since the last message.

-    

+  

 
 

 
@@ -11577,21 +9288,21 @@ 

 
 
 

-            meta
-
+        meta
 
+  
   
       instance-attribute
   
 
 

-
meta = meta
+
meta = meta
 

 
-    

-
+  

+  
       
True if the meta key is pressed.

-    

+  

 
 

 
@@ -11600,44 +9311,39 @@ 

 
 
 

-            offset
-
+        offset
 
+  
   
       property
   
 
 

-
offset
+
offset: Offset
 

 
-    

-
+  

+  
       
The mouse coordinate as an offset.

 
-
-    
Returns:

-    
-      
+  
Returns:

+  

+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
TypeDescription

         
TypeDescription
+                Offset
+          
Mouse coordinate.

         

-                  Offset
-            
-              

-                
Mouse coordinate.

-              

-            

-    

+    
+  
+  

 
 

 
@@ -11646,21 +9352,21 @@ 

 
 
 

-            screen_offset
-
+        screen_offset
 
+  
   
       property
   
 
 

-
screen_offset
+
screen_offset: Offset
 

 
-    

-
+  

+  
       
Mouse coordinate relative to the screen.

-    

+  

 
 

 
@@ -11669,21 +9375,21 @@ 

 
 
 

-            screen_x
-
+        screen_x
 
+  
   
       instance-attribute
   
 
 

-
screen_x = x if screen_x is None else screen_x
+
screen_x = x if screen_x is None else screen_x
 

 
-    

-
+  

+  
       
The absolute x coordinate.

-    

+  

 
 

 
@@ -11692,21 +9398,21 @@ 

 
 
 

-            screen_y
-
+        screen_y
 
+  
   
       instance-attribute
   
 
 

-
screen_y = y if screen_y is None else screen_y
+
screen_y = y if screen_y is None else screen_y
 

 
-    

-
+  

+  
       
The absolute y coordinate.

-    

+  

 
 

 
@@ -11715,21 +9421,21 @@ 

 
 
 

-            shift
-
+        shift
 
+  
   
       instance-attribute
   
 
 

-
shift = shift
+
shift = shift
 

 
-    

-
+  

+  
       
True if the shift key is pressed.

-    

+  

 
 

 
@@ -11738,22 +9444,22 @@ 

 
 
 

-            style
-
+        style
 
+  
   
-      property
       writable
+      property
   
 
 

-
style
+
style: Style
 

 
-    

-
+  

+  
       
The (Rich) Style under the cursor.

-    

+  

 
 

 
@@ -11762,21 +9468,21 @@ 

 
 
 

-            x
-
+        x
 
+  
   
       instance-attribute
   
 
 

-
x = x
+
x = x
 

 
-    

-
+  

+  
       
The relative x coordinate.

-    

+  

 
 

 
@@ -11785,21 +9491,21 @@ 

 
 
 

-            y
-
+        y
 
+  
   
       instance-attribute
   
 
 

-
y = y
+
y = y
 

 
-    

-
+  

+  
       
The relative y coordinate.

-    

+  

 
 

 
@@ -11808,147 +9514,125 @@ 

 

 
 
+
 

-            get_content_offset
+        get_content_offset
 
 
 

-
get_content_offset(widget)
+
get_content_offset(widget)
 

 
-    

-
+  

+  
       
Get offset within a widget's content area, or None if offset is not in content (i.e. padding or border).

 
-
-
Parameters:

-    
-      
+  
Parameters:

+  

+    
+      
+        
+        
+        
+        
+      
+    
+    
-          
-          
-          
-          
+          
+          
+          
+          
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
NameTypeDescriptionDefault

         
NameTypeDescriptionDefaultwidget
+                Widget
+          
Widget receiving the event.

+              required
+          
         

-
                  widget
-
            		
-                  Widget
-            
-              

-                
Widget receiving the event.

-              

-            		
-                required
-            

-
-
-    
Returns:

-    
-      
+    
+  

+
+  
Returns:

+  
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
TypeDescription

         
TypeDescription
+                Offset | None
+          
An offset where the origin is at the top left of the content area.

         

-                  Offset | None
-            
-              

-                
An offset where the origin is at the top left of the content area.

-              

-            

+    
+  
 
-    

+  

 
 

 
 

 
 
+
 

-            get_content_offset_capture
+        get_content_offset_capture
 
 
 

-
get_content_offset_capture(widget)
+
get_content_offset_capture(widget)
 

 
-    

-
+  

+  
       
Get offset from a widget's content area.

 
This method works even if the offset is outside the widget content region.

 
-
-
Parameters:

-    
-      
+  
Parameters:

+  

+    
+      
+        
+        
+        
+        
+      
+    
+    
-          
-          
-          
-          
+          
+          
+          
+          
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
NameTypeDescriptionDefault

         
NameTypeDescriptionDefaultwidget
+                Widget
+          
Widget receiving the event.

+              required
+          
         

-
                  widget
-
            		
-                  Widget
-            
-              

-                
Widget receiving the event.

-              

-            		
-                required
-            

-
-
-    
Returns:

-    
-      
+    
+  

+
+  
Returns:

+  
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
TypeDescription

         
TypeDescription
+                Offset
+          
An offset where the origin is at the top left of the content area.

         

-                  Offset
-            
-              

-                
An offset where the origin is at the top left of the content area.

-              

-            

+    
+  
 
-    

+  

 
 

 
@@ -11956,7 +9640,7 @@ 

-            MouseMove
+        MouseMove
 
 
 

-
MouseMove(
-    x,
-    y,
-    delta_x,
-    delta_y,
-    button,
-    shift,
-    meta,
-    ctrl,
-    screen_x=None,
-    screen_y=None,
-    style=None,
-)
-

-
-    

-            

-              Bases: MouseEvent

 
 
+  

+      

+        Bases: MouseEvent

 
+  
       
Sent when the mouse cursor moves.

 
    
 
  •  Bubbles
    • 
@@ -11998,11 +9668,7 @@ 
    
 
 
 
-
-
-
-
-    

+  

 
 

 
@@ -12011,63 +9677,51 @@ 

 
 
 

-            MouseRelease
+        MouseRelease
 
 
 

-
MouseRelease(mouse_position)
+
MouseRelease(mouse_position)
 

 
-    

-            

-              Bases: Event

-
-
+  

+      

+        Bases: Event

 
+  
       
Mouse has been released.

 
    
 
  •  Bubbles
    • 
 
  •  Verbose
    • 
 

 
-
-
Parameters:

-    
-      
+  
Parameters:

+  

+    
+      
+        
+        
+        
+        
+      
+    
+    
-          
-          
-          
-          
+          
+          
+          
+          
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
NameTypeDescriptionDefault

         
NameTypeDescriptionDefaultmouse_position
+                Offset
+          
The position of the mouse when released.

+              required
+          
         

-
                  mouse_position
-
            		
-                  Offset
-            
-              

-                
The position of the mouse when released.

-              

-            		
-                required
-            

-
-
-
-
-
+    
+  
 
 
 
+  
 
   

 
@@ -12082,21 +9736,21 @@ 

-            mouse_position
-
+        mouse_position
 
+  
   
       instance-attribute
   
 
 

-
mouse_position = mouse_position
+
mouse_position = mouse_position
 

 
-    

-
+  

+  
       
The position of the mouse when released.

-    

+  

 
 

 
@@ -12106,7 +9760,7 @@ 

 
   

 
-    

+  

 
 

 
@@ -12115,31 +9769,17 @@ 

 
 
 

-            MouseScrollDown
+        MouseScrollDown
 
 
 

-
MouseScrollDown(
-    x,
-    y,
-    delta_x,
-    delta_y,
-    button,
-    shift,
-    meta,
-    ctrl,
-    screen_x=None,
-    screen_y=None,
-    style=None,
-)
-

-
-    

-            

-              Bases: MouseEvent

 
 
+  

+      

+        Bases: MouseEvent

 
+  
       
Sent when the mouse wheel is scrolled down.

 
    
 
  •  Bubbles
    • 
@@ -12148,11 +9788,7 @@ 
    
 
 
 
-
-
-
-
-    

+  

 
 

 
@@ -12161,31 +9797,17 @@ 

 
 
 

-            MouseScrollUp
+        MouseScrollUp
 
 
 

-
MouseScrollUp(
-    x,
-    y,
-    delta_x,
-    delta_y,
-    button,
-    shift,
-    meta,
-    ctrl,
-    screen_x=None,
-    screen_y=None,
-    style=None,
-)
-

-
-    

-            

-              Bases: MouseEvent

 
 
+  

+      

+        Bases: MouseEvent

 
+  
       
Sent when the mouse wheel is scrolled up.

 
    
 
  •  Bubbles
    • 
@@ -12194,11 +9816,7 @@ 
    
 
 
 
-
-
-
-
-    

+  

 
 

 
@@ -12207,31 +9825,17 @@ 

 
 
 

-            MouseUp
+        MouseUp
 
 
 

-
MouseUp(
-    x,
-    y,
-    delta_x,
-    delta_y,
-    button,
-    shift,
-    meta,
-    ctrl,
-    screen_x=None,
-    screen_y=None,
-    style=None,
-)
-

-
-    

-            

-              Bases: MouseEvent

 
 
+  

+      

+        Bases: MouseEvent

 
+  
       
Sent when a mouse button is released.

 
    
 
  •  Bubbles
    • 
@@ -12240,11 +9844,7 @@ 
    
 
 
 
-
-
-
-
-    

+  

 
 

 
@@ -12253,19 +9853,18 @@ 

 
 
 

-            Paste
+        Paste
 
 
 

-
Paste(text)
+
Paste(text)
 

 
-    

-            

-              Bases: Event

-
-
+  

+      

+        Bases: Event

 
+  
       
Event containing text that was pasted into the Textual application.
 This event will only appear when running in a terminal emulator that supports
 bracketed paste mode. Textual will enable bracketed pastes when an app starts,
@@ -12275,44 +9874,33 @@ 

 
  •  Verbose
    • 
 
 
-
-
    Parameters:
    
-    
-      
+  
    Parameters:
    
+  
    
+    
+      
+        
+        
+        
+        
+      
+    
+    
-          
-          
-          
-          
+          
+          
+          
+          
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
         
    NameTypeDescriptionDefaulttext
+                str
+          
    The text that has been pasted.
    		
+              required
+          
         
    
-
                      text
-
                    		
-                  str
-            
-              
    
-                
    The text that has been pasted.
    
-              
    
-                		
-                required
-            
    
-
-
-
-
-
+    
+  
 
 
 
+  
 
   
    
 
@@ -12327,21 +9915,21 @@ 
    
-            text
-
+        text
 
+  
   
       instance-attribute
   
 
 
    
-
    text = text
+
    text = text
 
    
 
-    
    
-
+  
    
+  
       
    The text that was pasted.
    
-    
    
+  
    
 
 
    
 
@@ -12351,7 +9939,7 @@ 
    
 
   
    
 
-    
    
+  
    
 
 
    
 
@@ -12360,72 +9948,57 @@ 
    
 
 
 
    
-            Print
+        Print
 
 
 
    
-
    Print(text, stderr=False)
+
    Print(text, stderr=False)
 
    
 
-    
    
-            
    
-              Bases: Event
    
-
-
+  
    
+      
    
+        Bases: Event
    
 
+  
       
    Sent to a widget that is capturing print.
    
 
      
 
    •  Bubbles
      • 
 
    •  Verbose
      • 
 
    
 
-
-
    Parameters:
    
-    
-      
+  
    Parameters:
    
+  
    
+    
+      
+        
+        
+        
+        
+      
+    
+    
-          
-          
-          
-          
+          
+          
+          
+          
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
         
    NameTypeDescriptionDefaulttext
+                str
+          
    Text that was printed.
    		
+              required
+          
         
    
-
                      text
-
                    		
-                  str
-            
-              
    
-                
    Text that was printed.
    
-              
    
-                		
-                required
-            
    
-
                      stderr
-
                    		
-                  bool
-            
-              
    
-                
    True if the print was to stderr, or False for stdout.
    
-              
    
-                		
-                  False
-            
    
-
+        
+          stderr
+          
+                bool
+          
+          
    True if the print was to stderr, or False for stdout.
    
+          
+                False
+          
+        
+    
+  
 
 
    
   Note
@@ -12434,11 +10007,7 @@ 
    
 
@@ -12453,21 +10022,21 @@ 
    
-            stderr
-
+        stderr
 
+  
   
       instance-attribute
   
 
 
    
-
    stderr = stderr
+
    stderr = stderr
 
    
 
-    
    
-
+  
    
+  
       
    True if the print was to stderr, or False for stdout.
    
-    
    
+  
    
 
 
    
 
@@ -12476,21 +10045,21 @@ 
    
 
 
 
    
-            text
-
+        text
 
+  
   
       instance-attribute
   
 
 
    
-
    text = text
+
    text = text
 
    
 
-    
    
-
+  
    
+  
       
    The text that was printed.
    
-    
    
+  
    
 
 
    
 
@@ -12500,7 +10069,7 @@ 
    
 
   
    
 
-    
    
+  
    
 
 
    
 
@@ -12509,19 +10078,17 @@ 
    
 
 
 
    
-            Ready
+        Ready
 
 
 
    
-
    Ready()
-
    
-
-    
    
-            
    
-              Bases: Event
    
 
 
+  
    
+      
    
+        Bases: Event
    
 
+  
       
    Sent to the App when the DOM is ready and the first frame has been displayed.
    
 
      
 
    •  Bubbles
      • 
@@ -12530,11 +10097,7 @@ 
      
 
 
 
-
-
-
-
-    
    
+
    @@ -12543,95 +10106,71 @@

    - Resize + Resize

    -
    Resize(size, virtual_size, container_size=None)
+
    Resize(size, virtual_size, container_size=None)
 
    
 
-    
    
-            
    
-              Bases: Event
    
-
-
+  
    
+      
    
+        Bases: Event
    
 
+  
       
    Sent when the app or widget has been resized.
    
 
      
 
    •  Bubbles
      • 
 
    •  Verbose
      • 
 
    
 
-
-
    Parameters:
    
-    
-      
+  
    Parameters:
    
+  
    
+    
+      
+        
+        
+        
+        
+      
+    
+    
-          
-          
-          
-          
+          
+          
+          
+          
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
         
    NameTypeDescriptionDefaultsize
+                Size
+          
    The new size of the Widget.
    		
+              required
+          
         
    
-
                      size
-
                    		
-                  Size
-            
-              
    
-                
    The new size of the Widget.
    
-              
    
-                		
-                required
-            
    
-
                      virtual_size
-
                    		
-                  Size
-            
-              
    
-                
    The virtual size (scrollable size) of the Widget.
    
-              
    
-                		
-                required
-            
    
-
                      container_size
-
                    		
-                  Size | None
-            
-              
    
-                
    The size of the Widget's container widget.
    
-              
    
-                		
-                  None
-            
    
-
-
-
-
-
+        
+          virtual_size
+          
+                Size
+          
+          
    The virtual size (scrollable size) of the Widget.
    
+          
+              required
+          
+        
+        
+          container_size
+          
+                Size | None
+          
+          
    The size of the Widget's container widget.
    
+          
+                None
+          
+        
+    
+  
 
 
 
+  
 
   
    
 
@@ -12646,23 +10185,23 @@ 
    
-            container_size
-
+        container_size
 
+  
   
       instance-attribute
   
 
 
    
-
    container_size = (
-    size if container_size is None else container_size
+
    container_size = (
+    size if container_size is None else container_size
 )
 
    
 
-    
    
-
+  
    
+  
       
    The size of the Widget's container widget.
    
-    
    
+  
    
 
 
    
 
@@ -12671,21 +10210,21 @@ 
    
 
 
 
    
-            size
-
+        size
 
+  
   
       instance-attribute
   
 
 
    
-
    size = size
+
    size = size
 
    
 
-    
    
-
+  
    
+  
       
    The new size of the Widget.
    
-    
    
+  
    
 
 
    
 
@@ -12694,21 +10233,21 @@ 
    
 
 
 
    
-            virtual_size
-
+        virtual_size
 
+  
   
       instance-attribute
   
 
 
    
-
    virtual_size = virtual_size
+
    virtual_size = virtual_size
 
    
 
-    
    
-
+  
    
+  
       
    The virtual size (scrollable size) of the Widget.
    
-    
    
+  
    
 
 
    
 
@@ -12718,7 +10257,7 @@ 
    
 
   
    
 
-    
    
+
    @@ -12727,19 +10266,17 @@

    - ScreenResume + ScreenResume

    -
    ScreenResume()
-
    - -
    -

    - Bases: Event

    +
    +

    + Bases: Event

    +

    Sent to screen that has been made active.

    • Bubbles
      • @@ -12748,11 +10285,7 @@

      - - - - -

    +
    @@ -12761,19 +10294,17 @@

    - ScreenSuspend + ScreenSuspend

    -
    ScreenSuspend()
-
    - -
    -

    - Bases: Event

    +
    +

    + Bases: Event

    +

    Sent to screen when it is no longer active.

    • Bubbles
      • @@ -12782,11 +10313,7 @@

      - - - - -

    +
    @@ -12795,19 +10322,17 @@

    - Show + Show

    -
    Show()
-
    - -
    -

    - Bases: Event

    +
    +

    + Bases: Event

    +

    Sent when a widget is first displayed.

    • Bubbles
      • @@ -12816,11 +10341,7 @@

      - - - - -

    +
    @@ -12829,19 +10350,18 @@

    - Timer + Timer

    -
    Timer(timer, time, count=0, callback=None)
+
    Timer(timer, time, count=0, callback=None)
 
    
 
-    
    
-            
    
-              Bases: Event
    
-
-
+  
    
+      
    
+        Bases: Event
    
 
+  
       
    Sent in response to a timer.
    
 
      
 
    •  Bubbles
      • 
@@ -12850,11 +10370,7 @@ 
      
 
 
 
-
-
-
-
-
+  
 
   
      
 
@@ -12870,7 +10386,7 @@ 
      
 
   
      
 
-    
    
+
    @@ -12879,19 +10395,17 @@

    - Unmount + Unmount

    -
    Unmount()
-
    - -
    -

    - Bases: Event

    +
    +

    + Bases: Event

    +

    Sent when a widget is unmounted and may no longer receive messages.

    • Bubbles
      • @@ -12900,11 +10414,7 @@

      - - - - -

    +
    @@ -12913,7 +10423,7 @@

    -
    + @@ -13012,7 +10522,7 @@

    Made with - Material for MkDocs Insiders + Material for MkDocs @@ -13055,10 +10565,10 @@

    - + - + diff --git a/api/filter/index.html b/api/filter/index.html index 1dfe9db5c2..e7745f8e83 100644 --- a/api/filter/index.html +++ b/api/filter/index.html @@ -17,14 +17,11 @@ - - - - + @@ -32,10 +29,10 @@ - + - + @@ -64,6 +61,7 @@ + @@ -230,7 +228,7 @@
    -
    +
    Initializing search @@ -531,15 +529,9 @@ - - Home - - - - @@ -576,15 +568,9 @@ - - Introduction - - - - @@ -592,11 +578,7 @@

    +
    reset()
+
    +
    +

    Reset the rules to initial state.

    -
    + @@ -10103,7 +8162,7 @@

    - + @@ -10112,25 +8171,20 @@

    - UnusedParameter + UnusedParameter

    -
    - - +
    +

    Helper type for a parameter that isn't specified in a method call.

    - - - - -
    +
    @@ -10139,7 +8193,7 @@

    - + @@ -10238,7 +8292,7 @@

    Made with - Material for MkDocs Insiders + Material for MkDocs @@ -10281,10 +8335,10 @@

    - + - + diff --git a/api/validation/index.html b/api/validation/index.html index ff27c3da00..c4a147cb35 100644 --- a/api/validation/index.html +++ b/api/validation/index.html @@ -17,14 +17,11 @@ - - - - + @@ -32,10 +29,10 @@ - + - + @@ -64,6 +61,7 @@ + @@ -230,7 +228,7 @@
    -
    +
    Initializing search @@ -531,15 +529,9 @@ - - Home - - - - @@ -576,15 +568,9 @@ - - Introduction - - - - @@ -592,11 +578,7 @@
    -
  • - - - -  repaint - - - + + + + + +
    • + + Archive + + + + + -
  • - - - -  release_mouse - - - + -
    • + + + -
  • - - -  render + - - - -
    • -
  • - - -  render_line + + - - - - - -
    • -
  • - - - -  render_lines - - - - - + + Categories + -
    • + + + -
  • - - - -  render_str - - - + - - +
    • + + + + + +
    +
    +
    + + + +
    +
    +
    + + + - - -
  • - - - -  scroll_end + + +

    • +
    mouse_hover: Reactive[bool] = Reactive(False, repaint=False)
    -
    - +
    +

    Is the mouse over this widget? Read only.

    -
    +
    @@ -17315,45 +10529,40 @@

    - offset - + offset + - property writable + property

    -
    offset
+
    offset: Offset
 
    
 
-    
    
-
+  
    
+  
       
    Widget offset from origin.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Offset
+          
    Relative offset.
    		
         
    
-                  Offset
-            
-              
    
-                
    Relative offset.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -17362,21 +10571,21 @@

    - opacity - + opacity + property

    -
    opacity
+
    opacity: float
 
    
 
-    
    
-
+  
    
+  
       
    Total opacity of widget.
    
-    
    
+
    @@ -17385,44 +10594,39 @@

    - outer_size - + outer_size + property

    -
    outer_size
+
    outer_size: Size
 
    
 
-    
    
-
+  
    
+  
       
    The size of the widget (including padding and border).
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Size
+          
    Outer size.
    		
         
    
-                  Size
-            
-              
    
-                
    Outer size.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -17431,77 +10635,63 @@

    - region - + region + property

    -
    region
+
    region: Region
 
    
 
-    
    
-
+  
    
+  
       
    The region occupied by this widget, relative to the Screen.
    
 
-
-
    Raises:
    
-    
-      
+  
    Raises:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                NoScreen
+          
    If there is no screen.
    		
         
    
-                  NoScreen
-            
-              
    
-                
    If there is no screen.
    
-              
    
-            
    
-                  NoWidget
-            
-              
    
-                
    If the widget is not on the screen.
    
-              
    
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  Region
-            
-              
    
-                
    Region within screen occupied by widget.
    
-              
    
-            
    
-    
    
+        
+          
+                errors.NoWidget
+          
+          
    If the widget is not on the screen.
    
+        
+    
+  
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                Region
+          
    Region within screen occupied by widget.
    
+
    @@ -17510,44 +10700,39 @@

    - scroll_offset - + scroll_offset + property

    -
    scroll_offset
+
    scroll_offset: Offset
 
    
 
-    
    
-
+  
    
+  
       
    Get the current scroll offset.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Offset
+          
    Offset a container has been scrolled by.
    		
         
    
-                  Offset
-            
-              
    
-                
    Offset a container has been scrolled by.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -17556,22 +10741,24 @@

    - scroll_x - + scroll_x + class-attribute instance-attribute

    -
    scroll_x = Reactive(0.0, repaint=False, layout=False)
+
    scroll_x: Reactive[float] = Reactive(
+    0.0, repaint=False, layout=False
+)
 
    
 
-    
    
-
+  
    
+  
       
    The scroll position on the X axis.
    
-    
    
+
    @@ -17580,22 +10767,24 @@

    - scroll_y - + scroll_y + class-attribute instance-attribute

    -
    scroll_y = Reactive(0.0, repaint=False, layout=False)
+
    scroll_y: Reactive[float] = Reactive(
+    0.0, repaint=False, layout=False
+)
 
    
 
-    
    
-
+  
    
+  
       
    The scroll position on the Y axis.
    
-    
    
+
    @@ -17604,44 +10793,39 @@

    - scrollable_content_region - + scrollable_content_region + property

    -
    scrollable_content_region
+
    scrollable_content_region: Region
 
    
 
-    
    
-
+  
    
+  
       
    Gets an absolute region containing the scrollable content (minus padding, border, and scrollbars).
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Region
+          
    Screen region that contains a widget's content.
    		
         
    
-                  Region
-            
-              
    
-                
    Screen region that contains a widget's content.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -17650,44 +10834,39 @@

    - scrollable_size - + scrollable_size + property

    -
    scrollable_size
+
    scrollable_size: Size
 
    
 
-    
    
-
+  
    
+  
       
    The size of the scrollable content.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Size
+          
    Scrollable content size.
    		
         
    
-                  Size
-            
-              
    
-                
    Scrollable content size.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -17696,49 +10875,43 @@

    - scrollbar_corner - + scrollbar_corner + property

    -
    scrollbar_corner
+
    scrollbar_corner: ScrollBarCorner
 
    
 
-    
    
-
+  
    
+  
       
    The scrollbar corner.
    
 
-
 
    
   Note
   
    This will create a scrollbar corner if one doesn't exist.
    
 
    
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  ScrollBarCorner
-            
-              
    
-                
    ScrollBarCorner Widget.
    
-              
    
-            
    
-    
    
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                ScrollBarCorner
+          
    ScrollBarCorner Widget.
    
+
    @@ -17747,44 +10920,39 @@

    - scrollbar_gutter - + scrollbar_gutter + property

    -
    scrollbar_gutter
+
    scrollbar_gutter: Spacing
 
    
 
-    
    
-
+  
    
+  
       
    Spacing required to fit scrollbar(s).
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Spacing
+          
    Scrollbar gutter spacing.
    		
         
    
-                  Spacing
-            
-              
    
-                
    Scrollbar gutter spacing.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -17793,44 +10961,39 @@

    - scrollbar_size_horizontal - + scrollbar_size_horizontal + property

    -
    scrollbar_size_horizontal
+
    scrollbar_size_horizontal: int
 
    
 
-    
    
-
+  
    
+  
       
    Get the height used by the horizontal scrollbar.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                int
+          
    Number of rows in the horizontal scrollbar.
    		
         
    
-                  int
-            
-              
    
-                
    Number of rows in the horizontal scrollbar.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -17839,44 +11002,39 @@

    - scrollbar_size_vertical - + scrollbar_size_vertical + property

    -
    scrollbar_size_vertical
+
    scrollbar_size_vertical: int
 
    
 
-    
    
-
+  
    
+  
       
    Get the width used by the vertical scrollbar.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                int
+          
    Number of columns in the vertical scrollbar.
    		
         
    
-                  int
-            
-              
    
-                
    Number of columns in the vertical scrollbar.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -17885,44 +11043,39 @@

    - scrollbars_enabled - + scrollbars_enabled + property

    -
    scrollbars_enabled
+
    scrollbars_enabled: tuple[bool, bool]
 
    
 
-    
    
-
+  
    
+  
       
    A tuple of booleans that indicate if scrollbars are enabled.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                tuple[bool, bool]
+          
    A tuple of (, )
    		
         
    
-                  tuple[bool, bool]
-            
-              
    
-                
    A tuple of (, )
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -17931,21 +11084,21 @@

    - scrollbars_space - + scrollbars_space + property

    -
    scrollbars_space
+
    scrollbars_space: tuple[int, int]
 
    
 
-    
    
-
+  
    
+  
       
    The number of cells occupied by scrollbars for width and height
    
-    
    
+
    @@ -17954,22 +11107,24 @@

    - show_horizontal_scrollbar - + show_horizontal_scrollbar + class-attribute instance-attribute

    -
    show_horizontal_scrollbar = Reactive(False, layout=True)
+
    show_horizontal_scrollbar: Reactive[bool] = Reactive(
+    False, layout=True
+)
 
    
 
-    
    
-
+  
    
+  
       
    Show a horizontal scrollbar?
    
-    
    
+
    @@ -17978,22 +11133,24 @@

    - show_vertical_scrollbar - + show_vertical_scrollbar + class-attribute instance-attribute

    -
    show_vertical_scrollbar = Reactive(False, layout=True)
+
    show_vertical_scrollbar: Reactive[bool] = Reactive(
+    False, layout=True
+)
 
    
 
-    
    
-
+  
    
+  
       
    Show a vertical scrollbar?
    
-    
    
+
    @@ -18002,22 +11159,22 @@

    - shrink - + shrink + class-attribute instance-attribute

    -
    shrink = Reactive(True)
+
    shrink: Reactive[bool] = Reactive(True)
 
    
 
-    
    
-
+  
    
+  
       
    Rich renderable may shrink below optimal size.
    
-    
    
+
    @@ -18026,44 +11183,39 @@

    - siblings - + siblings + property

    -
    siblings
+
    siblings: list[Widget]
 
    
 
-    
    
-
+  
    
+  
       
    Get the widget's siblings (self is removed from the return list).
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                list[Widget]
+          
    A list of siblings.
    		
         
    
-                  list[Widget]
-            
-              
    
-                
    A list of siblings.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -18072,44 +11224,39 @@

    - size - + size + property

    -
    size
+
    size: Size
 
    
 
-    
    
-
+  
    
+  
       
    The size of the content area.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Size
+          
    Content area size.
    		
         
    
-                  Size
-            
-              
    
-                
    Content area size.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -18118,22 +11265,22 @@

    - tooltip - + tooltip + - property writable + property

    -
    tooltip
+
    tooltip: RenderableType | None
 
    
 
-    
    
-
+  
    
+  
       
    Tooltip for the widget, or None for no tooltip.
    
-    
    
+
    @@ -18142,49 +11289,43 @@

    - vertical_scrollbar - + vertical_scrollbar + property

    -
    vertical_scrollbar
+
    vertical_scrollbar: ScrollBar
 
    
 
-    
    
-
+  
    
+  
       
    The vertical scrollbar (create if necessary).
    
 
-
 
    
   Note
   
    This will create a scrollbar if one doesn't exist.
    
 
    
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  ScrollBar
-            
-              
    
-                
    ScrollBar Widget.
    
-              
    
-            
    
-    
    
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                ScrollBar
+          
    ScrollBar Widget.
    
+
    @@ -18193,45 +11334,40 @@

    - virtual_region - + virtual_region + property

    -
    virtual_region
+
    virtual_region: Region
 
    
 
-    
    
-
+  
    
+  
       
    The widget region relative to it's container (which may not be visible,
 depending on scroll offset).
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Region
+          
    The virtual region.
    		
         
    
-                  Region
-            
-              
    
-                
    The virtual region.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -18240,45 +11376,40 @@

    - virtual_region_with_margin - + virtual_region_with_margin + property

    -
    virtual_region_with_margin
+
    virtual_region_with_margin: Region
 
    
 
-    
    
-
+  
    
+  
       
    The widget region relative to its container (including margin), which may not be visible,
 depending on the scroll offset.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Region
+          
    The virtual region of the Widget, inclusive of its margin.
    		
         
    
-                  Region
-            
-              
    
-                
    The virtual region of the Widget, inclusive of its margin.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -18287,22 +11418,24 @@

    - virtual_size - + virtual_size + class-attribute instance-attribute

    -
    virtual_size = Reactive(Size(0, 0), layout=True)
+
    virtual_size: Reactive[Size] = Reactive(
+    Size(0, 0), layout=True
+)
 
    
 
-    
    
-
+  
    
+  
       
    The virtual (scrollable) size of the widget.
    
-    
    
+
    @@ -18311,44 +11444,39 @@

    - visible_siblings - + visible_siblings + property

    -
    visible_siblings
+
    visible_siblings: list[Widget]
 
    
 
-    
    
-
+  
    
+  
       
    A list of siblings which will be shown.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                list[Widget]
+          
    List of siblings.
    		
         
    
-                  list[Widget]
-            
-              
    
-                
    List of siblings.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -18357,44 +11485,39 @@

    - window_region - + window_region + property

    -
    window_region
+
    window_region: Region
 
    
 
-    
    
-
+  
    
+  
       
    The region within the scrollable area that is currently visible.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Region
+          
    New region.
    		
         
    
-                  Region
-            
-              
    
-                
    New region.
    
-              
    
-            
    
-    
    
+    
+  
+
    @@ -18403,104 +11526,97 @@

    +

    - allow_focus + allow_focus

    -
    allow_focus()
+
    allow_focus()
 
    
 
-    
    
-
+  
    
+  
       
    Check if the widget is permitted to focus.
    
 
    The base class returns can_focus.
 This method maybe overridden if additional logic is required.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                bool
+          
    True if the widget may be focused, or False if it may not be focused.
    		
         
    
-                  bool
-            
-              
    
-                
    True if the widget may be focused, or False if it may not be focused.
    
-              
    
-            
    
+    
+  
 
-    
    
+
    +

    - allow_focus_children + allow_focus_children

    -
    allow_focus_children()
+
    allow_focus_children()
 
    
 
-    
    
-
+  
    
+  
       
    Check if a widget's children may be focused.
    
 
    The base class returns can_focus_children.
 This method maybe overridden if additional logic is required.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                bool
+          
    True if the widget's children may be focused, or False if the widget's children may not be focused.
    		
         
    
-                  bool
-            
-              
    
-                
    True if the widget's children may be focused, or False if the widget's children may not be focused.
    
-              
    
-            
    
+    
+  
 
-    
    
+
    +

    - anchor + anchor

    -
    anchor(*, animate=False)
+
    anchor(*, animate=False)
 
    
 
-    
    
-
+  
    
+  
       
    Anchor the widget, which scrolls it into view (like scroll_visible),
 but also keeps it in view if the widget's size changes, or the size of its container changes.
    
 
    
@@ -18508,252 +11624,191 @@ 
    
 
    Anchored widgets will be un-anchored if the users scrolls the container.
    
 
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    True if the scroll should animate, or False if it shouldn't.
    		
+                False
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    True if the scroll should animate, or False if it shouldn't.
    
-              
    
-                		
-                  False
-            
    
-
-    
    
+
    +

    - animate + animate

    -
    animate(
-    attribute,
-    value,
+
    animate(
+    attribute,
+    value,
     *,
-    final_value=...,
-    duration=None,
-    speed=None,
-    delay=0.0,
-    easing=DEFAULT_EASING,
-    on_complete=None,
-    level="full"
+    final_value=...,
+    duration=None,
+    speed=None,
+    delay=0.0,
+    easing=DEFAULT_EASING,
+    on_complete=None,
+    level="full"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Animate an attribute.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    attribute
+                str
+          
    Name of the attribute to animate.
    		
+              required
+          
    value
+                float | Animatable
+          
    The value to animate to.
    		
+              required
+          
    final_value
+                object
+          
    The final value of the animation. Defaults to value if not set.
    		
+                ...
+          
    duration
+                float | None
+          
    The duration (in seconds) of the animation.
    		
+                None
+          
    speed
+                float | None
+          
    The speed of the animation.
    		
+                None
+          
    delay
+                float
+          
    A delay (in seconds) before the animation starts.
    		
+                0.0
+          
    easing
+                EasingFunction | str
+          
    An easing method.
    		
+                DEFAULT_EASING
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'full'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      attribute
-
                    		
-                  str
-            
-              
    
-                
    Name of the attribute to animate.
    
-              
    
-                		
-                required
-            
    
-
                      value
-
                    		
-                  float | Animatable
-            
-              
    
-                
    The value to animate to.
    
-              
    
-                		
-                required
-            
    
-
                      final_value
-
                    		
-                  object
-            
-              
    
-                
    The final value of the animation. Defaults to value if not set.
    
-              
    
-                		
-                  ...
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    The duration (in seconds) of the animation.
    
-              
    
-                		
-                  None
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    The speed of the animation.
    
-              
    
-                		
-                  None
-            
    
-
                      delay
-
                    		
-                  float
-            
-              
    
-                
    A delay (in seconds) before the animation starts.
    
-              
    
-                		
-                  0.0
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str
-            
-              
    
-                
    An easing method.
    
-              
    
-                		
-                  DEFAULT_EASING
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'full'
-            
    
-
-    
    
+
    +

    - batch - + batch + async

    -
    batch()
+
    batch()
 
    
 
-    
    
-
+  
    
+  
       
    Async context manager that combines widget locking and update batching.
    
 
    Use this async context manager whenever you want to acquire the widget lock and
 batch app updates at the same time.
    
 
-
 
    
   Example
   
    async with container.batch():
@@ -18761,352 +11816,310 @@ 
    
     await container.mount(Label("All buttons are gone."))
 
    
 
    
-    
    
+
    +

    - begin_capture_print + begin_capture_print

    -
    begin_capture_print(stdout=True, stderr=True)
+
    begin_capture_print(stdout=True, stderr=True)
 
    
 
-    
    
-
+  
    
+  
       
    Capture text from print statements (or writes to stdout / stderr).
    
 
    If printing is captured, the widget will be sent an events.Print message.
    
 
    Call end_capture_print to disable print capture.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    stdout
+                bool
+          
    Whether to capture stdout.
    		
+                True
+          
    stderr
+                bool
+          
    Whether to capture stderr.
    		
+                True
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      stdout
-
                    		
-                  bool
-            
-              
    
-                
    Whether to capture stdout.
    
-              
    
-                		
-                  True
-            
    
-
                      stderr
-
                    		
-                  bool
-            
-              
    
-                
    Whether to capture stderr.
    
-              
    
-                		
-                  True
-            
    
-
-    
    
+
    +

    - blur + blur

    -
    blur()
+
    blur()
 
    
 
-    
    
-
+  
    
+  
       
    Blur (un-focus) the widget.
    
 
    Focus will be moved to the next available widget in the focus chain..
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Self
+          
    The Widget instance.
    		
         
    
-                  Self
-            
-              
    
-                
    The Widget instance.
    
-              
    
-            
    
+    
+  
 
-    
    
+
    +

    - can_view + can_view

    -
    can_view(widget)
+
    can_view(widget)
 
    
 
-    
    
-
+  
    
+  
       
    Check if a given widget is in the current view (scrollable area).
    
 
    Note: This doesn't necessarily equate to a widget being visible.
 There are other reasons why a widget may not be visible.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    widget
+                Widget
+          
    A widget that is a descendant of self.
    		
+              required
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                bool
+          
    True if the entire widget is in view, False if it is partially visible or not in view.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      widget
-
                    		
-                  Widget
-            
-              
    
-                
    A widget that is a descendant of self.
    
-              
    
-                		
-                required
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  bool
-            
-              
    
-                
    True if the entire widget is in view, False if it is partially visible or not in view.
    
-              
    
-            
    
-
-    
    
+
    +

    - capture_mouse + capture_mouse

    -
    capture_mouse(capture=True)
+
    capture_mouse(capture=True)
 
    
 
-    
    
-
+  
    
+  
       
    Capture (or release) the mouse.
    
 
    When captured, mouse events will go to this widget even when the pointer is not directly over the widget.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    capture
+                bool
+          
    True to capture or False to release.
    		
+                True
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      capture
-
                    		
-                  bool
-            
-              
    
-                
    True to capture or False to release.
    
-              
    
-                		
-                  True
-            
    
-
-    
    
+
    +

    - check_message_enabled + check_message_enabled

    -
    check_message_enabled(message)
+
    check_message_enabled(message)
 
    
 
-    
    
-
+  
    
+  
       
    Check if a given message is enabled (allowed to be sent).
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    message
+                Message
+          
    A message object
    		
+              required
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                bool
+          
    True if the message will be sent, or False if it is disabled.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      message
-
                    		
-                  Message
-            
-              
    
-                
    A message object
    
-              
    
-                		
-                required
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  bool
-            
-              
    
-                
    True if the message will be sent, or False if it is disabled.
    
-              
    
-            
    
-
-    
    
+
    +

    - clear_anchor + clear_anchor

    -
    clear_anchor()
+
    clear_anchor()
 
    
 
-    
    
-
+  
    
+  
       
    Stop anchoring this widget (a no-op if this widget is not anchored).
    
 
-    
    
+
    +

    - clear_cached_dimensions + clear_cached_dimensions

    -
    clear_cached_dimensions()
+
    clear_cached_dimensions()
 
    
 
-    
    
-
+  
    
+  
       
    Clear cached results of get_content_width and get_content_height.
    
 
    Call if the widget's renderable changes size after the widget has been created.
    
 
    
@@ -19114,29 +12127,29 @@ 
    
 
    This is not required if you are extending Static.
    
 
    
 
-    
    
+
    +

    - compose + compose

    -
    compose()
+
    compose()
 
    
 
-    
    
-
+  
    
+  
       
    Called by Textual to create child widgets.
    
 
    This method is called when a widget is mounted or by setting recompose=True when
 calling refresh().
    
 
    Note that you don't typically need to explicitly call this method.
    
 
-
 
    
   Example
   
    def compose(self) -> ComposeResult:
@@ -19146,1754 +12159,1435 @@ 
    
     yield Footer()
 
    
 
    
-    
    
+
    +

    - compose_add_child + compose_add_child

    -
    compose_add_child(widget)
+
    compose_add_child(widget)
 
    
 
-    
    
-
+  
    
+  
       
    Add a node to children.
    
 
    This is used by the compose process when it adds children.
 There is no need to use it directly, but you may want to override it in a subclass
 if you want children to be attached to a different node.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    widget
+                Widget
+          
    A Widget to add.
    		
+              required
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      widget
-
                    		
-                  Widget
-            
-              
    
-                
    A Widget to add.
    
-              
    
-                		
-                required
-            
    
-
-    
    
+
    +

    - end_capture_print + end_capture_print

    -
    end_capture_print()
+
    end_capture_print()
 
    
 
-    
    
-
+  
    
+  
       
    End print capture (set with begin_capture_print).
    
 
-    
    
+
    +

    - focus + focus

    -
    focus(scroll_visible=True)
+
    focus(scroll_visible=True)
 
    
 
-    
    
-
+  
    
+  
       
    Give focus to this widget.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    scroll_visible
+                bool
+          
    Scroll parent to make this widget visible.
    		
+                True
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                Self
+          
    The Widget instance.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      scroll_visible
-
                    		
-                  bool
-            
-              
    
-                
    Scroll parent to make this widget visible.
    
-              
    
-                		
-                  True
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  Self
-            
-              
    
-                
    The Widget instance.
    
-              
    
-            
    
-
-    
    
+
    +

    - get_child_by_id + get_child_by_id

    -
    -
    get_child_by_id(id: str) -> Widget
-
    get_child_by_id(
-    id: str, expect_type: type[ExpectType]
-) -> ExpectType
-
    -
    get_child_by_id(id, expect_type=None)
+
    get_child_by_id(id, expect_type=None)
 
    
 
-    
    
-
+  
    
+  
       
    Return the first child (immediate descendent) of this node with the given ID.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    id
+                str
+          
    The ID of the child.
    		
+              required
+          
    expect_type
+                type[ExpectType] | None
+          
    Require the object be of the supplied type, or None for any type.
    		
+                None
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                ExpectType | Widget
+          
    The first child of this node with the ID.
    
+
+  
    Raises:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                NoMatches
+          
    if no children could be found for this ID
    
+                WrongType
+          
    if the wrong type was found.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      id
-
                    		
-                  str
-            
-              
    
-                
    The ID of the child.
    
-              
    
-                		
-                required
-            
    
-
                      expect_type
-
                    		
-                  type[ExpectType] | None
-            
-              
    
-                
    Require the object be of the supplied type, or None for any type.
    
-              
    
-                		
-                  None
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  ExpectType | Widget
-            
-              
    
-                
    The first child of this node with the ID.
    
-              
    
-            
    
-
-
-
    Raises:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  NoMatches
-            
-              
    
-                
    if no children could be found for this ID
    
-              
    
-            
    
-                  WrongType
-            
-              
    
-                
    if the wrong type was found.
    
-              
    
-            
    
-
-    
    
+
    +

    - get_child_by_type + get_child_by_type

    -
    get_child_by_type(expect_type)
+
    get_child_by_type(expect_type)
 
    
 
-    
    
-
+  
    
+  
       
    Get the first immediate child of a given type.
    
 
    Only returns exact matches, and so will not match subclasses of the given type.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    expect_type
+                type[ExpectType]
+          
    The type of the child to search for.
    		
+              required
+          
    
+
+  
    Raises:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                NoMatches
+          
    If no matching child is found.
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                ExpectType
+          
    The first immediate child widget with the expected type.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      expect_type
-
                    		
-                  type[ExpectType]
-            
-              
    
-                
    The type of the child to search for.
    
-              
    
-                		
-                required
-            
    
-
-
-
    Raises:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  NoMatches
-            
-              
    
-                
    If no matching child is found.
    
-              
    
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  ExpectType
-            
-              
    
-                
    The first immediate child widget with the expected type.
    
-              
    
-            
    
-
-    
    
+
    +

    - get_component_rich_style + get_component_rich_style

    -
    get_component_rich_style(*names, partial=False)
+
    get_component_rich_style(*names, partial=False)
 
    
 
-    
    
-
+  
    
+  
       
    Get a Rich style for a component.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    names
+                str
+          
    Names of components.
    		
+                ()
+          
    partial
+                bool
+          
    Return a partial style (not combined with parent).
    		
+                False
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                Style
+          
    A Rich style object.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      name
-
                    		
-            
-              
    
-                
    Name of component.
    
-              
    
-                		
-                required
-            
    
-
                      partial
-
                    		
-                  bool
-            
-              
    
-                
    Return a partial style (not combined with parent).
    
-              
    
-                		
-                  False
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  Style
-            
-              
    
-                
    A Rich style object.
    
-              
    
-            
    
-
-    
    
+
    +

    - get_content_height + get_content_height

    -
    get_content_height(container, viewport, width)
+
    get_content_height(container, viewport, width)
 
    
 
-    
    
-
+  
    
+  
       
    Called by Textual to get the height of the content area. May be overridden in a subclass.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    container
+                Size
+          
    Size of the container (immediate parent) widget.
    		
+              required
+          
    viewport
+                Size
+          
    Size of the viewport.
    		
+              required
+          
    width
+                int
+          
    Width of renderable.
    		
+              required
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                int
+          
    The height of the content.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      container
-
                    		
-                  Size
-            
-              
    
-                
    Size of the container (immediate parent) widget.
    
-              
    
-                		
-                required
-            
    
-
                      viewport
-
                    		
-                  Size
-            
-              
    
-                
    Size of the viewport.
    
-              
    
-                		
-                required
-            
    
-
                      width
-
                    		
-                  int
-            
-              
    
-                
    Width of renderable.
    
-              
    
-                		
-                required
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  int
-            
-              
    
-                
    The height of the content.
    
-              
    
-            
    
-
-    
    
+
    +

    - get_content_width + get_content_width

    -
    get_content_width(container, viewport)
+
    get_content_width(container, viewport)
 
    
 
-    
    
-
+  
    
+  
       
    Called by textual to get the width of the content area. May be overridden in a subclass.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    container
+                Size
+          
    Size of the container (immediate parent) widget.
    		
+              required
+          
    viewport
+                Size
+          
    Size of the viewport.
    		
+              required
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                int
+          
    The optimal width of the content.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      container
-
                    		
-                  Size
-            
-              
    
-                
    Size of the container (immediate parent) widget.
    
-              
    
-                		
-                required
-            
    
-
                      viewport
-
                    		
-                  Size
-            
-              
    
-                
    Size of the viewport.
    
-              
    
-                		
-                required
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  int
-            
-              
    
-                
    The optimal width of the content.
    
-              
    
-            
    
-
-    
    
+
    +

    - get_loading_widget + get_loading_widget

    -
    get_loading_widget()
+
    get_loading_widget()
 
    
 
-    
    
-
+  
    
+  
       
    Get a widget to display a loading indicator.
    
 
    The default implementation will defer to App.get_loading_widget.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Widget
+          
    A widget in place of this widget to indicate a loading.
    		
         
    
-                  Widget
-            
-              
    
-                
    A widget in place of this widget to indicate a loading.
    
-              
    
-            
    
+    
+  
 
-    
    
+
    +

    - get_pseudo_class_state + get_pseudo_class_state

    -
    get_pseudo_class_state()
+
    get_pseudo_class_state()
 
    
 
-    
    
-
+  
    
+  
       
    Get an object describing whether each pseudo class is present on this object or not.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                PseudoClasses
+          
    A PseudoClasses object describing the pseudo classes that are present.
    		
         
    
-                  PseudoClasses
-            
-              
    
-                
    A PseudoClasses object describing the pseudo classes that are present.
    
-              
    
-            
    
+    
+  
 
-    
    
+
    +

    - get_pseudo_classes + get_pseudo_classes

    -
    get_pseudo_classes()
+
    get_pseudo_classes()
 
    
 
-    
    
-
+  
    
+  
       
    Pseudo classes for a widget.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                Iterable[str]
+          
    Names of the pseudo classes.
    		
         
    
-                  Iterable[str]
-            
-              
    
-                
    Names of the pseudo classes.
    
-              
    
-            
    
+    
+  
 
-    
    
+
    +

    - get_style_at + get_style_at

    -
    get_style_at(x, y)
+
    get_style_at(x, y)
 
    
 
-    
    
-
+  
    
+  
       
    Get the Rich style in a widget at a given relative offset.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    x
+                int
+          
    X coordinate relative to the widget.
    		
+              required
+          
    y
+                int
+          
    Y coordinate relative to the widget.
    		
+              required
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                Style
+          
    A rich Style object.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      x
-
                    		
-                  int
-            
-              
    
-                
    X coordinate relative to the widget.
    
-              
    
-                		
-                required
-            
    
-
                      y
-
                    		
-                  int
-            
-              
    
-                
    Y coordinate relative to the widget.
    
-              
    
-                		
-                required
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  Style
-            
-              
    
-                
    A rich Style object.
    
-              
    
-            
    
-
-    
    
+
    +

    - get_widget_by_id + get_widget_by_id

    -
    -
    get_widget_by_id(id: str) -> Widget
-
    get_widget_by_id(
-    id: str, expect_type: type[ExpectType]
-) -> ExpectType
-
    -
    get_widget_by_id(id, expect_type=None)
+
    get_widget_by_id(id, expect_type=None)
 
    
 
-    
    
-
+  
    
+  
       
    Return the first descendant widget with the given ID.
    
 
    Performs a depth-first search rooted at this widget.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    id
+                str
+          
    The ID to search for in the subtree.
    		
+              required
+          
    expect_type
+                type[ExpectType] | None
+          
    Require the object be of the supplied type, or None for any type.
    		
+                None
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                ExpectType | Widget
+          
    The first descendant encountered with this ID.
    
+
+  
    Raises:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                NoMatches
+          
    if no children could be found for this ID.
    
+                WrongType
+          
    if the wrong type was found.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      id
-
                    		
-                  str
-            
-              
    
-                
    The ID to search for in the subtree.
    
-              
    
-                		
-                required
-            
    
-
                      expect_type
-
                    		
-                  type[ExpectType] | None
-            
-              
    
-                
    Require the object be of the supplied type, or None for any type.
    
-              
    
-                		
-                  None
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  ExpectType | Widget
-            
-              
    
-                
    The first descendant encountered with this ID.
    
-              
    
-            
    
-
-
-
    Raises:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  NoMatches
-            
-              
    
-                
    if no children could be found for this ID.
    
-              
    
-            
    
-                  WrongType
-            
-              
    
-                
    if the wrong type was found.
    
-              
    
-            
    
-
-    
    
+
    +

    - mount + mount

    -
    mount(*widgets, before=None, after=None)
+
    mount(*widgets, before=None, after=None)
 
    
 
-    
    
-
+  
    
+  
       
    Mount widgets below this widget (making this widget a container).
    
 
-
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    
-
                      *widgets
-
                    		
-                  Widget
-            
-              
    
-                
    The widget(s) to mount.
    
-              
    
-                		
-                  ()
-            
    
-
                      before
-
                    		
-                  int | str | Widget | None
-            
-              
    
-                
    Optional location to mount before. An int is the index
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    *widgets
+                Widget
+          
    The widget(s) to mount.
    		
+                ()
+          
    before
+                int | str | Widget | None
+          
    Optional location to mount before. An int is the index
 of the child to mount before, a str is a query_one query to
-find the widget to mount before.
    
-              
-                		
-                  None
-            
    
-
                      after
-
                    		
-                  int | str | Widget | None
-            
-              
    
-                
    Optional location to mount after. An int is the index
-of the child to mount after, a str is a query_one query to
-find the widget to mount after.
    
-              
    
-                		
-                  None
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  AwaitMount
-            
-              
    
-                
    An awaitable object that waits for widgets to be mounted.
    
-              
    
-            
    
-
-
-
    Raises:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  MountError
-            
-              
    
-                
    If there is a problem with the mount request.
    
-              
    
-            
    
-
+find the widget to mount before.
    		
+                None
+          
    after
+                int | str | Widget | None
+          
    Optional location to mount after. An int is the index
+of the child to mount after, a str is a query_one query to
+find the widget to mount after.
    		
+                None
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                AwaitMount
+          
    An awaitable object that waits for widgets to be mounted.
    
+
+  
    Raises:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                MountError
+          
    If there is a problem with the mount request.
    
 
 
    
   Note
   
    Only one of before or after can be provided. If both are
 provided a MountError will be raised.
    
 
    
-    
    
+
    +

    - mount_all + mount_all

    -
    mount_all(widgets, *, before=None, after=None)
+
    mount_all(widgets, *, before=None, after=None)
 
    
 
-    
    
-
+  
    
+  
       
    Mount widgets from an iterable.
    
 
-
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
+          
+        
+    
+  
    NameTypeDescriptionDefault
    
-
                      widgets
-
                    		
-                  Iterable[Widget]
-            
-              
    
-                
    An iterable of widgets.
    
-              
    
-                		
-                required
-            
    
-
                      before
-
                    		
-                  int | str | Widget | None
-            
-              
    
-                
    Optional location to mount before. An int is the index
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
-            
-          
-          
-            
-            
-            
+          
+        
+        
+          
+          
+          
-            
-          
-      
-    
    NameTypeDescriptionDefault
    widgets
+                Iterable[Widget]
+          
    An iterable of widgets.
    		
+              required
+          
    before
+                int | str | Widget | None
+          
    Optional location to mount before. An int is the index
 of the child to mount before, a str is a query_one query to
-find the widget to mount before.
    
-              
-                		
-                  None
-            
    
-
                      after
-
                    		
-                  int | str | Widget | None
-            
-              
    
-                
    Optional location to mount after. An int is the index
+find the widget to mount before.
    		
+                None
+          
    after
+                int | str | Widget | None
+          
    Optional location to mount after. An int is the index
 of the child to mount after, a str is a query_one query to
-find the widget to mount after.
    
-              
-                		
-                  None
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  AwaitMount
-            
-              
    
-                
    An awaitable object that waits for widgets to be mounted.
    
-              
    
-            
    
-
-
-
    Raises:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  MountError
-            
-              
    
-                
    If there is a problem with the mount request.
    
-              
    
-            
    
-
+find the widget to mount after.
    		
+                None
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                AwaitMount
+          
    An awaitable object that waits for widgets to be mounted.
    
+
+  
    Raises:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                MountError
+          
    If there is a problem with the mount request.
    
 
 
    
   Note
   
    Only one of before or after can be provided. If both are
 provided a MountError will be raised.
    
 
    
-    
    
+
    -

    - mount_composed_widgets +

    + mount_composed_widgets + async

    -
    mount_composed_widgets(widgets)
+
    mount_composed_widgets(widgets)
 
    
 
-    
    
-
+  
    
+  
       
    Called by Textual to mount widgets after compose.
    
 
    There is generally no need to implement this method in your application.
 See Lazy for a class which uses this method to implement
 lazy mounting.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    widgets
+                list[Widget]
+          
    A list of child widgets.
    		
+              required
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      widgets
-
                    		
-                  list[Widget]
-            
-              
    
-                
    A list of child widgets.
    
-              
    
-                		
-                required
-            
    
-
-    
    
+
    +

    - move_child + move_child

    -
    -
    move_child(
-    child: int | Widget,
-    *,
-    before: int | Widget,
-    after: None = None
-) -> None
-
    move_child(
-    child: int | Widget,
-    *,
-    after: int | Widget,
-    before: None = None
-) -> None
-
    -
    move_child(child, *, before=None, after=None)
+
    move_child(child, *, before=None, after=None)
 
    
 
-    
    
-
+  
    
+  
       
    Move a child widget within its parent's list of children.
    
 
-
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      child
-
                    		
-                  int | Widget
-            
-              
    
-                
    The child widget to move.
    
-              
    
-                		
-                required
-            
    
-
                      before
-
                    		
-                  int | Widget | None
-            
-              
    
-                
    Child widget or location index to move before.
    
-              
    
-                		
-                  None
-            
    
-
                      after
-
                    		
-                  int | Widget | None
-            
-              
    
-                
    Child widget or location index to move after.
    
-              
    
-                		
-                  None
-            
    
-
-
-
    Raises:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  WidgetError
-            
-              
    
-                
    If there is a problem with the child or target.
    
-              
    
-            
    
-
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    child
+                int | Widget
+          
    The child widget to move.
    		
+              required
+          
    before
+                int | Widget | None
+          
    Child widget or location index to move before.
    		
+                None
+          
    after
+                int | Widget | None
+          
    Child widget or location index to move after.
    		
+                None
+          
    
+
+  
    Raises:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                WidgetError
+          
    If there is a problem with the child or target.
    
 
 
    
   Note
   
    Only one of before or after can be provided. If neither
 or both are provided a WidgetError will be raised.
    
 
    
-    
    
+
    +

    - notify + notify

    -
    notify(
-    message,
+
    notify(
+    message,
     *,
-    title="",
-    severity="information",
-    timeout=None
+    title="",
+    severity="information",
+    timeout=None
 )
 
    
 
-    
    
-
+  
    
+  
       
    Create a notification.
    
 
    
 
    Tip
    
 
    This method is thread-safe.
    
 
    
 
-
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      message
-
                    		
-                  str
-            
-              
    
-                
    The message for the notification.
    
-              
    
-                		
-                required
-            
    
-
                      title
-
                    		
-                  str
-            
-              
    
-                
    The title for the notification.
    
-              
    
-                		
-                  ''
-            
    
-
                      severity
-
                    		
-                  SeverityLevel
-            
-              
    
-                
    The severity of the notification.
    
-              
    
-                		
-                  'information'
-            
    
-
                      timeout
-
                    		
-                  float | None
-            
-              
    
-                
    The timeout (in seconds) for the notification, or None for default.
    
-              
    
-                		
-                  None
-            
    
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    message
+                str
+          
    The message for the notification.
    		
+              required
+          
    title
+                str
+          
    The title for the notification.
    		
+                ''
+          
    severity
+                SeverityLevel
+          
    The severity of the notification.
    		
+                'information'
+          
    timeout
+                float | None
+          
    The timeout (in seconds) for the notification, or None for default.
    		
+                None
+          
    
       
    See App.notify for the full
 documentation for this method.
    
 
-    
    
+
    -

    - on_prune +

    + on_prune + async

    -
    on_prune(event)
+
    on_prune(event)
 
    
 
-    
    
-
+  
    
+  
       
    Close message loop when asked to prune.
    
 
-    
    
+
    +

    - post_message + post_message

    -
    post_message(message)
+
    post_message(message)
 
    
 
-    
    
-
+  
    
+  
       
    Post a message to this widget.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    message
+                Message
+          
    Message to post.
    		
+              required
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                bool
+          
    True if the message was posted, False if this widget was closed / closing.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      message
-
                    		
-                  Message
-            
-              
    
-                
    Message to post.
    
-              
    
-                		
-                required
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  bool
-            
-              
    
-                
    True if the message was posted, False if this widget was closed / closing.
    
-              
    
-            
    
-
-    
    
+
    +

    - post_render + post_render

    -
    post_render(renderable)
+
    post_render(renderable)
 
    
 
-    
    
-
+  
    
+  
       
    Applies style attributes to the default renderable.
    
 
    This method is called by Textual itself.
 It is unlikely you will need to call or implement this method.
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                ConsoleRenderable
+          
    A new renderable.
    		
         
    
-                  ConsoleRenderable
-            
-              
    
-                
    A new renderable.
    
-              
    
-            
    
+    
+  
 
-    
    
+
    -

    - recompose +

    + recompose + async

    -
    recompose()
+
    recompose()
 
    
 
-    
    
-
+  
    
+  
       
    Recompose the widget.
    
 
    Recomposing will remove children and call self.compose again to remount.
    
 
-    
    
+
    +

    - refresh + refresh

    -
    refresh(
-    *regions, repaint=True, layout=False, recompose=False
+
    refresh(
+    *regions, repaint=True, layout=False, recompose=False
 )
 
    
 
-    
    
-
+  
    
+  
       
    Initiate a refresh of the widget.
    
 
    This method sets an internal flag to perform a refresh, which will be done on the
 next idle event. Only one refresh will be done even if this method is called multiple times.
    
@@ -20905,264 +13599,220 @@ 
    
 do this automatically.
    
 
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    *regions
+                Region
+          
    Additional screen regions to mark as dirty.
    		
+                ()
+          
    repaint
+                bool
+          
    Repaint the widget (will call render() again).
    		
+                True
+          
    layout
+                bool
+          
    Also layout widgets in the view.
    		
+                False
+          
    recompose
+                bool
+          
    Re-compose the widget (will remove and re-mount children).
    		
+                False
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                Self
+          
    The Widget instance.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      *regions
-
                    		
-                  Region
-            
-              
    
-                
    Additional screen regions to mark as dirty.
    
-              
    
-                		
-                  ()
-            
    
-
                      repaint
-
                    		
-                  bool
-            
-              
    
-                
    Repaint the widget (will call render() again).
    
-              
    
-                		
-                  True
-            
    
-
                      layout
-
                    		
-                  bool
-            
-              
    
-                
    Also layout widgets in the view.
    
-              
    
-                		
-                  False
-            
    
-
                      recompose
-
                    		
-                  bool
-            
-              
    
-                
    Re-compose the widget (will remove and re-mount children).
    
-              
    
-                		
-                  False
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  Self
-            
-              
    
-                
    The Widget instance.
    
-              
    
-            
    
-
-    
    
+
    +

    - release_mouse + release_mouse

    -
    release_mouse()
+
    release_mouse()
 
    
 
-    
    
-
+  
    
+  
       
    Release the mouse.
    
 
    Mouse events will only be sent when the mouse is over the widget.
    
 
-    
    
+
    +

    - remove + remove

    -
    remove()
+
    remove()
 
    
 
-    
    
-
+  
    
+  
       
    Remove the Widget from the DOM (effectively deleting it).
    
 
-
-    
    Returns:
    
-    
-      
+  
    Returns:
    
+  
    
+    
+      
+        
+        
+      
+    
+    
-          
-          
+          
+          
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
         
    TypeDescription
+                AwaitRemove
+          
    An awaitable object that waits for the widget to be removed.
    		
         
    
-                  AwaitRemove
-            
-              
    
-                
    An awaitable object that waits for the widget to be removed.
    
-              
    
-            
    
+    
+  
 
-    
    
+
    +

    - remove_children + remove_children

    -
    remove_children(selector='*')
+
    remove_children(selector='*')
 
    
 
-    
    
-
+  
    
+  
       
    Remove the immediate children of this Widget from the DOM.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    selector
+                str | type[QueryType] | Iterable[Widget]
+          
    A CSS selector or iterable of widgets to remove.
    		
+                '*'
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                AwaitRemove
+          
    An awaitable object that waits for the direct children to be removed.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      selector
-
                    		
-                  str | type[QueryType] | Iterable[Widget]
-            
-              
    
-                
    A CSS selector or iterable of widgets to remove.
    
-              
    
-                		
-                  '*'
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  AwaitRemove
-            
-              
    
-                
    An awaitable object that waits for the direct children to be removed.
    
-              
    
-            
    
-
-    
    
+
    +

    - render + render

    -
    render()
+
    render()
 
    
 
-    
    
-
+  
    
+  
       
    Get text or Rich renderable for this widget.
    
 
    Implement this for custom widgets.
    
 
-
 
    
   Example
   
    from textual.app import RenderableType
@@ -21173,3305 +13823,2474 @@ 
    
         return "Welcome to [bold red]Textual[/]!"
 
    
 
    
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                RenderResult
+          
    Any renderable.
    
 
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  RenderResult
-            
-              
    
-                
    Any renderable.
    
-              
    
-            
    
-
-    
    
+
    +

    - render_line + render_line

    -
    render_line(y)
+
    render_line(y)
 
    
 
-    
    
-
+  
    
+  
       
    Render a line of content.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    y
+                int
+          
    Y Coordinate of line.
    		
+              required
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                Strip
+          
    A rendered line.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      y
-
                    		
-                  int
-            
-              
    
-                
    Y Coordinate of line.
    
-              
    
-                		
-                required
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  Strip
-            
-              
    
-                
    A rendered line.
    
-              
    
-            
    
-
-    
    
+
    +

    - render_lines + render_lines

    -
    render_lines(crop)
+
    render_lines(crop)
 
    
 
-    
    
-
+  
    
+  
       
    Render the widget in to lines.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    crop
+                Region
+          
    Region within visible area to render.
    		
+              required
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                list[Strip]
+          
    A list of list of segments.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      crop
-
                    		
-                  Region
-            
-              
    
-                
    Region within visible area to render.
    
-              
    
-                		
-                required
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  list[Strip]
-            
-              
    
-                
    A list of list of segments.
    
-              
    
-            
    
-
-    
    
+
    +

    - render_str + render_str

    -
    render_str(text_content)
+
    render_str(text_content)
 
    
 
-    
    
-
+  
    
+  
       
    Convert str in to a Text object.
    
 
    If you pass in an existing Text object it will be returned unaltered.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    text_content
+                str | Text
+          
    Text or str.
    		
+              required
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                Text
+          
    A text object.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      text_content
-
                    		
-                  str | Text
-            
-              
    
-                
    Text or str.
    
-              
    
-                		
-                required
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  Text
-            
-              
    
-                
    A text object.
    
-              
    
-            
    
-
-    
    
+
    -

    - run_action +

    + run_action + async

    -
    run_action(action)
+
    run_action(action)
 
    
 
-    
    
-
+  
    
+  
       
    Perform a given action, with this widget as the default namespace.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    action
+                str
+          
    Action encoded as a string.
    		
+              required
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      action
-
                    		
-                  str
-            
-              
    
-                
    Action encoded as a string.
    
-              
    
-                		
-                required
-            
    
-
-    
    
+
    +

    - scroll_down + scroll_down

    -
    scroll_down(
+
    scroll_down(
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll one line down.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_end + scroll_end

    -
    scroll_end(
+
    scroll_end(
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll to the end of the container.
    
 
-
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
+
+
    +

    - scroll_home + scroll_home

    -
    scroll_home(
+
    scroll_home(
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll to home position.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_left + scroll_left

    -
    scroll_left(
+
    scroll_left(
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll one cell left.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_page_down + scroll_page_down

    -
    scroll_page_down(
+
    scroll_page_down(
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll one page down.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_page_left + scroll_page_left

    -
    scroll_page_left(
+
    scroll_page_left(
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll one page left.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_page_right + scroll_page_right

    -
    scroll_page_right(
+
    scroll_page_right(
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll one page right.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_page_up + scroll_page_up

    -
    scroll_page_up(
+
    scroll_page_up(
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll one page up.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_relative + scroll_relative

    -
    scroll_relative(
-    x=None,
-    y=None,
+
    scroll_relative(
+    x=None,
+    y=None,
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll relative to current position.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    x
+                float | None
+          
    X distance (columns) to scroll, or None for no change.
    		
+                None
+          
    y
+                float | None
+          
    Y distance (rows) to scroll, or None for no change.
    		
+                None
+          
    animate
+                bool
+          
    Animate to new scroll position.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True. Or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      x
-
                    		
-                  float | None
-            
-              
    
-                
    X distance (columns) to scroll, or None for no change.
    
-              
    
-                		
-                  None
-            
    
-
                      y
-
                    		
-                  float | None
-            
-              
    
-                
    Y distance (rows) to scroll, or None for no change.
    
-              
    
-                		
-                  None
-            
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate to new scroll position.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True. Or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_right + scroll_right

    -
    scroll_right(
+
    scroll_right(
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll one cell right.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_to + scroll_to

    -
    scroll_to(
-    x=None,
-    y=None,
+
    scroll_to(
+    x=None,
+    y=None,
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
-)
-
    
-
-    
    
-
-      
    Scroll to a given (absolute) coordinate, optionally animating.
    
-
-
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      x
-
                    		
-                  float | None
-            
-              
    
-                
    X coordinate (column) to scroll to, or None for no change.
    
-              
    
-                		
-                  None
-            
    
-
                      y
-
                    		
-                  float | None
-            
-              
    
-                
    Y coordinate (row) to scroll to, or None for no change.
    
-              
    
-                		
-                  None
-            
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate to new scroll position.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
+)
+
    + +
    + +

    Scroll to a given (absolute) coordinate, optionally animating.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescriptionDefault
    x + float | None +

    X coordinate (column) to scroll to, or None for no change.

    		 + None +
    y + float | None +

    Y coordinate (row) to scroll to, or None for no change.

    		 + None +
    animate + bool +

    Animate to new scroll position.

    		 + True +
    speed + float | None +

    Speed of scroll if animate is True; or None to use duration.

    		 + None +
    duration + float | None +

    Duration of animation, if animate is True and speed is None.

    		 + None +
    easing + EasingFunction | str | None +

    An easing method for the scrolling animation.

    		 + None +
    force + bool +

    Force scrolling even when prohibited by overflow styling.

    		 + False +
    on_complete + CallbackType | None +

    A callable to invoke when the animation is finished.

    		 + None +
    level + AnimationLevel +

    Minimum level required for the animation to take place (inclusive).

    		 + 'basic' +
    Note

    The call to scroll is made after the next refresh.

    -
    +
    +

    - scroll_to_center + scroll_to_center

    -
    scroll_to_center(
-    widget,
-    animate=True,
+
    scroll_to_center(
+    widget,
+    animate=True,
     *,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    origin_visible=True,
-    on_complete=None,
-    level="basic"
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    origin_visible=True,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll this widget to the center of self.
    
 
    The center of the widget will be scrolled to the center of the container.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    widget
+                Widget
+          
    The widget to scroll to the center of self.
    		
+              required
+          
    animate
+                bool
+          
    Whether to animate the scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    origin_visible
+                bool
+          
    Ensure that the top left corner of the widget remains visible after the scroll.
    		
+                True
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      widget
-
                    		
-                  Widget
-            
-              
    
-                
    The widget to scroll to the center of self.
    
-              
    
-                		
-                required
-            
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Whether to animate the scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      origin_visible
-
                    		
-                  bool
-            
-              
    
-                
    Ensure that the top left corner of the widget remains visible after the scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_to_region + scroll_to_region

    -
    scroll_to_region(
-    region,
+
    scroll_to_region(
+    region,
     *,
-    spacing=None,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
+    spacing=None,
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
     center=False,
-    top=False,
-    origin_visible=True,
-    force=False,
-    on_complete=None,
-    level="basic"
+    top=False,
+    origin_visible=True,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scrolls a given region in to view, if required.
    
 
    This method will scroll the least distance required to move region fully within
 the scrollable area.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    region
+                Region
+          
    A region that should be visible.
    		
+              required
+          
    spacing
+                Spacing | None
+          
    Optional spacing around the region.
    		
+                None
+          
    animate
+                bool
+          
    True to animate, or False to jump.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    top
+                bool
+          
    Scroll region to top of container.
    		
+                False
+          
    origin_visible
+                bool
+          
    Ensure that the top left of the widget is within the window.
    		
+                True
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                Offset
+          
    The distance that was scrolled.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      region
-
                    		
-                  Region
-            
-              
    
-                
    A region that should be visible.
    
-              
    
-                		
-                required
-            
    
-
                      spacing
-
                    		
-                  Spacing | None
-            
-              
    
-                
    Optional spacing around the region.
    
-              
    
-                		
-                  None
-            
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    True to animate, or False to jump.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      top
-
                    		
-                  bool
-            
-              
    
-                
    Scroll region to top of container.
    
-              
    
-                		
-                  False
-            
    
-
                      origin_visible
-
                    		
-                  bool
-            
-              
    
-                
    Ensure that the top left of the widget is within the window.
    
-              
    
-                		
-                  True
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  Offset
-            
-              
    
-                
    The distance that was scrolled.
    
-              
    
-            
    
-
-    
    
+
    +

    - scroll_to_widget + scroll_to_widget

    -
    scroll_to_widget(
-    widget,
+
    scroll_to_widget(
+    widget,
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
     center=False,
-    top=False,
-    origin_visible=True,
-    force=False,
-    on_complete=None,
-    level="basic"
+    top=False,
+    origin_visible=True,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll scrolling to bring a widget in to view.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    widget
+                Widget
+          
    A descendant widget.
    		
+              required
+          
    animate
+                bool
+          
    True to animate, or False to jump.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    top
+                bool
+          
    Scroll widget to top of container.
    		
+                False
+          
    origin_visible
+                bool
+          
    Ensure that the top left of the widget is within the window.
    		
+                True
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                bool
+          
    True if any scrolling has occurred in any descendant, otherwise False.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      widget
-
                    		
-                  Widget
-            
-              
    
-                
    A descendant widget.
    
-              
    
-                		
-                required
-            
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    True to animate, or False to jump.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      top
-
                    		
-                  bool
-            
-              
    
-                
    Scroll widget to top of container.
    
-              
    
-                		
-                  False
-            
    
-
                      origin_visible
-
                    		
-                  bool
-            
-              
    
-                
    Ensure that the top left of the widget is within the window.
    
-              
    
-                		
-                  True
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  bool
-            
-              
    
-                
    True if any scrolling has occurred in any descendant, otherwise False.
    
-              
    
-            
    
-
-    
    
+
    +

    - scroll_up + scroll_up

    -
    scroll_up(
+
    scroll_up(
     *,
-    animate=True,
-    speed=None,
-    duration=None,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    animate=True,
+    speed=None,
+    duration=None,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll one line up.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - scroll_visible + scroll_visible

    -
    scroll_visible(
-    animate=True,
+
    scroll_visible(
+    animate=True,
     *,
-    speed=None,
-    duration=None,
-    top=False,
-    easing=None,
-    force=False,
-    on_complete=None,
-    level="basic"
+    speed=None,
+    duration=None,
+    top=False,
+    easing=None,
+    force=False,
+    on_complete=None,
+    level="basic"
 )
 
    
 
-    
    
-
+  
    
+  
       
    Scroll the container to make this widget visible.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    animate
+                bool
+          
    Animate scroll.
    		
+                True
+          
    speed
+                float | None
+          
    Speed of scroll if animate is True; or None to use duration.
    		
+                None
+          
    duration
+                float | None
+          
    Duration of animation, if animate is True and speed is None.
    		
+                None
+          
    top
+                bool
+          
    Scroll to top of container.
    		
+                False
+          
    easing
+                EasingFunction | str | None
+          
    An easing method for the scrolling animation.
    		
+                None
+          
    force
+                bool
+          
    Force scrolling even when prohibited by overflow styling.
    		
+                False
+          
    on_complete
+                CallbackType | None
+          
    A callable to invoke when the animation is finished.
    		
+                None
+          
    level
+                AnimationLevel
+          
    Minimum level required for the animation to take place (inclusive).
    		
+                'basic'
+          
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      animate
-
                    		
-                  bool
-            
-              
    
-                
    Animate scroll.
    
-              
    
-                		
-                  True
-            
    
-
                      speed
-
                    		
-                  float | None
-            
-              
    
-                
    Speed of scroll if animate is True; or None to use duration.
    
-              
    
-                		
-                  None
-            
    
-
                      duration
-
                    		
-                  float | None
-            
-              
    
-                
    Duration of animation, if animate is True and speed is None.
    
-              
    
-                		
-                  None
-            
    
-
                      top
-
                    		
-                  bool
-            
-              
    
-                
    Scroll to top of container.
    
-              
    
-                		
-                  False
-            
    
-
                      easing
-
                    		
-                  EasingFunction | str | None
-            
-              
    
-                
    An easing method for the scrolling animation.
    
-              
    
-                		
-                  None
-            
    
-
                      force
-
                    		
-                  bool
-            
-              
    
-                
    Force scrolling even when prohibited by overflow styling.
    
-              
    
-                		
-                  False
-            
    
-
                      on_complete
-
                    		
-                  CallbackType | None
-            
-              
    
-                
    A callable to invoke when the animation is finished.
    
-              
    
-                		
-                  None
-            
    
-
                      level
-
                    		
-                  AnimationLevel
-            
-              
    
-                
    Minimum level required for the animation to take place (inclusive).
    
-              
    
-                		
-                  'basic'
-            
    
-
-    
    
+
    +

    - set_loading + set_loading

    -
    set_loading(loading)
+
    set_loading(loading)
 
    
 
-    
    
-
+  
    
+  
       
    Set or reset the loading state of this widget.
    
 
    A widget in a loading state will display a LoadingIndicator that obscures the widget.
    
 
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    loading
+                bool
+          
    True to put the widget into a loading state, or False to reset the loading state.
    		
+              required
+          
    
+
+  
    Returns:
    
+  
+    
+      
+        
+        
+      
+    
+    
+        
+          
+          
+        
+    
+  
    TypeDescription
    
+                Awaitable
+          
    An optional awaitable.
    
 
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      loading
-
                    		
-                  bool
-            
-              
    
-                
    True to put the widget into a loading state, or False to reset the loading state.
    
-              
    
-                		
-                required
-            
    
-
-
-    
    Returns:
    
-    
-      
-        
-          
-          
-        
-      
-      
-          
-            
-            
-          
-      
-    
    TypeDescription
    
-                  Awaitable
-            
-              
    
-                
    An optional awaitable.
    
-              
    
-            
    
-
-    
    
+
    -

    - stop_animation +

    + stop_animation + async

    -
    stop_animation(attribute, complete=True)
+
    stop_animation(attribute, complete=True)
 
    
 
-    
    
-
+  
    
+  
       
    Stop an animation on an attribute.
    
 
-
-
    Parameters:
    
-    
-      
-        
-          
-          
-          
-          
-        
-      
-      
-          
-            
-            
-            
-            
-          
-          
-            
-            
-            
-            
-          
-      
-    
    NameTypeDescriptionDefault
    
-
                      attribute
-
                    		
-                  str
-            
-              
    
-                
    Name of the attribute whose animation should be stopped.
    
-              
    
-                		
-                required
-            
    
-
                      complete
-
                    		
-                  bool
-            
-              
    
-                
    Should the animation be set to its final value?
    
-              
    
-                		
-                  True
-            
    
-
+  
    Parameters:
    
+  
+    
+      
+        
+        
+        
+        
+      
+    
+    
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+    
+  
    NameTypeDescriptionDefault
    attribute
+                str
+          
    Name of the attribute whose animation should be stopped.
    		
+              required
+          
    complete
+                bool
+          
    Should the animation be set to its final value?
    		
+                True
+          
    
 
 
    
   Note
   
    If there is no animation scheduled or running, this is a no-op.
    
 
    
-    
    
+
    +

    - suppress_click + suppress_click

    -
    suppress_click()
+
    suppress_click()
 
    
 
-    
    
-
+  
    
+  
       
    Suppress a click event.
    
 
    This will prevent a Click event being sent,
 if called after a mouse down event and before the click itself.
    
 
-    
    
+
    +

    - watch_disabled + watch_disabled

    -
    watch_disabled(disabled)
+
    watch_disabled(disabled)
 
    
 
-    
    
-
+  
    
+  
       
    Update the styles of the widget and its children when disabled is toggled.
    
 
-    
    
+
    +

    - watch_has_focus + watch_has_focus

    -
    watch_has_focus(value)
+
    watch_has_focus(value)
 
    
 
-    
    
-
+  
    
+  
       
    Update from CSS if has focus state changes.
    
 
-    
    
+
    -

    - watch_mouse_over +

    + watch_mouse_hover -

    -
    watch_mouse_over(value)
-
    -
    +

    +
    watch_mouse_hover(value)
+
    +
    +

    Update from CSS if mouse over state changes.

    -
    + @@ -24479,7 +16298,7 @@

    - + @@ -24488,27 +16307,22 @@

    - WidgetError + WidgetError

    -
    -

    - Bases: Exception

    - - +
    +

    + Bases: Exception

    +

    Base widget error.

    - - - - -
    +
    @@ -24517,7 +16331,7 @@

    - + @@ -24616,7 +16430,7 @@

    Made with - Material for MkDocs Insiders + Material for MkDocs @@ -24659,10 +16473,10 @@

    - + - + diff --git a/api/work/index.html b/api/work/index.html index 782695c965..05865e9cb6 100644 --- a/api/work/index.html +++ b/api/work/index.html @@ -17,14 +17,11 @@ - - - - + @@ -32,10 +29,10 @@ - + - + @@ -64,6 +61,7 @@ + @@ -230,7 +228,7 @@
    -
    +
    Initializing search @@ -531,15 +529,9 @@ - - Home - - - - @@ -576,15 +568,9 @@ - - Introduction - - - - @@ -592,11 +578,7 @@
    - + - + diff --git a/api/worker/index.html b/api/worker/index.html index 5286282e33..4dc1d606a9 100644 --- a/api/worker/index.html +++ b/api/worker/index.html @@ -17,14 +17,11 @@ - - - - + @@ -32,10 +29,10 @@ - + - + @@ -64,6 +61,7 @@ + @@ -230,7 +228,7 @@
    -
    +
    Initializing search @@ -531,15 +529,9 @@ - - Home - - - - @@ -576,15 +568,9 @@ - - Introduction - - - - @@ -592,11 +578,7 @@