flexablelib-components 3.3.0__py3-none-any.whl

flexablelib_components/overlays.py

@@ -0,0 +1,234 @@
+"""
+Dialogs and overlays: a modal with buttons, confirm and prompt dialogs, a
+loading overlay, a popover, and the help line that shows the focused
+component's hint (the terminal's tooltip).
+"""
+
+from flexablelib import _frames as _fx
+
+from .base import Button, _Themed, frame
+from .display import Spinner
+from .inputs import TextInput
+from .navigation import render_into
+
+__all__ = ['Modal', 'ConfirmDialog', 'PromptDialog', 'LoadingOverlay',
+           'Popover', 'HelpLine']
+
+
+class Modal(_Themed):
+    """
+    A framed dialog over the screen: ``content`` and a row of ``buttons``
+    (``(label, action)`` pairs or :class:`Button` s; an action returning
+    anything but False closes the dialog). ``open(app)`` shows it; Escape
+    closes it when ``closable``. ``width`` caps its width.
+    """
+
+    def __init__(self, content, title=None, buttons=(), width=60,
+                 closable=True, on_close=None, **kwargs):
+        super(Modal, self).__init__(**kwargs)
+        self.content = content
+        self.title = title
+        self.width = width
+        self.closable = bool(closable)
+        self.on_close = on_close
+        self.buttons = []
+        colors = kwargs.get('use_colors')
+        for b in buttons:
+            if not isinstance(b, Button):
+                label, action = b[0], b[1] if len(b) > 1 else None
+                kind = b[2] if len(b) > 2 else 'default'
+                b = Button(label, None, kind=kind, theme=self.theme,
+                           use_colors=colors)
+                b.on_press = self._wrap(action)
+            self.buttons.append(b)
+        self.is_open = False
+
+    def _wrap(self, action):
+        def run():
+            result = action() if action is not None else None
+            if result is not False:
+                self.close()
+        return run
+
+    def children(self):
+        kids = [] if isinstance(self.content, str) else [self.content]
+        return kids + self.buttons
+
+    def natural_width(self):
+        return self.width
+
+    def open(self, app):
+        app.push(self)
+        self.is_open = True
+        return self
+
+    def close(self):
+        if self.app is not None and self.is_open:
+            self.app.pop(self)
+        self.is_open = False
+        if self.on_close is not None:
+            self.on_close()
+
+    def handle_key(self, key):
+        k = str(key)
+        if k == 'escape' and self.closable:
+            self.close()
+            return True
+        if k in ('left', 'right') and self.app is not None and \
+                self.app.focused in self.buttons:
+            i = self.buttons.index(self.app.focused)
+            step = 1 if k == 'right' else -1
+            self.app.focus(self.buttons[(i + step) % len(self.buttons)])
+            return True
+        return super(Modal, self).handle_key(key)
+
+    def draw(self, width, height):
+        inner = max(1, width - 4)
+        body = render_into(self.content, inner) if not \
+            isinstance(self.content, str) else []
+        if isinstance(self.content, str):
+            from flexablelib.text_width import wrap_to_width
+            for paragraph in self.content.split('\n'):
+                body.extend(wrap_to_width(paragraph, inner) or [''])
+        lines = [''] + body + ['']
+        if self.buttons:
+            row = '  '.join(b.render(width=b.natural_width())
+                            for b in self.buttons)
+            lines.append(_fx.fit_line(row, inner, 'r'))
+        footer = 'esc' if self.closable else None
+        return frame([' ' + l for l in lines], width, self.title,
+                     self.theme.accent, self.paint,
+                     title_color='bold ' + self.theme.accent, footer=footer)
+
+
+class ConfirmDialog(Modal):
+    """Yes / no: ``on_confirm()`` or ``on_cancel()``; ``danger=True``
+    colours the confirm button as destructive."""
+
+    def __init__(self, message, on_confirm=None, on_cancel=None,
+                 title='Confirmar', confirm_label='Aceptar',
+                 cancel_label='Cancelar', danger=False, **kwargs):
+        self.result = None
+
+        def yes():
+            self.result = True
+            if on_confirm is not None:
+                on_confirm()
+
+        def no():
+            self.result = False
+            if on_cancel is not None:
+                on_cancel()
+        super(ConfirmDialog, self).__init__(
+            message, title=title, width=kwargs.pop('width', 50),
+            buttons=[(cancel_label, no),
+                     (confirm_label, yes, 'danger' if danger else 'primary')],
+            **kwargs)
+
+
+class PromptDialog(Modal):
+    """Asks for one value: ``on_submit(value)`` on Enter or Aceptar."""
+
+    def __init__(self, label, on_submit=None, value='', title=None,
+                 validators=None, **kwargs):
+        colors = kwargs.get('use_colors')
+        self.input = TextInput(label, value=value, validators=validators,
+                               theme=kwargs.get('theme'), use_colors=colors)
+        self.value = None
+        self._callback = on_submit
+
+        def accept():
+            if self.input.validate():
+                return False
+            self.value = self.input.value
+            if self._callback is not None:
+                self._callback(self.value)
+        self.input.on_submit = lambda v: self._accept_and_close(accept)
+        super(PromptDialog, self).__init__(
+            self.input, title=title, width=kwargs.pop('width', 50),
+            buttons=[('Cancelar', None), ('Aceptar', accept, 'primary')],
+            **kwargs)
+
+    def _accept_and_close(self, accept):
+        if accept() is not False:
+            self.close()
+
+
+class LoadingOverlay(Modal):
+    """
+    A spinner and message over the screen that holds the focus while work
+    runs: ``show(app)`` / ``hide()``; ``progress`` (0-1) adds a bar.
+    """
+
+    def __init__(self, message='Cargando…', progress=None, **kwargs):
+        self.spinner = Spinner(message, theme=kwargs.get('theme'),
+                               use_colors=kwargs.get('use_colors'))
+        self.progress = progress
+        super(LoadingOverlay, self).__init__(self.spinner, closable=False,
+                                             width=kwargs.pop('width', 40),
+                                             **kwargs)
+
+    def children(self):
+        return []
+
+    def show(self, app):
+        return self.open(app)
+
+    def hide(self):
+        self.close()
+
+    def handle_key(self, key):
+        return True
+
+    def draw(self, width, height):
+        lines = self.spinner.render(width=max(1, width - 4)).split('\n')
+        if self.progress is not None:
+            inner = max(1, width - 10)
+            fraction = max(0.0, min(1.0, self.progress))
+            done = int(round(inner * fraction))
+            lines.append(self.paint('█' * done, self.theme.accent) +
+                         self.paint('░' * (inner - done), self.theme.muted) +
+                         ' {0:>3.0f}%'.format(fraction * 100))
+        return frame([' ' + l for l in [''] + lines + ['']], width, None,
+                     self.theme.accent, self.paint)
+
+
+class Popover(Modal):
+    """Floating content at a position (``'top-right'``, ``(x, y)``...);
+    ``modal=False`` leaves the focus where it was."""
+
+    def __init__(self, content, title=None, width=40, **kwargs):
+        super(Popover, self).__init__(content, title=title, width=width,
+                                      **kwargs)
+
+    def open(self, app, position='center', modal=True):
+        app.push(self, position=position, modal=modal)
+        self.is_open = True
+        return self
+
+
+class HelpLine(_Themed):
+    """
+    One line with the hint of whatever has the focus: its ``help``,
+    ``tooltip`` or ``hint`` attribute. Put it above the footer; it is the
+    terminal version of a tooltip.
+    """
+
+    def __init__(self, default='', **kwargs):
+        super(HelpLine, self).__init__(**kwargs)
+        self.default = default
+
+    def natural_width(self):
+        return 40
+
+    def draw(self, width, height):
+        node = self.app.focused if self.app is not None else None
+        text = ''
+        while node is not None and not text:
+            text = getattr(node, 'tooltip', None) or \
+                getattr(node, 'hint', None) or getattr(node, 'help', None) \
+                or ''
+            node = getattr(node, 'parent', None)
+        text = text or self.default
+        return [self.paint(_fx.truncate('ⓘ ' + text if text else '', width,
+                                        '…'), self.theme.muted)]

flexablelib_components-3.3.0.dist-info/METADATA

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: flexablelib-components
+Version: 3.3.0
+Summary: Interactive terminal components for flexablelib: inputs, dates, tables, forms, menus, tabs, dialogs and more.
+Home-page: https://github.com/Opus-Perpetuus/flexablelib
+Author: Benjamin Ramirez
+Author-email: chilerito12@gmail.com
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Environment :: Console :: Curses
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Terminals
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flexablelib>=3.3.0
+Requires-Dist: flexablelib-tui>=3.3.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# flexablelib-components
+
+Interactive terminal components for [flexablelib](https://github.com/Opus-Perpetuus/flexablelib): form inputs, dates and times, interactive and editable tables, filters, forms, menus, tabs, wizard, tree, command palette, dialogs, charts and more, all keyboard driven.
+
+Install it with `pip install flexablelib[components]`.
+
+Documentation: [COMPONENTS.md](https://github.com/Opus-Perpetuus/flexablelib/blob/main/docs/COMPONENTS.md)
+
+![Components](https://raw.githubusercontent.com/Opus-Perpetuus/flexablelib/main/docs/img/v33/08_entradas.png)
+
+![An application built with the components](https://raw.githubusercontent.com/Opus-Perpetuus/flexablelib/main/docs/img/v33/01_demo_140.png)

flexablelib_components-3.3.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+flexablelib_components/__init__.py,sha256=veePgfw_yKCjkgCBNamqkeAtA6gAkTWuHbMtagX3NHU,3645
+flexablelib_components/base.py,sha256=hA3qOWmYqbwPukOOOjAO3NxleUwxIrlRA4S3Xq8QWzc,10976
+flexablelib_components/data.py,sha256=xaduhE3XQ-abgFSZTnfZiOBGcDcrqULydDbpCGR8YxY,35671
+flexablelib_components/dates.py,sha256=8QsZsz-5f1Blq3wyfBh3Kv6CjqR3Jdc9ST8gqG1zyOM,29222
+flexablelib_components/display.py,sha256=V10fE4ENwkB37elNrx7i0k_Hjy2SMyppiiqF7WLLtQY,41564
+flexablelib_components/inputs.py,sha256=8MOwfjI1eAPZTqn4U1o0_BsKs1oS5TIrvM6WSYwU6LU,56286
+flexablelib_components/navigation.py,sha256=RpugOoJP76H_wnysHVoLstagtD6VeleTYImQMT2UIT8,46281
+flexablelib_components/overlays.py,sha256=046xWcC0zlusFKO3KKqxWkkGZ1az0PVJYZ8KdcQ_lOs,8502
+flexablelib_components/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flexablelib_components-3.3.0.dist-info/licenses/LICENSE,sha256=TsktDCE3E8N8WasPUHkR5Azor67EyerUJdk54L4wavM,1077
+flexablelib_components-3.3.0.dist-info/METADATA,sha256=4ED3XUp0awovCasA4kdPQciQl_T2k1lZSIyxztwWCNQ,1794
+flexablelib_components-3.3.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+flexablelib_components-3.3.0.dist-info/top_level.txt,sha256=f_rlaJQr0X1xNczBPYbFkM-lagHyMSTl-e9CFTm1c7I,23
+flexablelib_components-3.3.0.dist-info/RECORD,,

flexablelib_components-3.3.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

flexablelib_components-3.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2022 Benjamin Ramirez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

flexablelib_components-3.3.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+flexablelib_components