Visual effects for Textual, a TermincalTextEffects wrapper.
Project description
textualeffects
Visual effects for Textual, a TerminalTextEffects wrapper.
Intro
textualeffects
is a library that provides Textual bindings for the excellent TerminalTextEffects visual effects library.
Widgets
There are two widgets available in textualeffects
, EffectLabel
and SplashScreen
.
An EffectLabel
widget that can be used to display text with a visual effect.
from textual.app import App, ComposeResult
from textualeffects.effects import EffectType
from textualeffects.widgets import EffectLabel
text=("Hello World! " * 5 + "\n") * 10,
effect: EffectType = "Spotlights"
config = {
"search_duration": 500,
"spotlight_count": 3,
}
class TextualEffect(App):
def compose(self) -> ComposeResult:
label = EffectLabel(text, effect=effect, config=config)
label.styles.border = ("heavy", "green")
yield label
if __name__ == "__main__":
app = TextualEffect()
app.run()
A SplashScreen
widget that can be used to display a splash screen based on ModalScreen
with a visual effect. Once the effect is complete, the splash screen will be dismissed. The user can also dismiss the splash screen by pressing the ESC key.
from textual.app import App, ComposeResult
from textual.widgets import TextArea
from textualeffects.effects import EffectType
from textualeffects.widgets import SplashScreen
effect: EffectType = "Spotlights"
config = {
"search_duration": 100,
"spotlight_count": 3,
}
class SplashEffect(App):
def on_mount(self) -> None:
text = ("Hello World! " * 5 + "\n") * 10
self.push_screen(SplashScreen(text, effect=effect, config=config))
def compose(self) -> ComposeResult:
yield TextArea(("Main content" * 5 + "\n") * 10)
if __name__ == "__main__":
app = SplashEffect()
app.run()
Both widgets accept the following arguments:
text
: The text to display.effect
: The visual effect to apply to the text. Available effects are exposed through theEffectType
type.config
: A dictionary of configuration options for the effect. The available options depend on the effect. Detailed information on the available options can be found in the TerminalTextEffects documentation.
For convenience, when an effect has run its course, the EffectLabel
and SplashScreen
widgets will emit a EffectLabel.EffectFinished
event.
You can listen for this event to perform any actions:
@on(EffectLabel.EffectFinished)
def do_stuff(self, message: EffectLabel.EffectFinished) -> None:
...
License
This project is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for textualeffects-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cdc1d43b519316b1022fdc81b1b0d1f5c664dc5a1f6b437fc8625084c2a442b |
|
MD5 | ef94f831b68d01c0b7247c8e3b51fe58 |
|
BLAKE2b-256 | 52c58464b423f7b5d6f54eac69dfe6241d28325b59c552d26c4f0d333f1a50ab |