Deployed 27ab81e with MkDocs version: 1.5.2

Textualize · Sep 19, 2023 · 7fd8fae · 7fd8fae
1 parent cfd9276
commit 7fd8fae
Show file tree

Hide file tree

Showing 53 changed files with 945 additions and 859 deletions.
diff --git a/api/app/index.html b/api/app/index.html
@@ -9650,8 +9650,8 @@ <h3 id="textual.app.App.SUB_TITLE" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.app.App.SUB_TITLE" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9676,8 +9676,8 @@ <h3 id="textual.app.App.TITLE" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.app.App.TITLE" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9769,8 +9769,8 @@ <h3 id="textual.app.App.dark" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.app.App.dark" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -10223,8 +10223,8 @@ <h3 id="textual.app.App.sub_title" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.app.App.sub_title" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -10255,8 +10255,8 @@ <h3 id="textual.app.App.title" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.app.App.title" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -13564,6 +13564,10 @@ <h3 id="textual.app.App.run_test" class="doc doc-heading">
   <div class="doc doc-contents ">
 
       <p>An asynchronous context manager for testing apps.</p>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>See the guide for <a href="/guide/testing">testing</a> Textual apps.</p>
+</div>
 <p>Use this to run your app in "headless" mode (no output) and drive the app via a <a class="autorefs autorefs-internal" href="../pilot/#textual.pilot.Pilot">Pilot</a> object.</p>
 
 <details class="example" open>

diff --git a/api/binding/index.html b/api/binding/index.html
@@ -7255,8 +7255,8 @@ <h3 id="textual.binding.Binding.description" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.binding.Binding.description" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -7302,8 +7302,8 @@ <h3 id="textual.binding.Binding.key_display" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.binding.Binding.key_display" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -7326,8 +7326,8 @@ <h3 id="textual.binding.Binding.priority" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.binding.Binding.priority" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -7350,8 +7350,8 @@ <h3 id="textual.binding.Binding.show" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.binding.Binding.show" class="headerlink" title="Permanent link">&para;</a></h3>

diff --git a/api/color/index.html b/api/color/index.html
@@ -8906,8 +8906,8 @@ <h3 id="textual.color.Color.a" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.color.Color.a" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9890,8 +9890,8 @@ <h3 id="textual.color.Color.parse" class="doc doc-heading">
         <span class="doc doc-object-name doc-function-name">parse</span>
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-cached"><code>cached</code></small>
       <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
+      <small class="doc doc-label doc-label-cached"><code>cached</code></small>
   </span>
 
 <a href="#textual.color.Color.parse" class="headerlink" title="Permanent link">&para;</a></h3>

diff --git a/api/command/index.html b/api/command/index.html
@@ -8436,8 +8436,8 @@ <h3 id="textual.command.Hit.help" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.command.Hit.help" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -8507,8 +8507,8 @@ <h3 id="textual.command.Hit.text" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.command.Hit.text" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9248,8 +9248,8 @@ <h3 id="textual.command.SearchIcon.icon" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.command.SearchIcon.icon" class="headerlink" title="Permanent link">&para;</a></h3>

diff --git a/api/content_switcher/index.html b/api/content_switcher/index.html
@@ -7053,8 +7053,8 @@ <h3 id="textual.widgets._content_switcher.ContentSwitcher.current" class="doc do
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.widgets._content_switcher.ContentSwitcher.current" class="headerlink" title="Permanent link">&para;</a></h3>

diff --git a/api/dom_node/index.html b/api/dom_node/index.html
@@ -8218,8 +8218,8 @@ <h3 id="textual.dom.DOMNode.auto_refresh" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-writable"><code>writable</code></small>
       <small class="doc doc-label doc-label-property"><code>property</code></small>
+      <small class="doc doc-label doc-label-writable"><code>writable</code></small>
   </span>
 
 <a href="#textual.dom.DOMNode.auto_refresh" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -8324,8 +8324,8 @@ <h3 id="textual.dom.DOMNode.classes" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.dom.DOMNode.classes" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -8541,8 +8541,8 @@ <h3 id="textual.dom.DOMNode.display" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-writable"><code>writable</code></small>
       <small class="doc doc-label doc-label-property"><code>property</code></small>
+      <small class="doc doc-label doc-label-writable"><code>writable</code></small>
   </span>
 
 <a href="#textual.dom.DOMNode.display" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -8612,8 +8612,8 @@ <h3 id="textual.dom.DOMNode.id" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-writable"><code>writable</code></small>
       <small class="doc doc-label doc-label-property"><code>property</code></small>
+      <small class="doc doc-label doc-label-writable"><code>writable</code></small>
   </span>
 
 <a href="#textual.dom.DOMNode.id" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -8919,8 +8919,8 @@ <h3 id="textual.dom.DOMNode.visible" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-writable"><code>writable</code></small>
       <small class="doc doc-label doc-label-property"><code>property</code></small>
+      <small class="doc doc-label doc-label-writable"><code>writable</code></small>
   </span>
 
 <a href="#textual.dom.DOMNode.visible" class="headerlink" title="Permanent link">&para;</a></h3>

diff --git a/api/errors/index.html b/api/errors/index.html
@@ -7030,6 +7030,8 @@ <h1>Errors</h1>
 
 <a id="textual.errors"></a>
   <div class="doc doc-contents first">
+
+      <p>General exception classes.</p>
 
 
 

diff --git a/api/events/index.html b/api/events/index.html
@@ -9187,8 +9187,8 @@ <h3 id="textual.events.MouseEvent.style" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-writable"><code>writable</code></small>
       <small class="doc doc-label doc-label-property"><code>property</code></small>
+      <small class="doc doc-label doc-label-writable"><code>writable</code></small>
   </span>
 
 <a href="#textual.events.MouseEvent.style" class="headerlink" title="Permanent link">&para;</a></h3>

diff --git a/api/filter/index.html b/api/filter/index.html
@@ -7276,6 +7276,15 @@ <h1>Filter</h1>
 
 <a id="textual.filter"></a>
   <div class="doc doc-contents first">
+
+      <p>Filter classes.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Filters are used internally, and not recommended for use by Textual app developers.</p>
+</div>
+<p>Filters are used internally to process terminal output after it has been rendered.
+Currently this is used internally to convert the application to monochrome, when the NO_COLOR env var is set.</p>
+<p>In the future, this system will be used to implement accessibility features.</p>
 
 
 

diff --git a/api/fuzzy_matcher/index.html b/api/fuzzy_matcher/index.html
@@ -7108,6 +7108,9 @@ <h1>Fuzzy matcher</h1>
 
 <a id="textual.fuzzy"></a>
   <div class="doc doc-contents first">
+
+      <p>Fuzzy matcher.</p>
+<p>This class is used by the <a href="guide/command">command palette</a> to match search terms.</p>
 
 
 

diff --git a/api/geometry/index.html b/api/geometry/index.html
@@ -8946,8 +8946,8 @@ <h3 id="textual.geometry.Offset.x" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Offset.x" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -8970,8 +8970,8 @@ <h3 id="textual.geometry.Offset.y" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Offset.y" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9449,8 +9449,8 @@ <h3 id="textual.geometry.Region.height" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Region.height" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9689,8 +9689,8 @@ <h3 id="textual.geometry.Region.width" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Region.width" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9713,8 +9713,8 @@ <h3 id="textual.geometry.Region.x" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Region.x" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -9737,8 +9737,8 @@ <h3 id="textual.geometry.Region.y" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Region.y" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -11528,8 +11528,8 @@ <h3 id="textual.geometry.Size.height" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Size.height" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -11598,8 +11598,8 @@ <h3 id="textual.geometry.Size.width" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Size.width" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -11832,8 +11832,8 @@ <h3 id="textual.geometry.Spacing.bottom" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Spacing.bottom" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -11926,8 +11926,8 @@ <h3 id="textual.geometry.Spacing.left" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Spacing.left" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -11950,8 +11950,8 @@ <h3 id="textual.geometry.Spacing.right" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Spacing.right" class="headerlink" title="Permanent link">&para;</a></h3>
@@ -11974,8 +11974,8 @@ <h3 id="textual.geometry.Spacing.top" class="doc doc-heading">
 
 
   <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
       <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
   </span>
 
 <a href="#textual.geometry.Spacing.top" class="headerlink" title="Permanent link">&para;</a></h3>