File size: 10,535 Bytes
5b76e0f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 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 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 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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | from __future__ import annotations
from rich.cells import cell_len, get_character_cell_size
from rich.console import Console, ConsoleOptions, RenderableType, RenderResult
from rich.highlighter import Highlighter
from rich.segment import Segment
from rich.text import Text
from .. import events
from .._segment_tools import line_crop
from ..binding import Binding
from ..geometry import Size
from ..message import Message
from ..reactive import reactive
from ..widget import Widget
class _InputRenderable:
"""Render the input content."""
def __init__(self, input: Input, cursor_visible: bool) -> None:
self.input = input
self.cursor_visible = cursor_visible
def __rich_console__(
self, console: "Console", options: "ConsoleOptions"
) -> "RenderResult":
input = self.input
result = input._value
if input._cursor_at_end:
result.pad_right(1)
cursor_style = input.get_component_rich_style("input--cursor")
if self.cursor_visible and input.has_focus:
cursor = input.cursor_position
result.stylize(cursor_style, cursor, cursor + 1)
width = input.content_size.width
segments = list(result.render(console))
line_length = Segment.get_line_length(segments)
if line_length < width:
segments = Segment.adjust_line_length(segments, width)
line_length = width
line = line_crop(
list(segments),
input.view_position,
input.view_position + width,
line_length,
)
yield from line
class Input(Widget, can_focus=True):
"""A text input widget."""
DEFAULT_CSS = """
Input {
background: $boost;
color: $text;
padding: 0 2;
border: tall $background;
width: 100%;
height: 1;
}
Input.-disabled {
opacity: 0.6;
}
Input:focus {
border: tall $accent;
}
Input>.input--cursor {
background: $surface;
color: $text;
text-style: reverse;
}
Input>.input--placeholder {
color: $text-disabled;
}
"""
BINDINGS = [
Binding("left", "cursor_left", "cursor left", show=False),
Binding("right", "cursor_right", "cursor right", show=False),
Binding("backspace", "delete_left", "delete left", show=False),
Binding("home", "home", "home", show=False),
Binding("end", "end", "end", show=False),
Binding("ctrl+d", "delete_right", "delete right", show=False),
Binding("enter", "submit", "Submit", show=False),
]
COMPONENT_CLASSES = {"input--cursor", "input--placeholder"}
cursor_blink = reactive(True)
value = reactive("", layout=True)
input_scroll_offset = reactive(0)
cursor_position = reactive(0)
view_position = reactive(0)
placeholder = reactive("")
complete = reactive("")
width = reactive(1)
_cursor_visible = reactive(True)
password = reactive(False)
max_size: reactive[int | None] = reactive(None)
def __init__(
self,
value: str = "",
placeholder: str = "",
highlighter: Highlighter | None = None,
name: str | None = None,
id: str | None = None,
classes: str | None = None,
) -> None:
super().__init__(name=name, id=id, classes=classes)
self.value = value
self.placeholder = placeholder
self.highlighter = highlighter
def _position_to_cell(self, position: int) -> int:
"""Convert an index within the value to cell position."""
cell_offset = cell_len(self.value[:position])
return cell_offset
@property
def _cursor_offset(self) -> int:
"""Get the cell offset of the cursor."""
offset = self._position_to_cell(self.cursor_position)
if self._cursor_at_end:
offset += 1
return offset
@property
def _cursor_at_end(self) -> bool:
"""Check if the cursor is at the end"""
return self.cursor_position >= len(self.value)
def validate_cursor_position(self, cursor_position: int) -> int:
return min(max(0, cursor_position), len(self.value))
def validate_view_position(self, view_position: int) -> int:
width = self.content_size.width
new_view_position = max(0, min(view_position, self.cursor_width - width))
return new_view_position
def watch_cursor_position(self, cursor_position: int) -> None:
width = self.content_size.width
view_start = self.view_position
view_end = view_start + width
cursor_offset = self._cursor_offset
if cursor_offset >= view_end or cursor_offset < view_start:
view_position = cursor_offset - width // 2
self.view_position = view_position
else:
self.view_position = self.view_position
async def watch_value(self, value: str) -> None:
if self.styles.auto_dimensions:
self.refresh(layout=True)
await self.emit(self.Changed(self, value))
@property
def cursor_width(self) -> int:
"""Get the width of the input (with extra space for cursor at the end)."""
if self.placeholder and not self.value:
return cell_len(self.placeholder)
return self._position_to_cell(len(self.value)) + 1
def render(self) -> RenderableType:
self.view_position = self.view_position
if not self.value:
placeholder = Text(self.placeholder)
placeholder.stylize(self.get_component_rich_style("input--placeholder"))
if self.has_focus:
cursor_style = self.get_component_rich_style("input--cursor")
if self._cursor_visible:
placeholder.stylize(cursor_style, 0, 1)
return placeholder
return _InputRenderable(self, self._cursor_visible)
class Changed(Message, bubble=True):
"""Value was changed."""
def __init__(self, sender: Input, value: str) -> None:
super().__init__(sender)
self.value = value
self.input = sender
class Submitted(Message, bubble=True):
"""Value was updated via enter key or blur."""
def __init__(self, sender: Input, value: str) -> None:
super().__init__(sender)
self.value = value
self.input = sender
@property
def _value(self) -> Text:
"""Value rendered as text."""
if self.password:
return Text("•" * len(self.value), no_wrap=True, overflow="ignore")
else:
text = Text(self.value, no_wrap=True, overflow="ignore")
if self.highlighter is not None:
text = self.highlighter(text)
return text
def get_content_width(self, container: Size, viewport: Size) -> int:
return self.cursor_width
def get_content_height(self, container: Size, viewport: Size, width: int) -> int:
return 1
def _toggle_cursor(self) -> None:
"""Toggle visibility of cursor."""
self._cursor_visible = not self._cursor_visible
def on_mount(self) -> None:
self.blink_timer = self.set_interval(
0.5,
self._toggle_cursor,
pause=not (self.cursor_blink and self.has_focus),
)
def on_blur(self) -> None:
self.blink_timer.pause()
def on_focus(self) -> None:
self.cursor_position = len(self.value)
if self.cursor_blink:
self.blink_timer.resume()
async def on_key(self, event: events.Key) -> None:
self._cursor_visible = True
if self.cursor_blink:
self.blink_timer.reset()
# Do key bindings first
if await self.handle_key(event):
event.prevent_default()
event.stop()
return
elif event.is_printable:
event.stop()
assert event.char is not None
self.insert_text_at_cursor(event.char)
event.prevent_default()
def on_paste(self, event: events.Paste) -> None:
line = event.text.splitlines()[0]
self.insert_text_at_cursor(line)
def on_click(self, event: events.Click) -> None:
offset = event.get_content_offset(self)
if offset is None:
return
event.stop()
click_x = offset.x + self.view_position
cell_offset = 0
_cell_size = get_character_cell_size
for index, char in enumerate(self.value):
if cell_offset >= click_x:
self.cursor_position = index
break
cell_offset += _cell_size(char)
else:
self.cursor_position = len(self.value)
def insert_text_at_cursor(self, text: str) -> None:
"""Insert new text at the cursor, move the cursor to the end of the new text.
Args:
text (str): new text to insert.
"""
if self.cursor_position > len(self.value):
self.value += text
self.cursor_position = len(self.value)
else:
value = self.value
before = value[: self.cursor_position]
after = value[self.cursor_position :]
self.value = f"{before}{text}{after}"
self.cursor_position += len(text)
def action_cursor_left(self) -> None:
self.cursor_position -= 1
def action_cursor_right(self) -> None:
self.cursor_position += 1
def action_home(self) -> None:
self.cursor_position = 0
def action_end(self) -> None:
self.cursor_position = len(self.value)
def action_delete_right(self) -> None:
value = self.value
delete_position = self.cursor_position
before = value[:delete_position]
after = value[delete_position + 1 :]
self.value = f"{before}{after}"
self.cursor_position = delete_position
def action_delete_left(self) -> None:
if self.cursor_position == len(self.value):
self.value = self.value[:-1]
self.cursor_position = len(self.value)
else:
value = self.value
delete_position = self.cursor_position - 1
before = value[:delete_position]
after = value[delete_position + 1 :]
self.value = f"{before}{after}"
self.cursor_position = delete_position
async def action_submit(self) -> None:
await self.emit(self.Submitted(self, self.value))
|