faq tweak

This commit is contained in:
Will McGugan
2023-08-26 10:57:44 +01:00
parent d89871b045
commit 59646ff21a
2 changed files with 35 additions and 3 deletions

View File

@@ -8,6 +8,11 @@ hide:
# Frequently Asked Questions # Frequently Asked Questions
Welcome to the Textual FAQ.
Here we try and answer any question that comes up frequently.
If you can't find what you are looking for here, see our other [help](./help.md) channels.
{%- for question in questions %} {%- for question in questions %}
<a name="{{ question.slug }}"></a> <a name="{{ question.slug }}"></a>
@@ -15,8 +20,8 @@ hide:
{{ question.body }} {{ question.body }}
---
{%- endfor %} {%- endfor %}
<hr>
Generated by [FAQtory](https://github.com/willmcgugan/faqtory) Generated by [FAQtory](https://github.com/willmcgugan/faqtory)

View File

@@ -8,6 +8,11 @@ hide:
# Frequently Asked Questions # Frequently Asked Questions
Welcome to the Textual FAQ.
Here we try and answer any question that comes up frequently.
If you can't find what you are looking for here, see our other [help](./help.md) channels.
<a name="does-textual-support-images"></a> <a name="does-textual-support-images"></a>
## Does Textual support images? ## Does Textual support images?
@@ -15,6 +20,8 @@ Textual doesn't have built-in support for images yet, but it is on the [Roadmap]
See also the [rich-pixels](https://github.com/darrenburns/rich-pixels) project for a Rich renderable for images that works with Textual. See also the [rich-pixels](https://github.com/darrenburns/rich-pixels) project for a Rich renderable for images that works with Textual.
---
<a name="how-can-i-fix-importerror-cannot-import-name-composeresult-from-textualapp-"></a> <a name="how-can-i-fix-importerror-cannot-import-name-composeresult-from-textualapp-"></a>
## How can I fix ImportError cannot import name ComposeResult from textual.app ? ## How can I fix ImportError cannot import name ComposeResult from textual.app ?
@@ -26,6 +33,8 @@ The following should do it:
pip install textual-dev -U pip install textual-dev -U
``` ```
---
<a name="how-can-i-select-and-copy-text-in-a-textual-app"></a> <a name="how-can-i-select-and-copy-text-in-a-textual-app"></a>
## How can I select and copy text in a Textual app? ## How can I select and copy text in a Textual app?
@@ -39,6 +48,8 @@ may expect from the command line. The exact modifier key depends on the terminal
Refer to the documentation for your terminal emulator, if it is not listed above. Refer to the documentation for your terminal emulator, if it is not listed above.
---
<a name="how-can-i-set-a-translucent-app-background"></a> <a name="how-can-i-set-a-translucent-app-background"></a>
## How can I set a translucent app background? ## How can I set a translucent app background?
@@ -49,6 +60,8 @@ Textual uses 16.7 million colors where available which enables consistent colors
For more information on ANSI colors in Textual, see [Why no Ansi Themes?](#why-doesnt-textual-support-ansi-themes). For more information on ANSI colors in Textual, see [Why no Ansi Themes?](#why-doesnt-textual-support-ansi-themes).
---
<a name="how-do-i-center-a-widget-in-a-screen"></a> <a name="how-do-i-center-a-widget-in-a-screen"></a>
## How do I center a widget in a screen? ## How do I center a widget in a screen?
@@ -139,6 +152,8 @@ if __name__ == "__main__":
ButtonApp().run() ButtonApp().run()
``` ```
---
<a name="how-do-i-fix-workerdeclarationerror"></a> <a name="how-do-i-fix-workerdeclarationerror"></a>
## How do I fix WorkerDeclarationError? ## How do I fix WorkerDeclarationError?
@@ -162,6 +177,8 @@ async def run_in_background():
This change was made because it was too easy to accidentally create a threaded worker, which may produce unexpected results. This change was made because it was too easy to accidentally create a threaded worker, which may produce unexpected results.
---
<a name="how-do-i-pass-arguments-to-an-app"></a> <a name="how-do-i-pass-arguments-to-an-app"></a>
## How do I pass arguments to an app? ## How do I pass arguments to an app?
@@ -196,6 +213,8 @@ Greetings(to_greet="davep").run()
Greetings("Well hello", "there").run() Greetings("Well hello", "there").run()
``` ```
---
<a name="no-widget-called-textlog"></a> <a name="no-widget-called-textlog"></a>
## No widget called TextLog ## No widget called TextLog
@@ -209,6 +228,8 @@ Here's how you should import RichLog:
from textual.widgets import RichLog from textual.widgets import RichLog
``` ```
---
<a name="why-do-some-key-combinations-never-make-it-to-my-app"></a> <a name="why-do-some-key-combinations-never-make-it-to-my-app"></a>
## Why do some key combinations never make it to my app? ## Why do some key combinations never make it to my app?
@@ -239,6 +260,8 @@ If you need to test what [key
combinations](https://textual.textualize.io/guide/input/#keyboard-input) combinations](https://textual.textualize.io/guide/input/#keyboard-input)
work in different environments you can try them out with `textual keys`. work in different environments you can try them out with `textual keys`.
---
<a name="why-doesn't-textual-look-good-on-macos"></a> <a name="why-doesn't-textual-look-good-on-macos"></a>
## Why doesn't Textual look good on macOS? ## Why doesn't Textual look good on macOS?
@@ -275,6 +298,8 @@ We recommend any of the following terminals:
<img width="1002" alt="Screenshot 2023-06-19 at 11 00 25" src="https://github.com/Textualize/textual/assets/554369/9a8cde57-5121-49a7-a2e0-5f6fc871b7a6"> <img width="1002" alt="Screenshot 2023-06-19 at 11 00 25" src="https://github.com/Textualize/textual/assets/554369/9a8cde57-5121-49a7-a2e0-5f6fc871b7a6">
---
<a name="why-doesn't-textual-support-ansi-themes"></a> <a name="why-doesn't-textual-support-ansi-themes"></a>
## Why doesn't Textual support ANSI themes? ## Why doesn't Textual support ANSI themes?
@@ -289,6 +314,8 @@ Textual has a design system which guarantees apps will be readable on all platfo
There is currently a light and dark version of the design system, but more are planned. It will also be possible for users to customize the source colors on a per-app or per-system basis. This means that in the future you will be able to modify the core colors to blend in with your chosen terminal theme. There is currently a light and dark version of the design system, but more are planned. It will also be possible for users to customize the source colors on a per-app or per-system basis. This means that in the future you will be able to modify the core colors to blend in with your chosen terminal theme.
---
<a name="why-doesn't-the-`datatable`-scroll-programmatically"></a> <a name="why-doesn't-the-`datatable`-scroll-programmatically"></a>
## Why doesn't the `DataTable` scroll programmatically? ## Why doesn't the `DataTable` scroll programmatically?
@@ -298,6 +325,6 @@ If you would like the table itself to scroll, set the height to something other
**NOTE:** As of Textual v0.31.0 the `max-height` of a `DataTable` is set to `100%`, this will mean that the above is no longer the default experience. **NOTE:** As of Textual v0.31.0 the `max-height` of a `DataTable` is set to `100%`, this will mean that the above is no longer the default experience.
<hr> ---
Generated by [FAQtory](https://github.com/willmcgugan/faqtory) Generated by [FAQtory](https://github.com/willmcgugan/faqtory)