diff --git a/.faq/FAQ.md b/.faq/FAQ.md index 1b12e822d..0dd6a22d3 100644 --- a/.faq/FAQ.md +++ b/.faq/FAQ.md @@ -8,6 +8,11 @@ hide: # 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 %} @@ -15,8 +20,8 @@ hide: {{ question.body }} +--- + {%- endfor %} -
- Generated by [FAQtory](https://github.com/willmcgugan/faqtory) diff --git a/docs/FAQ.md b/docs/FAQ.md index ca60a8872..55a70c7a1 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -8,6 +8,11 @@ hide: # 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. + ## 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. +--- + ## 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 ``` +--- + ## 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. +--- + ## 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). +--- + ## How do I center a widget in a screen? @@ -139,6 +152,8 @@ if __name__ == "__main__": ButtonApp().run() ``` +--- + ## 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. +--- + ## How do I pass arguments to an app? @@ -196,6 +213,8 @@ Greetings(to_greet="davep").run() Greetings("Well hello", "there").run() ``` +--- + ## No widget called TextLog @@ -209,6 +228,8 @@ Here's how you should import RichLog: from textual.widgets import RichLog ``` +--- + ## 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) work in different environments you can try them out with `textual keys`. +--- + ## Why doesn't Textual look good on macOS? @@ -275,6 +298,8 @@ We recommend any of the following terminals: Screenshot 2023-06-19 at 11 00 25 +--- + ## 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. +--- + ## 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. -
+--- Generated by [FAQtory](https://github.com/willmcgugan/faqtory)