mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
@@ -47,3 +47,7 @@ textual --help
|
|||||||
```
|
```
|
||||||
|
|
||||||
See [devtools](guide/devtools.md) for more about the `textual` command.
|
See [devtools](guide/devtools.md) for more about the `textual` command.
|
||||||
|
|
||||||
|
## Need help?
|
||||||
|
|
||||||
|
See the [help](./help.md) page for how to get help with Textual, or to report bugs.
|
||||||
|
|||||||
20
docs/help.md
Normal file
20
docs/help.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
hide:
|
||||||
|
- navigation
|
||||||
|
---
|
||||||
|
|
||||||
|
# Help
|
||||||
|
|
||||||
|
Here's where to go if you need help with Textual.
|
||||||
|
|
||||||
|
## Bugs and feature requests
|
||||||
|
|
||||||
|
Report bugs via GitHub on the Textual [issues](https://github.com/Textualize/textual/issues) page. You can also post feature requests via GitHub issues, but see the [roadmap](./roadmap.md) first.
|
||||||
|
|
||||||
|
## Forum
|
||||||
|
|
||||||
|
Visit the [Textual forum](https://community.textualize.io/) for Textual (and Rich) discussions.
|
||||||
|
|
||||||
|
## Discord Server
|
||||||
|
|
||||||
|
For more realtime feedback or chat, join our discord server to connect with the [Textual community](https://discord.gg/Enf6Z3qhVr).
|
||||||
64
docs/roadmap.md
Normal file
64
docs/roadmap.md
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
# Roadmap
|
||||||
|
|
||||||
|
We ([textualize.io](https://www.textualize.io/)) are actively building and maintaining Textual.
|
||||||
|
|
||||||
|
We have many new features in the pipeline. This page will keep track of that work.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
High-level features we plan on implementing.
|
||||||
|
|
||||||
|
- [ ] Command interface
|
||||||
|
* [ ] Command menu
|
||||||
|
* [ ] Fuzzy search
|
||||||
|
- [ ] Configuration (.toml based extensible configuration format)
|
||||||
|
- [x] Devtools
|
||||||
|
* [ ] Browser-inspired devtools interface with integrated DOM view, log, and REPL
|
||||||
|
- [ ] Reactive state
|
||||||
|
- [x] Themes
|
||||||
|
* [ ] Customize via config
|
||||||
|
* [ ] Builtin theme editor
|
||||||
|
|
||||||
|
## Widgets
|
||||||
|
|
||||||
|
Widgets are key to making user friendly interfaces. The builtin widgets should cover many common (and some uncommon) use-cases. The following is a list of the widgets we have built or are planning to build.
|
||||||
|
|
||||||
|
- [x] Buttons
|
||||||
|
* [x] Error / warning variants
|
||||||
|
- [ ] Color picker
|
||||||
|
- [x] Checkbox
|
||||||
|
- [ ] Content switcher
|
||||||
|
- [x] DataTable
|
||||||
|
* [x] Cell select
|
||||||
|
* [ ] Row / Column select
|
||||||
|
* [ ] API to update cells / rows
|
||||||
|
* [ ] Lazy loading API
|
||||||
|
- [ ] Date picker
|
||||||
|
- [ ] Drop-down menus
|
||||||
|
- [ ] Form Widget
|
||||||
|
* [ ] Serialization / Deserialization
|
||||||
|
* [ ] Export to `attrs` objects
|
||||||
|
* [ ] Export to `PyDantic` objects
|
||||||
|
- [ ] Image support
|
||||||
|
- [ ] Half block
|
||||||
|
- [ ] Braile
|
||||||
|
- [ ] Sixels, and other image extensions
|
||||||
|
- [x] Input
|
||||||
|
* [ ] Validation
|
||||||
|
* [ ] Error / warning states
|
||||||
|
* [ ] Template types: IP address, physical units (weight, volume), currency, credit card etc
|
||||||
|
- [ ] Markdown viewer (more dynamic than Rich markdown, with scrollable code areas / collapseable sections)
|
||||||
|
- [ ] Plots
|
||||||
|
- [ ] bar chart
|
||||||
|
- [ ] line chart
|
||||||
|
- [ ] Candlestick chars
|
||||||
|
- [ ] Progress bars
|
||||||
|
* [ ] Style variants (solid, thin etc)
|
||||||
|
- [ ] Radio boxes
|
||||||
|
- [ ] Sparklines
|
||||||
|
- [ ] Tabs
|
||||||
|
- [ ] TextArea (multi-line input)
|
||||||
|
* [ ] Basic controls
|
||||||
|
* [ ] Syntax highlighting
|
||||||
|
* [ ] Indentation guides
|
||||||
|
* [ ] Smart features for various languages
|
||||||
@@ -6,7 +6,7 @@ edit_uri: edit/css/docs/
|
|||||||
nav:
|
nav:
|
||||||
- Introduction:
|
- Introduction:
|
||||||
- "index.md"
|
- "index.md"
|
||||||
- "getting_started.md"
|
- "getting_started.md"
|
||||||
- "tutorial.md"
|
- "tutorial.md"
|
||||||
- Guide:
|
- Guide:
|
||||||
- "guide/index.md"
|
- "guide/index.md"
|
||||||
@@ -23,6 +23,7 @@ nav:
|
|||||||
- "guide/widgets.md"
|
- "guide/widgets.md"
|
||||||
- "guide/animation.md"
|
- "guide/animation.md"
|
||||||
- "guide/screens.md"
|
- "guide/screens.md"
|
||||||
|
- "roadmap.md"
|
||||||
- How to:
|
- How to:
|
||||||
- "how-to/index.md"
|
- "how-to/index.md"
|
||||||
- "how-to/animation.md"
|
- "how-to/animation.md"
|
||||||
@@ -116,6 +117,8 @@ nav:
|
|||||||
- "reference/static.md"
|
- "reference/static.md"
|
||||||
- "reference/timer.md"
|
- "reference/timer.md"
|
||||||
- "reference/widget.md"
|
- "reference/widget.md"
|
||||||
|
- "help.md"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
|
|||||||
Reference in New Issue
Block a user