Skip to content

Wipe

Demo

Quick Start

wipe.py
from terminaltexteffects.effects.effect_wipe import Wipe

effect = Wipe("YourTextHere")
with effect.terminal_output() as terminal:
    for frame in effect:
        terminal.print(frame)

Wipe Directions and Sorts

New in 0.16.0

CharacterOrder directions and --reverse-wipe-direction are available on development main and are not in the published 0.15.0 package.

--wipe-direction accepts every CharacterOrder. Group directions reveal whole rows, columns, diagonals, or radial bands. Sort directions reveal individual characters in the exact order returned by Terminal.get_characters(), using their input coordinates.

See Spiral Sorting for the six spiral orders, their starting corners, and how multiple arms interleave.

Both grouped and sorted modes use the same 100-step easing schedule, so multiple characters may appear in one frame. wipe_delay adds frames before the first easing step and between later steps. Easing functions that reverse temporarily hide characters and restart their wipe scenes when those characters reappear. The default remains diagonal_top_left_to_bottom_right.

tte wipe --wipe-direction spiral_clockwise
tte wipe --wipe-direction spiral_counter_clockwise_double --wipe-delay 2

Use --reverse-wipe-direction to reverse the complete traversal while preserving group membership. The flag defaults to off. Reversed spirals travel outward along the selected path; changing clockwise to counterclockwise instead selects a different inward path.

tte wipe --wipe-direction spiral_clockwise --reverse-wipe-direction

Configurations normalize to CharacterOrder. Existing CharacterGroup and CharacterSort values and their CLI spellings remain accepted as compatibility inputs.

For library use, assign a native enum or its CLI spelling:

from terminaltexteffects.effects.effect_wipe import Wipe
from terminaltexteffects import CharacterOrder

effect = Wipe("YourTextHere")
effect.effect_config.wipe_direction = CharacterOrder.SPIRAL_CLOCKWISE_QUAD

Performs a wipe across the terminal to reveal characters.

Classes:

Name Description
Wipe

Performs a wipe across the terminal to reveal characters.
WipeConfig

Configuration for the Wipe effect.
WipeIterator

Effect iterator for the Wipe effect. Does not normally need to be called directly.

Wipe

Bases: BaseEffect[WipeConfig]

Performs a wipe across the terminal to reveal characters.

Attributes:

Name Type Description
effect_config WipeConfig

Configuration for the effect.
terminal_config TerminalConfig

Configuration for the terminal.
Source code in terminaltexteffects/effects/effect_wipe.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
class Wipe(BaseEffect[WipeConfig]):
    """Performs a wipe across the terminal to reveal characters.

    Attributes:
        effect_config (WipeConfig): Configuration for the effect.
        terminal_config (TerminalConfig): Configuration for the terminal.

    """

    @property
    def _config_cls(self) -> type[WipeConfig]:
        return WipeConfig

    @property
    def _iterator_cls(self) -> type[WipeIterator]:
        return WipeIterator

WipeConfig dataclass

Bases: BaseConfig

Configuration for the Wipe effect.

Attributes:

Name Type Description
reverse_wipe_direction bool

Reverse the complete traversal while preserving group membership.
wipe_direction `CharacterOrder`

Grouping or character order for the wipe. Sort values reveal characters in the exact sorted order, including spiral patterns.
wipe_delay int

Number of frames to wait between wipe easing steps. Increase to slow down the effect. Valid values are n >= 0.
final_gradient_stops tuple[Color, ...]

Tuple of colors for the wipe gradient.
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 final gradient.
Source code in terminaltexteffects/effects/effect_wipe.py 
 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
@dataclass
class WipeConfig(BaseConfig):
    """Configuration for the Wipe effect.

    Attributes:
        reverse_wipe_direction (bool): Reverse the complete traversal while preserving group membership.
        wipe_direction (`CharacterOrder`): Grouping or character order for the wipe.
            Sort values reveal characters in the exact sorted order, including spiral patterns.
        wipe_delay (int): Number of frames to wait between wipe easing steps. Increase to slow down the effect.
            Valid values are n >= 0.
        final_gradient_stops (tuple[Color, ...]): Tuple of colors for the wipe gradient.
        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 (Gradient.Direction): Direction of the final gradient.

    """

    parser_spec: argutils.ParserSpec = argutils.ParserSpec(
        name="wipe",
        help="Wipes the text across the terminal to reveal characters.",
        description="wipe | Wipes the text across the terminal to reveal characters.",
        epilog=(
            f"{argutils.EASING_EPILOG} Example: terminaltexteffects wipe --wipe-direction "
            "diagonal_top_left_to_bottom_right --wipe-delay 0 --wipe-ease IN_OUT_CIRC "
            "--final-gradient-stops 833ab4 fd1d1d fcb045 --final-gradient-steps 12 "
            "--final-gradient-frames 3 --final-gradient-direction vertical"
        ),
    )

    wipe_direction: argutils.CharacterOrder | argutils.CharacterGroup | argutils.CharacterSort = argutils.ArgSpec(
        name="--wipe-direction",
        default=argutils.CharacterOrder.DIAGONAL_TOP_LEFT_TO_BOTTOM_RIGHT,
        type=argutils.CharacterOrderArg.type_parser,
        metavar=" ".join(argutils.CharacterOrderArg.METAVAR),
        help="Character order for the wipe: spatial groups or individual traversal, including spirals.",
    )  # pyright: ignore[reportAssignmentType]
    "CharacterOrder : Grouping or character order for the wipe."

    reverse_wipe_direction: bool = argutils.ArgSpec(
        name="--reverse-wipe-direction",
        default=False,
        action="store_true",
        help="Reverse the complete wipe direction traversal.",
    )  # pyright: ignore[reportAssignmentType]
    "bool : Reverse the complete traversal, preserving group membership."

    wipe_delay: int = argutils.ArgSpec(
        name="--wipe-delay",
        type=argutils.NonNegativeInt.type_parser,
        default=0,
        metavar=argutils.NonNegativeInt.METAVAR,
        help="Number of frames to wait between wipe easing steps. Increase to slow down the effect.",
    )  # pyright: ignore[reportAssignmentType]
    "int : Number of frames to wait between wipe easing steps. Increase to slow down the effect."

    wipe_ease: easing.EasingFunction = argutils.ArgSpec(
        name="--wipe-ease",
        type=argutils.Ease.type_parser,
        default=easing.in_out_circ,
        help="Easing function to use for the wipe effect.",
    )  # pyright: ignore[reportAssignmentType]
    "easing.EasingFunction : Easing function to use for the wipe effect."

    final_gradient_stops: tuple[Color, ...] = FinalGradientStopsArg(
        default=(Color("#833ab4"), Color("#fd1d1d"), Color("#fcb045")),
        help="Space separated, unquoted, list of colors for the wipe gradient.",
    )  # pyright: ignore[reportAssignmentType]
    "tuple[Color, ...] : Tuple of colors for the wipe gradient."

    final_gradient_steps: tuple[int, ...] | int = FinalGradientStepsArg(
        default=12,
    )  # pyright: ignore[reportAssignmentType]
    (
        "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_frames: int = FinalGradientFramesArg(
        default=3,
    )  # pyright: ignore[reportAssignmentType]
    "int : Number of frames to display each gradient step. Increase to slow down the gradient animation."

    final_gradient_direction: Gradient.Direction = FinalGradientDirectionArg(
        default=Gradient.Direction.VERTICAL,
    )  # pyright: ignore[reportAssignmentType]
    "Gradient.Direction : Direction of the final gradient."

final_gradient_direction = FinalGradientDirectionArg(default=Gradient.Direction.VERTICAL) class-attribute instance-attribute

Gradient.Direction : Direction of the final gradient.

final_gradient_frames = FinalGradientFramesArg(default=3) class-attribute instance-attribute

int : Number of frames to display each gradient step. Increase to slow down the gradient animation.

final_gradient_steps = FinalGradientStepsArg(default=12) 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 = FinalGradientStopsArg(default=(Color('#833ab4'), Color('#fd1d1d'), Color('#fcb045')), help='Space separated, unquoted, list of colors for the wipe gradient.') class-attribute instance-attribute

tuple[Color, ...] : Tuple of colors for the wipe gradient.

reverse_wipe_direction = argutils.ArgSpec(name='--reverse-wipe-direction', default=False, action='store_true', help='Reverse the complete wipe direction traversal.') class-attribute instance-attribute

bool : Reverse the complete traversal, preserving group membership.

wipe_delay = argutils.ArgSpec(name='--wipe-delay', type=argutils.NonNegativeInt.type_parser, default=0, metavar=argutils.NonNegativeInt.METAVAR, help='Number of frames to wait between wipe easing steps. Increase to slow down the effect.') class-attribute instance-attribute

int : Number of frames to wait between wipe easing steps. Increase to slow down the effect.

wipe_direction = argutils.ArgSpec(name='--wipe-direction', default=argutils.CharacterOrder.DIAGONAL_TOP_LEFT_TO_BOTTOM_RIGHT, type=argutils.CharacterOrderArg.type_parser, metavar=' '.join(argutils.CharacterOrderArg.METAVAR), help='Character order for the wipe: spatial groups or individual traversal, including spirals.') class-attribute instance-attribute

CharacterOrder : Grouping or character order for the wipe.

wipe_ease = argutils.ArgSpec(name='--wipe-ease', type=argutils.Ease.type_parser, default=easing.in_out_circ, help='Easing function to use for the wipe effect.') class-attribute instance-attribute

easing.EasingFunction : Easing function to use for the wipe effect.

WipeIterator

Bases: BaseEffectIterator[WipeConfig]

Effect iterator for the Wipe effect.

Source code in terminaltexteffects/effects/effect_wipe.py 
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
162
163
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
class WipeIterator(BaseEffectIterator[WipeConfig]):
    """Effect iterator for the Wipe effect."""

    def __init__(self, effect: Wipe) -> None:
        """Initialize the effect iterator.

        Args:
            effect (Wipe): The effect to use for the iterator.

        """
        super().__init__(effect)
        self.character_final_color_map: dict[EffectCharacter, ColorPair] = {}
        groups = self.terminal.get_characters_grouped(
            order=self.config.wipe_direction,
            reverse=self.config.reverse_wipe_direction,
        )
        self.easer = easing.SequenceEaser(
            groups,
            easing_function=self.config.wipe_ease,
        )
        self._wipe_delay = self.config.wipe_delay
        self.build()

    def build(self) -> None:
        """Build the effect."""
        final_gradient = Gradient(*self.config.final_gradient_stops, steps=self.config.final_gradient_steps)
        final_gradient_mapping = final_gradient.build_coordinate_color_mapping(
            self.terminal.canvas.text_bottom,
            self.terminal.canvas.text_top,
            self.terminal.canvas.text_left,
            self.terminal.canvas.text_right,
            self.config.final_gradient_direction,
        )
        final_transition_steps = (
            self.config.final_gradient_steps[0]
            if isinstance(self.config.final_gradient_steps, tuple)
            else self.config.final_gradient_steps
        )
        for character in self.terminal.get_characters():
            if self.terminal.config.existing_color_handling == "dynamic":
                self.character_final_color_map[character] = ColorPair(
                    fg=character.animation.input_fg_color,
                    bg=character.animation.input_bg_color,
                )
            else:
                self.character_final_color_map[character] = ColorPair(
                    fg=final_gradient_mapping[character.input_coord],
                )
            wipe_scn = character.animation.new_scene(scene_id="wipe")
            if self.terminal.config.existing_color_handling == "dynamic":
                final_colors = self.character_final_color_map[character]
                frame_count = (
                    sum(self.config.final_gradient_steps) + 1
                    if isinstance(self.config.final_gradient_steps, tuple)
                    else self.config.final_gradient_steps + 1
                )
                for _ in range(frame_count):
                    wipe_scn.add_frame(
                        character.input_symbol,
                        self.config.final_gradient_frames,
                        colors=final_colors,
                    )
            else:
                final_fg_color = self.character_final_color_map[character].fg
                assert final_fg_color is not None
                wipe_gradient = Gradient(
                    final_gradient.spectrum[0],
                    final_fg_color,
                    steps=final_transition_steps,
                )
                wipe_scn.apply_gradient_to_symbols(
                    character.input_symbol,
                    self.config.final_gradient_frames,
                    fg_gradient=wipe_gradient,
                )

    def __next__(self) -> str:
        """Return the next frame in the animation."""
        if self.active_characters or not self.easer.is_complete():
            if self._wipe_delay == 0:
                self.easer.step()
                for group in self.easer.added:
                    for character in group:
                        character.animation.activate_scene("wipe")
                        self.terminal.set_character_visibility(character, is_visible=True)
                        self.active_characters.add(character)
                for group in self.easer.removed:
                    for character in group:
                        character.animation.deactivate_scene()
                        character.animation.query_scene("wipe").reset_scene()
                        self.terminal.set_character_visibility(character, is_visible=False)
                self._wipe_delay = self.config.wipe_delay
            else:
                self._wipe_delay -= 1
            self.update()
            return self.frame

        raise StopIteration

__init__(effect)

Initialize the effect iterator.

Parameters:

Name Type Description Default
effect Wipe

The effect to use for the iterator.

 required
Source code in terminaltexteffects/effects/effect_wipe.py 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
def __init__(self, effect: Wipe) -> None:
    """Initialize the effect iterator.

    Args:
        effect (Wipe): The effect to use for the iterator.

    """
    super().__init__(effect)
    self.character_final_color_map: dict[EffectCharacter, ColorPair] = {}
    groups = self.terminal.get_characters_grouped(
        order=self.config.wipe_direction,
        reverse=self.config.reverse_wipe_direction,
    )
    self.easer = easing.SequenceEaser(
        groups,
        easing_function=self.config.wipe_ease,
    )
    self._wipe_delay = self.config.wipe_delay
    self.build()

__next__()

Return the next frame in the animation.

Source code in terminaltexteffects/effects/effect_wipe.py 
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
def __next__(self) -> str:
    """Return the next frame in the animation."""
    if self.active_characters or not self.easer.is_complete():
        if self._wipe_delay == 0:
            self.easer.step()
            for group in self.easer.added:
                for character in group:
                    character.animation.activate_scene("wipe")
                    self.terminal.set_character_visibility(character, is_visible=True)
                    self.active_characters.add(character)
            for group in self.easer.removed:
                for character in group:
                    character.animation.deactivate_scene()
                    character.animation.query_scene("wipe").reset_scene()
                    self.terminal.set_character_visibility(character, is_visible=False)
            self._wipe_delay = self.config.wipe_delay
        else:
            self._wipe_delay -= 1
        self.update()
        return self.frame

    raise StopIteration

build()

Build the effect.

Source code in terminaltexteffects/effects/effect_wipe.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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
def build(self) -> None:
    """Build the effect."""
    final_gradient = Gradient(*self.config.final_gradient_stops, steps=self.config.final_gradient_steps)
    final_gradient_mapping = final_gradient.build_coordinate_color_mapping(
        self.terminal.canvas.text_bottom,
        self.terminal.canvas.text_top,
        self.terminal.canvas.text_left,
        self.terminal.canvas.text_right,
        self.config.final_gradient_direction,
    )
    final_transition_steps = (
        self.config.final_gradient_steps[0]
        if isinstance(self.config.final_gradient_steps, tuple)
        else self.config.final_gradient_steps
    )
    for character in self.terminal.get_characters():
        if self.terminal.config.existing_color_handling == "dynamic":
            self.character_final_color_map[character] = ColorPair(
                fg=character.animation.input_fg_color,
                bg=character.animation.input_bg_color,
            )
        else:
            self.character_final_color_map[character] = ColorPair(
                fg=final_gradient_mapping[character.input_coord],
            )
        wipe_scn = character.animation.new_scene(scene_id="wipe")
        if self.terminal.config.existing_color_handling == "dynamic":
            final_colors = self.character_final_color_map[character]
            frame_count = (
                sum(self.config.final_gradient_steps) + 1
                if isinstance(self.config.final_gradient_steps, tuple)
                else self.config.final_gradient_steps + 1
            )
            for _ in range(frame_count):
                wipe_scn.add_frame(
                    character.input_symbol,
                    self.config.final_gradient_frames,
                    colors=final_colors,
                )
        else:
            final_fg_color = self.character_final_color_map[character].fg
            assert final_fg_color is not None
            wipe_gradient = Gradient(
                final_gradient.spectrum[0],
                final_fg_color,
                steps=final_transition_steps,
            )
            wipe_scn.apply_gradient_to_symbols(
                character.input_symbol,
                self.config.final_gradient_frames,
                fg_gradient=wipe_gradient,
            )

get_effect_resources()

Get the command, effect class, and configuration class for the effect.

Returns:

Type Description
tuple[str, type[BaseEffect], type[BaseConfig]]

tuple[str, type[BaseEffect], type[BaseConfig]]: The command name, effect class, and configuration class.
Source code in terminaltexteffects/effects/effect_wipe.py 
25
26
27
28
29
30
31
32
def get_effect_resources() -> tuple[str, type[BaseEffect], type[BaseConfig]]:
    """Get the command, effect class, and configuration class for the effect.

    Returns:
        tuple[str, type[BaseEffect], type[BaseConfig]]: The command name, effect class, and configuration class.

    """
    return "wipe", Wipe, WipeConfig