Slide
Quick Start
from terminaltexteffects.effects.effect_slide import Slide
effect = Slide("YourTextHere")
with effect.terminal_output() as terminal:
for frame in effect:
terminal.print(frame)
Slide characters into view from outside the terminal.
Classes:
Name | Description |
---|---|
Slide |
Slide characters into view from outside the terminal. |
SlideConfig |
Configuration for the Slide effect. |
SlideIterator |
Effect iterator for the Slide effect. Does not normally need to be called directly. |
Slide
Bases: BaseEffect[SlideConfig]
Slides characters into view from outside the terminal.
Attributes:
Name | Type | Description |
---|---|---|
effect_config |
SlideConfig
|
Configuration for the effect. |
terminal_config |
TerminalConfig
|
Configuration for the terminal. |
Source code in terminaltexteffects/effects/effect_slide.py
SlideConfig
dataclass
Bases: ArgsDataClass
Configuration for the Slide effect.
Attributes:
Name | Type | Description |
---|---|---|
movement_speed |
float
|
Speed of the characters. Valid values are n > 0. |
grouping |
Literal['row', 'column', 'diagonal']
|
Direction to group characters. Valid values are 'row', 'column', 'diagonal'. |
gap |
int
|
Number of frames to wait before adding the next group of characters. Increasing this value creates a more staggered effect. Valid values are n >= 0. |
reverse_direction |
bool
|
Reverse the direction of the characters. |
merge |
bool
|
Merge the character groups originating. |
movement_easing |
EasingFunction
|
Easing function to use for character movement. |
final_gradient_stops |
tuple[Color, ...]
|
Tuple of colors for the character gradient. If only one color is provided, the characters will be displayed in that color. |
final_gradient_steps |
tuple[int, ...] | int
|
Tuple of the number of gradient steps to use. More steps will create a smoother and longer gradient animation. Valid values are n > 0. |
final_gradient_frames |
int
|
Number of frames to display each gradient step. Increase to slow down the gradient animation. |
final_gradient_direction |
Direction
|
Direction of the gradient. |
Source code in terminaltexteffects/effects/effect_slide.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
|
final_gradient_direction = ArgField(cmd_name='--final-gradient-direction', default=Gradient.Direction.VERTICAL, type_parser=argvalidators.GradientDirection.type_parser, help='Direction of the gradient (vertical, horizontal, diagonal, center).')
class-attribute
instance-attribute
Gradient.Direction : Direction of the gradient.
final_gradient_frames = ArgField(cmd_name='--final-gradient-frames', type_parser=argvalidators.PositiveInt.type_parser, default=10, metavar=argvalidators.PositiveInt.METAVAR, help='Number of frames to display each gradient step. Increase to slow down the gradient animation.')
class-attribute
instance-attribute
int : Number of frames to display each gradient step. Increase to slow down the gradient animation.
final_gradient_steps = ArgField(cmd_name='--final-gradient-steps', type_parser=argvalidators.PositiveInt.type_parser, default=12, metavar=argvalidators.PositiveInt.METAVAR, help='Number of gradient steps to use. More steps will create a smoother and longer gradient animation.')
class-attribute
instance-attribute
tuple[int, ...] | int : Int or Tuple of ints for the number of gradient steps to use. More steps will create a smoother and longer gradient animation.
final_gradient_stops = ArgField(cmd_name=['--final-gradient-stops'], type_parser=argvalidators.ColorArg.type_parser, nargs='+', default=(Color('#833ab4'), Color('#fd1d1d'), Color('#fcb045')), metavar=argvalidators.ColorArg.METAVAR, help='Space separated, unquoted, list of colors for the character gradient. If only one color is provided, the characters will be displayed in that color.')
class-attribute
instance-attribute
tuple[Color, ...] : Tuple of colors for the character gradient. If only one color is provided, the characters will be displayed in that color.
gap = ArgField(cmd_name='--gap', type_parser=argvalidators.NonNegativeInt.type_parser, default=3, metavar=argvalidators.NonNegativeInt.METAVAR, help='Number of frames to wait before adding the next group of characters. Increasing this value creates a more staggered effect.')
class-attribute
instance-attribute
int : Number of frames to wait before adding the next group of characters. Increasing this value creates a more staggered effect.
grouping = ArgField(cmd_name='--grouping', default='row', choices=['row', 'column', 'diagonal'], help='Direction to group characters.')
class-attribute
instance-attribute
typing.Literal['row', 'column', 'diagonal'] : Direction to group characters. Valid values are Literal['row', 'column', 'diagonal'].
merge = ArgField(cmd_name='--merge', action='store_true', help='Merge the character groups originating from either side of the terminal. (--reverse-direction is ignored when merging)')
class-attribute
instance-attribute
bool : Merge the character groups originating from either side of the terminal.
movement_easing = ArgField(cmd_name=['--movement-easing'], default=easing.in_out_quad, type_parser=argvalidators.Ease.type_parser, metavar=argvalidators.Ease.METAVAR, help='Easing function to use for character movement.')
class-attribute
instance-attribute
easing.EasingFunction : Easing function to use for character movement.
movement_speed = ArgField(cmd_name='--movement-speed', type_parser=argvalidators.PositiveFloat.type_parser, default=0.5, metavar=argvalidators.PositiveFloat.METAVAR, help='Speed of the characters.')
class-attribute
instance-attribute
float : Speed of the characters.
reverse_direction = ArgField(cmd_name='--reverse-direction', action='store_true', help='Reverse the direction of the characters.')
class-attribute
instance-attribute
bool : Reverse the direction of the characters.
SlideIterator
Bases: BaseEffectIterator[SlideConfig]
Effect iterator for the Slide effect.
Source code in terminaltexteffects/effects/effect_slide.py
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
|
__init__(effect)
Initialize the Slide effect iterator.
Source code in terminaltexteffects/effects/effect_slide.py
__next__()
Return the next frame in the animation.
Source code in terminaltexteffects/effects/effect_slide.py
build()
Build the effect.
Source code in terminaltexteffects/effects/effect_slide.py
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
|