# textual-enhanced
## Introduction
This library is a mildly-opinionated set of enhancements and extras for the
Textual framework, mainly aimed at how I like my own Textual apps to look
and work. I've written this as a common set of tweaks I want for my own
Textual apps. It might be useful for yours too.
## Tweaks to Textual
### App-wide
- All vertical scrollbars are set to one character in width, by default (in
my applications I try really hard to avoid horizontal scrolling, so it's
nice to make scrollbars less obtrusive given I almost always only have
vertical bars).
### The `Header` widget
- The icon on the left is hidden.
- The ability to click to expand the header is disabled.
### The command palette
I've tweaked the command palette so that:
- It doesn't take up the full width of the screen.
- <kbd>super</kbd>+<kbd>x</kbd> is added as an alternative method of calling
it.
- <kbd>:</kbd> is added as an alternative method of calling it.
- The search icon is removed by default.
- The `background` is set to `$panel` by default.
### The loading indicator
The background is set to `transparent` by default.
## Additional Features
### With-some-batteries command palette/bindings
TODO: Explain.
## Widgets
### `EnhancedOptionList`
Adds `.preserved_highlight`, which can be used like:
```python
with stuff.preserved_highlight:
...rebuild the content of the list...
```
Adds a few more navigation keys.
Works around https://github.com/Textualize/textual/issues/5489.
Mild style tweaks.
### `TextViewer`
## Dialogs
### `HelpScreen`
TODO: Explain.
### `QuickInput`
TODO: Explain.
## Tools
### `add_key`
TODO: Explain.
[//]: # (README.md ends here)
Raw data
{
"_id": null,
"home_page": null,
"name": "textual-enhanced",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "framework, library, terminal, tui",
"author": null,
"author_email": "Dave Pearson <davep@davep.org>",
"download_url": "https://files.pythonhosted.org/packages/4b/9c/90bae41a6966572eff6fe32263238b654cf9bb49ccf24acdb72cabed2e8c/textual_enhanced-0.6.0.tar.gz",
"platform": null,
"description": "# textual-enhanced\n\n## Introduction\n\nThis library is a mildly-opinionated set of enhancements and extras for the\nTextual framework, mainly aimed at how I like my own Textual apps to look\nand work. I've written this as a common set of tweaks I want for my own\nTextual apps. It might be useful for yours too.\n\n## Tweaks to Textual\n\n### App-wide\n\n- All vertical scrollbars are set to one character in width, by default (in\n my applications I try really hard to avoid horizontal scrolling, so it's\n nice to make scrollbars less obtrusive given I almost always only have\n vertical bars).\n\n### The `Header` widget\n\n- The icon on the left is hidden.\n- The ability to click to expand the header is disabled.\n\n### The command palette\n\nI've tweaked the command palette so that:\n\n- It doesn't take up the full width of the screen.\n- <kbd>super</kbd>+<kbd>x</kbd> is added as an alternative method of calling\n it.\n- <kbd>:</kbd> is added as an alternative method of calling it.\n- The search icon is removed by default.\n- The `background` is set to `$panel` by default.\n\n### The loading indicator\n\nThe background is set to `transparent` by default.\n\n## Additional Features\n\n### With-some-batteries command palette/bindings\n\nTODO: Explain.\n\n## Widgets\n\n### `EnhancedOptionList`\n\nAdds `.preserved_highlight`, which can be used like:\n\n```python\nwith stuff.preserved_highlight:\n ...rebuild the content of the list...\n```\n\nAdds a few more navigation keys.\n\nWorks around https://github.com/Textualize/textual/issues/5489.\n\nMild style tweaks.\n\n### `TextViewer`\n\n## Dialogs\n\n### `HelpScreen`\n\nTODO: Explain.\n\n### `QuickInput`\n\nTODO: Explain.\n\n## Tools\n\n### `add_key`\n\nTODO: Explain.\n\n[//]: # (README.md ends here)\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: MIT License",
"summary": "A library of mildly-opinionated enhancements to Textual",
"version": "0.6.0",
"project_urls": {
"Discussions": "https://github.com/davep/textual-enhanced/discussions",
"Documentation": "https://github.com/davep/textual-enhanced/blob/main/README.md",
"Homepage": "https://github.com/davep/textual-enhanced",
"Issues": "https://github.com/davep/textual-enhanced/issues",
"Repository": "https://github.com/davep/textual-enhanced",
"Source": "https://github.com/davep/textual-enhanced"
},
"split_keywords": [
"framework",
" library",
" terminal",
" tui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "331b8cb44f4763f21083b093598fd00b46d50206cee30c692e97f846c8d888bc",
"md5": "a99714f99a7c391a817c3a740fb35c21",
"sha256": "ffed772ed428e9921deea906478b19501cdf260e8648b39cb4c9bde8a68b7845"
},
"downloads": -1,
"filename": "textual_enhanced-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a99714f99a7c391a817c3a740fb35c21",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 18512,
"upload_time": "2025-02-12T10:26:57",
"upload_time_iso_8601": "2025-02-12T10:26:57.920736Z",
"url": "https://files.pythonhosted.org/packages/33/1b/8cb44f4763f21083b093598fd00b46d50206cee30c692e97f846c8d888bc/textual_enhanced-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b9c90bae41a6966572eff6fe32263238b654cf9bb49ccf24acdb72cabed2e8c",
"md5": "b5fdf524cb418197ddcbf3471ff46783",
"sha256": "fd32449927af9335147bfa0e85b064e4c764023b9f7bda0fd7d37df9a5da7c39"
},
"downloads": -1,
"filename": "textual_enhanced-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "b5fdf524cb418197ddcbf3471ff46783",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15335,
"upload_time": "2025-02-12T10:27:01",
"upload_time_iso_8601": "2025-02-12T10:27:01.288089Z",
"url": "https://files.pythonhosted.org/packages/4b/9c/90bae41a6966572eff6fe32263238b654cf9bb49ccf24acdb72cabed2e8c/textual_enhanced-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-12 10:27:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davep",
"github_project": "textual-enhanced",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "textual-enhanced"
}
JSON
