├── src └── textual_colorpicker │ ├── py.typed │ ├── __init__.py │ ├── color_preview.py │ ├── hue_picker.py │ ├── color_picker.py │ ├── saturation_value_picker.py │ └── color_inputs.py ├── pyproject.toml ├── assets └── screenshot.png ├── pytest.ini ├── setup.py ├── mypy.ini ├── CHANGELOG.md ├── setup.cfg ├── tests ├── color_inputs │ ├── test_color_inputs.py │ ├── test_hex_input.py │ ├── test_rgb_inputs.py │ └── test_hsv_inputs.py ├── test_hue_picker.py ├── test_saturation_value_picker.py └── test_color_picker.py ├── README.md ├── .gitignore └── LICENSE /src/textual_colorpicker/py.typed: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools"] 3 | build-backend = "setuptools.build_meta" 4 | -------------------------------------------------------------------------------- /assets/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TomJGooding/textual-colorpicker/HEAD/assets/screenshot.png -------------------------------------------------------------------------------- /pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | testpaths = 3 | tests 4 | asyncio_mode = auto 5 | asyncio_default_fixture_loop_scope = function 6 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from setuptools import setup 4 | 5 | if __name__ == "__main__": 6 | setup() 7 | -------------------------------------------------------------------------------- /src/textual_colorpicker/__init__.py: -------------------------------------------------------------------------------- 1 | __version__ = "0.1.0" 2 | 3 | from textual_colorpicker.color_picker import ColorPicker 4 | 5 | __all__ = ["ColorPicker"] 6 | -------------------------------------------------------------------------------- /mypy.ini: -------------------------------------------------------------------------------- 1 | [mypy] 2 | files = src, tests 3 | 4 | disallow_untyped_defs = True 5 | disallow_any_unimported = True 6 | no_implicit_optional = True 7 | check_untyped_defs = True 8 | warn_return_any = True 9 | show_error_codes = True 10 | warn_unused_ignores = True 11 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 7 | 8 | ## [0.1.0] - 2025-06-22 9 | 10 | - Initial release 11 | 12 | [0.1.0]: https://github.com/TomJGooding/textual-colorpicker/commits/v0.1.0 13 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | name = textual-colorpicker 3 | version = attr: textual_colorpicker.__version__ 4 | author = TomJGooding 5 | description = A color picker widget for Textual 6 | long_description = file: README.md 7 | long_description_content_type = text/markdown 8 | url = https://github.com/TomJGooding/textual-colorpicker 9 | classifiers = 10 | Programming Language :: Python :: 3 11 | License :: OSI Approved :: GNU General Public License v3 (GPLv3) 12 | Operating System :: OS Independent 13 | 14 | [options] 15 | python_requires = >=3.8 16 | package_dir = 17 | = src 18 | packages = find: 19 | install_requires = 20 | textual >= 3.3.0 21 | 22 | [options.packages.find] 23 | where = src 24 | 25 | [options.package_data] 26 | textual_colorpicker = py.typed 27 | 28 | [options.extras_require] 29 | dev = 30 | black 31 | flake8 32 | isort 33 | mypy 34 | pytest 35 | pytest-asyncio 36 | pytest-cov 37 | textual-dev 38 | -------------------------------------------------------------------------------- /tests/color_inputs/test_color_inputs.py: -------------------------------------------------------------------------------- 1 | from textual.app import App, ComposeResult 2 | from textual.color import HSV, Color 3 | 4 | from textual_colorpicker.color_inputs import ColorInputs, HexInput, HsvInputs, RgbInputs 5 | 6 | 7 | class ColorInputsApp(App): 8 | def compose(self) -> ComposeResult: 9 | yield ColorInputs(Color(0, 255, 255)) 10 | 11 | 12 | def test_color_value_is_clamped() -> None: 13 | color_inputs = ColorInputs(Color(999, 999, 999)) 14 | assert color_inputs._color == Color(255, 255, 255) 15 | 16 | color_inputs = ColorInputs(Color(-999, -999, -999)) 17 | assert color_inputs._color == Color(0, 0, 0) 18 | 19 | 20 | async def test_initial_color_updates_all_inputs() -> None: 21 | app = ColorInputsApp() 22 | async with app.run_test() as pilot: 23 | color_inputs = pilot.app.query_one(ColorInputs) 24 | 25 | rgb_inputs = color_inputs.query_one(RgbInputs) 26 | assert rgb_inputs.color == Color(0, 255, 255) 27 | 28 | hsv_inputs = color_inputs.query_one(HsvInputs) 29 | assert hsv_inputs.hsv == HSV(0.5, 1.0, 1.0) 30 | 31 | hex_input = color_inputs.query_one(HexInput) 32 | assert hex_input.value == "#00FFFF" 33 | -------------------------------------------------------------------------------- /src/textual_colorpicker/color_preview.py: -------------------------------------------------------------------------------- 1 | from textual.app import RenderResult 2 | from textual.color import Color 3 | from textual.reactive import reactive 4 | from textual.renderables.blank import Blank 5 | from textual.widget import Widget 6 | 7 | 8 | class ColorPreview(Widget): 9 | """A color preview widget.""" 10 | 11 | color: reactive[Color] = reactive(Color(255, 0, 0)) 12 | """Color to display in the preview.""" 13 | 14 | def __init__( 15 | self, 16 | color: Color = Color(255, 0, 0), 17 | *, 18 | name: str | None = None, 19 | id: str | None = None, 20 | classes: str | None = None, 21 | disabled: bool = False 22 | ) -> None: 23 | """Create a color preview widget. 24 | 25 | Args: 26 | color: Color to display in the preview. 27 | name: The name of the widget. 28 | id: The ID of the widget in the DOM. 29 | classes: The CSS classes of the widget. 30 | disabled: Whether the widget is disabled or not. 31 | """ 32 | super().__init__(name=name, id=id, classes=classes, disabled=disabled) 33 | self.color = color 34 | 35 | def render(self) -> RenderResult: 36 | return Blank(self.color) 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # textual-colorpicker 2 | 3 | A color picker widget for [Textual](https://github.com/Textualize/textual). 4 | 5 | ![screenshot](https://raw.githubusercontent.com/TomJGooding/textual-colorpicker/main/assets/screenshot.png) 6 | 7 | ## Installation 8 | 9 | Install textual-colorpicker using pip: 10 | 11 | ``` 12 | pip install textual-colorpicker 13 | ``` 14 | 15 | ## Usage 16 | 17 | textual-colorpicker provides a `ColorPicker` widget for use in Textual. 18 | 19 | ```python 20 | from textual.app import App, ComposeResult 21 | 22 | from textual_colorpicker import ColorPicker 23 | 24 | 25 | class ColorPickerApp(App): 26 | CSS = """ 27 | Screen { 28 | align: center middle; 29 | } 30 | """ 31 | 32 | def compose(self) -> ComposeResult: 33 | yield ColorPicker() 34 | 35 | 36 | if __name__ == "__main__": 37 | app = ColorPickerApp() 38 | app.run() 39 | ``` 40 | 41 | ## Limitations 42 | 43 | Textual apps run in the terminal, which work in terms of character cells rather 44 | than pixels. This means you obviously can't have the same fine-grained control 45 | with the mouse for this color picker as usual. 46 | 47 | ## Contributing 48 | 49 | I created this color picker widget as a learning exercise to better understand 50 | Textual and it is still a work in progress. 51 | 52 | I'd really appreciate any feedback or suggestions, but I'm afraid I probably 53 | won't be accepting any PRs at the moment. 54 | 55 | ## License 56 | 57 | Licensed under the [GNU General Public License v3.0](LICENSE). 58 | -------------------------------------------------------------------------------- /tests/test_hue_picker.py: -------------------------------------------------------------------------------- 1 | from textual.app import App, ComposeResult 2 | 3 | from textual_colorpicker.hue_picker import HuePicker 4 | 5 | 6 | class HuePickerApp(App): 7 | CSS = """ 8 | HuePicker { 9 | width: 35; 10 | } 11 | """ 12 | 13 | def __init__(self) -> None: 14 | super().__init__() 15 | self.messages: list[str] = [] 16 | 17 | def compose(self) -> ComposeResult: 18 | yield HuePicker() 19 | 20 | def on_hue_picker_changed(self, event: HuePicker.Changed) -> None: 21 | self.messages.append(event.__class__.__name__) 22 | 23 | 24 | def test_hue_value_is_clamped() -> None: 25 | hue_picker = HuePicker(hue=99.0) 26 | assert hue_picker.hue == 1.0 27 | 28 | hue_picker.hue = -99.0 29 | assert hue_picker.hue == 0.0 30 | 31 | 32 | async def test_clicking_updates_hue_value() -> None: 33 | app = HuePickerApp() 34 | async with app.run_test() as pilot: 35 | hue_picker = pilot.app.query_one(HuePicker) 36 | await pilot.click(HuePicker, offset=(17, 0)) 37 | assert hue_picker.hue == 0.5 38 | 39 | 40 | async def test_clicking_outside_content_is_noop() -> None: 41 | app = HuePickerApp() 42 | async with app.run_test() as pilot: 43 | hue_picker = pilot.app.query_one(HuePicker) 44 | hue_picker.styles.padding = (0, 2) 45 | expected_value = 0.0 46 | assert hue_picker.hue == expected_value # Sanity check 47 | 48 | await pilot.click(HuePicker, offset=(1, 0)) 49 | assert hue_picker.hue == expected_value # No change 50 | 51 | await pilot.click(HuePicker, offset=(33, 0)) 52 | assert hue_picker.hue == expected_value # No change 53 | 54 | 55 | # TODO: Remember to uncomment this test after enabling click and drag 56 | # 57 | # async def test_click_and_drag_updates_hue_value() -> None: 58 | # app = HuePickerApp() 59 | # async with app.run_test() as pilot: 60 | # hue_picker = pilot.app.query_one(HuePicker) 61 | # await pilot.mouse_down(HuePicker, offset=(7, 0)) 62 | # await pilot.hover(HuePicker, offset=(17, 0)) 63 | # assert hue_picker.hue == 0.5 64 | 65 | 66 | async def test_changed_hue_posts_message() -> None: 67 | app = HuePickerApp() 68 | async with app.run_test() as pilot: 69 | hue_picker = pilot.app.query_one(HuePicker) 70 | expected_messages: list[str] = [] 71 | assert app.messages == expected_messages 72 | 73 | hue_picker.hue = 1.0 74 | await pilot.pause() 75 | expected_messages.append("Changed") 76 | assert app.messages == expected_messages 77 | -------------------------------------------------------------------------------- /tests/test_saturation_value_picker.py: -------------------------------------------------------------------------------- 1 | from textual.app import App, ComposeResult 2 | from textual.color import HSV 3 | 4 | from textual_colorpicker.saturation_value_picker import SaturationValuePicker 5 | 6 | 7 | class SaturationValuePickerApp(App): 8 | CSS = """ 9 | SaturationValuePicker { 10 | width: 35; 11 | height: 17; 12 | } 13 | """ 14 | 15 | def __init__(self) -> None: 16 | super().__init__() 17 | self.messages: list[str] = [] 18 | 19 | def compose(self) -> ComposeResult: 20 | yield SaturationValuePicker() 21 | 22 | def on_saturation_value_picker_changed( 23 | self, event: SaturationValuePicker.Changed 24 | ) -> None: 25 | self.messages.append(event.__class__.__name__) 26 | 27 | 28 | def test_hsv_value_is_clamped() -> None: 29 | saturation_value_picker = SaturationValuePicker(HSV(99.0, 99.0, 99.0)) 30 | assert saturation_value_picker.hsv == HSV(1.0, 1.0, 1.0) 31 | 32 | saturation_value_picker.hsv = HSV(-99.0, -99.0, -99.0) 33 | assert saturation_value_picker.hsv == HSV(0.0, 0.0, 0.0) 34 | 35 | 36 | async def test_clicking_updates_hsv_value() -> None: 37 | app = SaturationValuePickerApp() 38 | async with app.run_test() as pilot: 39 | saturation_value_picker = pilot.app.query_one(SaturationValuePicker) 40 | await pilot.click(SaturationValuePicker, offset=(17, 8)) 41 | assert saturation_value_picker.hsv.s == 0.5 42 | assert saturation_value_picker.hsv.v == 0.5 43 | 44 | 45 | async def test_clicking_outside_content_is_noop() -> None: 46 | app = SaturationValuePickerApp() 47 | async with app.run_test() as pilot: 48 | saturation_value_picker = pilot.app.query_one(SaturationValuePicker) 49 | saturation_value_picker.styles.padding = (0, 2) 50 | expected_hsv = HSV(0.0, 1.0, 1.0) 51 | assert saturation_value_picker.hsv == expected_hsv # Sanity check 52 | 53 | await pilot.click(SaturationValuePicker, offset=(1, 0)) 54 | assert saturation_value_picker.hsv == expected_hsv # No change 55 | 56 | await pilot.click(SaturationValuePicker, offset=(33, 0)) 57 | assert saturation_value_picker.hsv == expected_hsv # No change 58 | 59 | 60 | # TODO: Remember to uncomment this test after enabling click and drag 61 | # 62 | # async def test_click_and_drag_updates_hsv_value() -> None: 63 | # app = SaturationValuePickerApp() 64 | # async with app.run_test() as pilot: 65 | # saturation_value_picker = pilot.app.query_one(SaturationValuePicker) 66 | # await pilot.mouse_down(SaturationValuePicker, offset=(7, 4)) 67 | # await pilot.hover(SaturationValuePicker, offset=(17, 8)) 68 | # assert saturation_value_picker.hsv.s == 0.5 69 | # assert saturation_value_picker.hsv.v == 0.5 70 | 71 | 72 | async def test_changed_hsv_posts_message() -> None: 73 | app = SaturationValuePickerApp() 74 | async with app.run_test() as pilot: 75 | saturation_value_picker = pilot.app.query_one(SaturationValuePicker) 76 | expected_messages: list[str] = [] 77 | assert app.messages == expected_messages 78 | 79 | saturation_value_picker.hsv = HSV(0.0, 0.0, 0.0) 80 | await pilot.pause() 81 | expected_messages.append("Changed") 82 | assert app.messages == expected_messages 83 | -------------------------------------------------------------------------------- /tests/color_inputs/test_hex_input.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from textual.app import App, ComposeResult 3 | from textual.widgets import Input 4 | 5 | from textual_colorpicker.color_inputs import HexInput 6 | 7 | 8 | class HexInputApp(App): 9 | def __init__(self) -> None: 10 | super().__init__() 11 | self.messages: list[str] = [] 12 | 13 | def compose(self) -> ComposeResult: 14 | yield HexInput() 15 | 16 | def on_hex_input_changed(self, event: HexInput.Changed) -> None: 17 | self.messages.append(event.__class__.__name__) 18 | 19 | 20 | def test_invalid_hex_color_raises_exception() -> None: 21 | hex_input = HexInput() 22 | with pytest.raises(ValueError): 23 | hex_input.value = "INVALID" 24 | 25 | 26 | async def test_input_shows_lowercase_hex_without_prefix() -> None: 27 | app = HexInputApp() 28 | async with app.run_test() as pilot: 29 | hex_input = pilot.app.query_one(HexInput) 30 | input_widget = hex_input.query_one(Input) 31 | 32 | assert input_widget.value == "ff0000" 33 | 34 | 35 | async def test_changing_hex_value_updates_input() -> None: 36 | app = HexInputApp() 37 | async with app.run_test() as pilot: 38 | hex_input = pilot.app.query_one(HexInput) 39 | input_widget = hex_input.query_one(Input) 40 | 41 | hex_input.value = "#00FFFF" 42 | 43 | assert input_widget.value == "00ffff" 44 | 45 | 46 | async def test_updating_input_changes_hex_value() -> None: 47 | app = HexInputApp() 48 | async with app.run_test() as pilot: 49 | hex_input = pilot.app.query_one(HexInput) 50 | input_widget = hex_input.query_one(Input) 51 | 52 | # Test value is updated after input submitted 53 | input_widget.value = "c0c0c0" 54 | await input_widget.action_submit() 55 | await pilot.pause() 56 | assert hex_input.value == "#C0C0C0" 57 | 58 | # Test value is updated after input blurred 59 | input_widget.value = "a2a2a2" 60 | input_widget.blur() 61 | await pilot.pause() 62 | assert hex_input.value == "#A2A2A2" 63 | 64 | 65 | async def test_changed_hex_value_posts_message() -> None: 66 | app = HexInputApp() 67 | async with app.run_test() as pilot: 68 | hex_input = pilot.app.query_one(HexInput) 69 | expected_messages: list[str] = [] 70 | assert app.messages == expected_messages 71 | 72 | hex_input.value = "#00FF00" 73 | await pilot.pause() 74 | expected_messages.append("Changed") 75 | assert app.messages == expected_messages 76 | 77 | 78 | async def test_submitted_input_is_reset_if_invalid_hex() -> None: 79 | app = HexInputApp() 80 | async with app.run_test() as pilot: 81 | hex_input = pilot.app.query_one(HexInput) 82 | input_widget = hex_input.query_one(Input) 83 | expected_value = input_widget.value 84 | 85 | input_widget.value = "INVALID" 86 | await input_widget.action_submit() 87 | await pilot.pause() 88 | 89 | assert input_widget.value == expected_value 90 | 91 | 92 | async def test_submitted_input_strips_hash_prefix() -> None: 93 | app = HexInputApp() 94 | async with app.run_test() as pilot: 95 | hex_input = pilot.app.query_one(HexInput) 96 | input_widget = hex_input.query_one(Input) 97 | 98 | input_widget.value = "#ffff00" 99 | await input_widget.action_submit() 100 | await pilot.pause() 101 | 102 | assert input_widget.value == "ffff00" 103 | assert hex_input.value == "#FFFF00" 104 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # UV 98 | # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | #uv.lock 102 | 103 | # poetry 104 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 105 | # This is especially recommended for binary packages to ensure reproducibility, and is more 106 | # commonly ignored for libraries. 107 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 108 | #poetry.lock 109 | 110 | # pdm 111 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 112 | #pdm.lock 113 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 114 | # in version control. 115 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 116 | .pdm.toml 117 | .pdm-python 118 | .pdm-build/ 119 | 120 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 121 | __pypackages__/ 122 | 123 | # Celery stuff 124 | celerybeat-schedule 125 | celerybeat.pid 126 | 127 | # SageMath parsed files 128 | *.sage.py 129 | 130 | # Environments 131 | .env 132 | .venv 133 | env/ 134 | venv/ 135 | ENV/ 136 | env.bak/ 137 | venv.bak/ 138 | 139 | # Spyder project settings 140 | .spyderproject 141 | .spyproject 142 | 143 | # Rope project settings 144 | .ropeproject 145 | 146 | # mkdocs documentation 147 | /site 148 | 149 | # mypy 150 | .mypy_cache/ 151 | .dmypy.json 152 | dmypy.json 153 | 154 | # Pyre type checker 155 | .pyre/ 156 | 157 | # pytype static type analyzer 158 | .pytype/ 159 | 160 | # Cython debug symbols 161 | cython_debug/ 162 | 163 | # PyCharm 164 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 165 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 166 | # and can be added to the global gitignore or merged into this file. For a more nuclear 167 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 168 | #.idea/ 169 | 170 | # Ruff stuff: 171 | .ruff_cache/ 172 | 173 | # PyPI configuration file 174 | .pypirc 175 | 176 | # Sandbox for experimentation 177 | sandbox/ 178 | -------------------------------------------------------------------------------- /tests/color_inputs/test_rgb_inputs.py: -------------------------------------------------------------------------------- 1 | from textual.app import App, ComposeResult 2 | from textual.color import Color 3 | from textual.widgets import Input 4 | 5 | from textual_colorpicker.color_inputs import RgbInputs 6 | 7 | 8 | class RGBInputsApp(App): 9 | def __init__(self) -> None: 10 | super().__init__() 11 | self.messages: list[str] = [] 12 | 13 | def compose(self) -> ComposeResult: 14 | yield RgbInputs() 15 | 16 | def on_rgb_inputs_changed(self, event: RgbInputs.Changed) -> None: 17 | self.messages.append(event.__class__.__name__) 18 | 19 | 20 | def test_color_value_is_clamped() -> None: 21 | rgb_inputs = RgbInputs(Color(999, 999, 999)) 22 | assert rgb_inputs.color == Color(255, 255, 255) 23 | 24 | rgb_inputs.color = Color(-999, -999, -999) 25 | assert rgb_inputs.color == Color(0, 0, 0) 26 | 27 | 28 | async def test_changing_color_updates_all_inputs() -> None: 29 | app = RGBInputsApp() 30 | async with app.run_test() as pilot: 31 | rgb_inputs = pilot.app.query_one(RgbInputs) 32 | red_input = rgb_inputs.query_one(".--red-input", Input) 33 | green_input = rgb_inputs.query_one(".--green-input", Input) 34 | blue_input = rgb_inputs.query_one(".--blue-input", Input) 35 | 36 | rgb_inputs.color = Color(0, 255, 255) 37 | await pilot.pause() 38 | 39 | assert red_input.value == str(0) 40 | assert green_input.value == str(255) 41 | assert blue_input.value == str(255) 42 | 43 | 44 | async def test_updating_inputs_changes_color() -> None: 45 | app = RGBInputsApp() 46 | async with app.run_test() as pilot: 47 | rgb_inputs = pilot.app.query_one(RgbInputs) 48 | 49 | red_input = rgb_inputs.query_one(".--red-input", Input) 50 | red_input.focus() 51 | red_input.value = str(128) 52 | # Test color is updated after input submitted 53 | await red_input.action_submit() 54 | await pilot.pause() 55 | assert rgb_inputs.color == Color(128, 0, 0) 56 | 57 | green_input = rgb_inputs.query_one(".--green-input", Input) 58 | green_input.focus() 59 | green_input.value = str(128) 60 | # Test hsv is updated after input blurred 61 | green_input.blur() 62 | await pilot.pause() 63 | assert rgb_inputs.color == Color(128, 128, 0) 64 | 65 | blue_input = rgb_inputs.query_one(".--blue-input", Input) 66 | blue_input.value = str(128) 67 | await blue_input.action_submit() 68 | await pilot.pause() 69 | assert rgb_inputs.color == Color(128, 128, 128) 70 | 71 | 72 | async def test_changed_color_posts_message() -> None: 73 | app = RGBInputsApp() 74 | async with app.run_test() as pilot: 75 | rgb_inputs = pilot.app.query_one(RgbInputs) 76 | expected_messages: list[str] = [] 77 | assert app.messages == expected_messages 78 | 79 | rgb_inputs.color = Color(0, 255, 255) 80 | await pilot.pause() 81 | expected_messages.append("Changed") 82 | assert app.messages == expected_messages 83 | 84 | 85 | async def test_submitted_value_set_to_zero_if_not_a_number() -> None: 86 | app = RGBInputsApp() 87 | async with app.run_test() as pilot: 88 | rgb_inputs = pilot.app.query_one(RgbInputs) 89 | red_input = rgb_inputs.query_one(".--red-input", Input) 90 | 91 | red_input.value = "NOT A NUMBER" 92 | await red_input.action_submit() 93 | await pilot.pause() 94 | 95 | assert red_input.value == str(0) 96 | assert rgb_inputs.color == Color(0, 0, 0) 97 | 98 | 99 | async def test_submitted_value_rounded_if_float() -> None: 100 | app = RGBInputsApp() 101 | async with app.run_test() as pilot: 102 | rgb_inputs = pilot.app.query_one(RgbInputs) 103 | red_input = rgb_inputs.query_one(".--red-input", Input) 104 | 105 | red_input.value = str(127.5) 106 | await red_input.action_submit() 107 | await pilot.pause() 108 | 109 | assert red_input.value == str(128) 110 | assert rgb_inputs.color == Color(128, 0, 0) 111 | 112 | 113 | async def test_submitted_value_clamped_if_not_in_range() -> None: 114 | app = RGBInputsApp() 115 | async with app.run_test() as pilot: 116 | rgb_inputs = pilot.app.query_one(RgbInputs) 117 | red_input = rgb_inputs.query_one(".--red-input", Input) 118 | 119 | red_input.value = str(999) 120 | await red_input.action_submit() 121 | await pilot.pause() 122 | assert red_input.value == str(255) 123 | assert rgb_inputs.color == Color(255, 0, 0) 124 | 125 | red_input.value = str(-999) 126 | await red_input.action_submit() 127 | await pilot.pause() 128 | assert red_input.value == str(0) 129 | assert rgb_inputs.color == Color(0, 0, 0) 130 | -------------------------------------------------------------------------------- /src/textual_colorpicker/hue_picker.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | from rich.segment import Segment 4 | from rich.style import Style 5 | from textual import events 6 | from textual.color import BLACK, WHITE, Gradient 7 | from textual.geometry import clamp 8 | from textual.message import Message 9 | from textual.reactive import reactive 10 | from textual.strip import Strip 11 | from textual.widget import Widget 12 | 13 | _GRADIENT_COLORS = [ 14 | "#ff0000", 15 | "#ffff00", 16 | "#00ff00", 17 | "#00ffff", 18 | "#0000ff", 19 | "#ff00ff", 20 | "#ff0000", 21 | ] 22 | 23 | 24 | class HuePicker(Widget): 25 | """A hue picker widget.""" 26 | 27 | ALLOW_SELECT = False 28 | 29 | DEFAULT_CSS = """ 30 | HuePicker { 31 | height: 2; 32 | } 33 | """ 34 | 35 | _GRADIENT = Gradient.from_colors(*_GRADIENT_COLORS) 36 | 37 | hue: reactive[float] = reactive(0.0, init=False) 38 | """The currently selected hue value in the range 0 to 1.""" 39 | 40 | class Changed(Message): 41 | """Posted when the hue value changes. 42 | 43 | This message can be handled using an `on_hue_picker_changed` method. 44 | """ 45 | 46 | def __init__(self, hue_picker: HuePicker, hue: float) -> None: 47 | super().__init__() 48 | self.hue: float = hue 49 | self.hue_picker: HuePicker = hue_picker 50 | 51 | @property 52 | def control(self) -> HuePicker: 53 | return self.hue_picker 54 | 55 | def __init__( 56 | self, 57 | hue: float = 0.0, 58 | *, 59 | name: str | None = None, 60 | id: str | None = None, 61 | classes: str | None = None, 62 | disabled: bool = False, 63 | ) -> None: 64 | """Create a hue picker widget. 65 | 66 | Args: 67 | hue: The initial hue value in the range 0 to 1. 68 | name: The name of the widget. 69 | id: The ID of the widget in the DOM. 70 | classes: The CSS classes of the widget. 71 | disabled: Whether the widget is disabled or not. 72 | """ 73 | super().__init__(name=name, id=id, classes=classes, disabled=disabled) 74 | self.hue = hue 75 | self._grabbed = False 76 | 77 | def render_line(self, y: int) -> Strip: 78 | width = self.content_size.width 79 | 80 | get_color = self._GRADIENT.get_rich_color 81 | from_color = Style.from_color 82 | 83 | arrow_x = int(self.hue * (width - 1) + 0.5) 84 | arrow_icon, arrow_color = ("▼", BLACK) if y == 0 else ("▲", WHITE) 85 | 86 | segments = [ 87 | ( 88 | Segment( 89 | arrow_icon if x == arrow_x else " ", 90 | from_color( 91 | arrow_color.rich_color, 92 | get_color(x / (width - 1)), 93 | ), 94 | ) 95 | ) 96 | for x in range(width) 97 | ] 98 | 99 | return Strip(segments) 100 | 101 | def validate_hue(self, hue: float) -> float: 102 | return clamp(hue, 0.0, 1.0) 103 | 104 | def watch_hue(self) -> None: 105 | self.post_message(self.Changed(self, self.hue)) 106 | 107 | async def _on_mouse_down(self, event: events.MouseDown) -> None: 108 | mouse_offset = event.get_content_offset(self) 109 | if mouse_offset is None: 110 | return 111 | mouse_x_norm = mouse_offset.x / (self.content_size.width - 1) 112 | self.hue = mouse_x_norm 113 | 114 | # TODO: Enable click and drag for the hue picker. Unfortunately this causes 115 | # the app to lag and eventually freeze entirely when implemented in the 116 | # color picker widget. 117 | # 118 | # self._grabbed = True 119 | # self.capture_mouse(True) 120 | # 121 | # async def _on_mouse_move(self, event: events.MouseMove) -> None: 122 | # mouse_offset = event.get_content_offset(self) 123 | # if self._grabbed and mouse_offset is not None: 124 | # mouse_x_norm = mouse_offset.x / (self.content_size.width - 1) 125 | # self.hue = mouse_x_norm 126 | # 127 | # async def _on_mouse_up(self, event: events.MouseUp) -> None: 128 | # if self._grabbed: 129 | # self._grabbed = False 130 | # self.release_mouse() 131 | 132 | 133 | if __name__ == "__main__": 134 | from textual.app import App, ComposeResult 135 | 136 | class HuePickerApp(App): 137 | CSS = """ 138 | Screen { 139 | align: center middle; 140 | } 141 | 142 | HuePicker { 143 | width: 80%; 144 | } 145 | """ 146 | 147 | def compose(self) -> ComposeResult: 148 | yield HuePicker() 149 | 150 | app = HuePickerApp() 151 | app.run() 152 | -------------------------------------------------------------------------------- /src/textual_colorpicker/color_picker.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | from textual.app import ComposeResult 4 | from textual.color import HSV, Color 5 | from textual.containers import VerticalGroup 6 | from textual.message import Message 7 | from textual.reactive import var 8 | from textual.widget import Widget 9 | 10 | from textual_colorpicker.color_inputs import ColorInputs, HexInput, HsvInputs, RgbInputs 11 | from textual_colorpicker.color_preview import ColorPreview 12 | from textual_colorpicker.hue_picker import HuePicker 13 | from textual_colorpicker.saturation_value_picker import SaturationValuePicker 14 | 15 | 16 | class ColorPicker(Widget): 17 | """A color picker widget.""" 18 | 19 | DEFAULT_CSS = """ 20 | ColorPicker { 21 | width: auto; 22 | height: auto; 23 | layout: horizontal; 24 | 25 | VerticalGroup { 26 | width: auto; 27 | } 28 | 29 | SaturationValuePicker { 30 | height: 17; 31 | } 32 | 33 | HuePicker { 34 | width: 37; 35 | margin-top: 1; 36 | } 37 | 38 | ColorPreview { 39 | height: 6; 40 | margin-bottom: 1; 41 | margin-left: 2; 42 | } 43 | 44 | ColorInputs { 45 | margin-left: 2; 46 | } 47 | } 48 | """ 49 | 50 | color: var[Color] = var(Color(255, 0, 0), init=False) 51 | """The current color value.""" 52 | 53 | _hsv: var[HSV] = var(HSV(0.0, 1.0, 1.0), init=False) 54 | """The current HSV color value.""" 55 | 56 | class Changed(Message): 57 | """Posted when the color value changes. 58 | 59 | This message can be handled using an `on_color_picker_changed` method. 60 | """ 61 | 62 | def __init__(self, color_picker: ColorPicker, color: Color) -> None: 63 | super().__init__() 64 | self.color: Color = color 65 | self.color_picker = color_picker 66 | 67 | @property 68 | def control(self) -> ColorPicker: 69 | return self.color_picker 70 | 71 | def __init__( 72 | self, 73 | color: Color = Color(255, 0, 0), 74 | *, 75 | name: str | None = None, 76 | id: str | None = None, 77 | classes: str | None = None, 78 | disabled: bool = False, 79 | ) -> None: 80 | """Create a color picker widget. 81 | 82 | Args: 83 | color: The initial color value. 84 | name: The name of the widget. 85 | id: The ID of the widget in the DOM. 86 | classes: The CSS classes of the widget. 87 | disabled: Whether the widget is disabled or not. 88 | """ 89 | super().__init__(name=name, id=id, classes=classes, disabled=disabled) 90 | color = color.clamped 91 | self.color = color 92 | self._hsv = color.hsv 93 | 94 | def compose(self) -> ComposeResult: 95 | hsv = self._hsv 96 | with VerticalGroup(): 97 | yield SaturationValuePicker(hsv) 98 | yield HuePicker(hsv.h) 99 | with VerticalGroup(): 100 | yield ColorPreview(self.color) 101 | yield ColorInputs(self.color) 102 | 103 | def validate_color(self, color: Color) -> Color: 104 | return color.clamped 105 | 106 | def watch_color(self) -> None: 107 | hsv = self.color.hsv 108 | self.set_reactive(ColorPicker._hsv, hsv) 109 | 110 | self._update_all_from_color_and_hsv() 111 | 112 | self.post_message(self.Changed(self, self.color)) 113 | 114 | def _watch__hsv(self) -> None: 115 | old_color = self.color 116 | new_color = Color.from_hsv(*self._hsv) 117 | self.set_reactive(ColorPicker.color, new_color) 118 | 119 | self._update_all_from_color_and_hsv() 120 | 121 | if new_color != old_color: 122 | self.post_message(self.Changed(self, self.color)) 123 | 124 | def _update_all_from_color_and_hsv(self) -> None: 125 | if not self.is_mounted: 126 | return 127 | color = self.color 128 | self.query_one(ColorPreview).color = color 129 | self.query_one(RgbInputs).color = color 130 | self.query_one(HexInput).value = color.hex 131 | 132 | hsv = self._hsv 133 | self.query_one(HuePicker).hue = hsv.h 134 | self.query_one(SaturationValuePicker).hsv = hsv 135 | self.query_one(HsvInputs).hsv = hsv 136 | 137 | def _on_hue_picker_changed(self, event: HuePicker.Changed) -> None: 138 | event.stop() 139 | h = event.hue 140 | _, s, v = self._hsv 141 | self._hsv = HSV(h, s, v) 142 | 143 | def _on_saturation_value_picker_changed( 144 | self, event: SaturationValuePicker.Changed 145 | ) -> None: 146 | event.stop() 147 | h, _, _ = self._hsv 148 | _, s, v = event.hsv 149 | self._hsv = HSV(h, s, v) 150 | 151 | def _on_rgb_inputs_changed(self, event: RgbInputs.Changed) -> None: 152 | event.stop() 153 | self.color = event.color 154 | 155 | def _on_hsv_inputs_changed(self, event: HsvInputs.Changed) -> None: 156 | event.stop() 157 | self._hsv = event.hsv 158 | 159 | def _on_hex_input_changed(self, event: HexInput.Changed) -> None: 160 | event.stop() 161 | color = Color.parse(event.value) 162 | self.color = color 163 | 164 | 165 | if __name__ == "__main__": 166 | from textual.app import App 167 | 168 | class ColorPickerApp(App): 169 | CSS = """ 170 | Screen { 171 | align: center middle; 172 | } 173 | """ 174 | 175 | def compose(self) -> ComposeResult: 176 | yield ColorPicker() 177 | 178 | app = ColorPickerApp() 179 | app.run() 180 | -------------------------------------------------------------------------------- /src/textual_colorpicker/saturation_value_picker.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | from rich.segment import Segment 4 | from rich.style import Style 5 | from textual import events 6 | from textual.color import HSV, WHITE, Color 7 | from textual.geometry import clamp 8 | from textual.message import Message 9 | from textual.reactive import reactive 10 | from textual.strip import Strip 11 | from textual.widget import Widget 12 | 13 | 14 | class SaturationValuePicker(Widget): 15 | """A two-dimensional saturation/value picker widget.""" 16 | 17 | ALLOW_SELECT = False 18 | 19 | hsv = reactive(HSV(0.0, 1.0, 1.0), init=False) 20 | """The currently selected HSV (Hue, Saturation, Value) values in the range 0 to 1.""" 21 | 22 | class Changed(Message): 23 | """Posted when the HSV (Hue, Saturation, Value) value changes. 24 | 25 | This message can be handled using an `on_saturation_value_picker_changed` method. 26 | """ 27 | 28 | def __init__( 29 | self, saturation_value_picker: SaturationValuePicker, hsv: HSV 30 | ) -> None: 31 | super().__init__() 32 | self.hsv: HSV = hsv 33 | self.satuation_value_picker: SaturationValuePicker = saturation_value_picker 34 | 35 | @property 36 | def control(self) -> SaturationValuePicker: 37 | return self.satuation_value_picker 38 | 39 | def __init__( 40 | self, 41 | hsv: HSV = HSV(0.0, 1.0, 1.0), 42 | *, 43 | name: str | None = None, 44 | id: str | None = None, 45 | classes: str | None = None, 46 | disabled: bool = False, 47 | ) -> None: 48 | """Create a saturation/value picker widget. 49 | 50 | Args: 51 | hsv: The initial HSV (Hue, Saturation, Value) values in the range 0 to 1. 52 | name: The name of the widget. 53 | id: The ID of the widget in the DOM. 54 | classes: The CSS classes of the widget. 55 | disabled: Whether the widget is disabled or not. 56 | """ 57 | super().__init__(name=name, id=id, classes=classes, disabled=disabled) 58 | self.hsv = hsv 59 | self._grabbed = False 60 | 61 | def render_line(self, y: int) -> Strip: 62 | width = self.content_size.width 63 | height = self.content_size.height 64 | 65 | from_color = Style.from_color 66 | 67 | hue = self.hsv.h 68 | value = 1 - (y / (height - 1)) 69 | 70 | pointer_y = int((1 - self.hsv.v) * (height - 1) + 0.5) 71 | pointer_x = int(self.hsv.s * (width - 1) + 0.5) 72 | 73 | segments: list[Segment] = [] 74 | for x in range(width): 75 | saturation = x / (width - 1) 76 | style = from_color( 77 | WHITE.rich_color, 78 | Color.from_hsv(hue, saturation, value).rich_color, 79 | ) 80 | 81 | if (y, x) == (pointer_y, pointer_x): 82 | char = "╬" 83 | elif y == pointer_y: 84 | char = "═" 85 | elif x == pointer_x: 86 | char = "║" 87 | else: 88 | char = " " 89 | 90 | segments.append(Segment(char, style)) 91 | 92 | return Strip(segments) 93 | 94 | def validate_hsv(self, hsv: HSV) -> HSV: 95 | h, s, v = hsv 96 | 97 | clamped_hsv = HSV( 98 | clamp(h, 0.0, 1.0), 99 | clamp(s, 0.0, 1.0), 100 | clamp(v, 0.0, 1.0), 101 | ) 102 | 103 | return clamped_hsv 104 | 105 | def watch_hsv(self) -> None: 106 | self.post_message(self.Changed(self, self.hsv)) 107 | 108 | async def _on_mouse_down(self, event: events.MouseDown) -> None: 109 | mouse_offset = event.get_content_offset(self) 110 | if mouse_offset is None: 111 | return 112 | width = self.content_size.width 113 | height = self.content_size.height 114 | mouse_y_norm = mouse_offset.y / (height - 1) 115 | mouse_x_norm = mouse_offset.x / (width - 1) 116 | 117 | hue = self.hsv.h 118 | saturation = mouse_x_norm 119 | value = 1 - mouse_y_norm 120 | self.hsv = HSV(hue, saturation, value) 121 | 122 | # TODO: Enable click and drag for the saturation/value picker. Unfortunately 123 | # this causes the app to lag and eventually freeze entirely when implemented 124 | # in the color picker widget. 125 | # 126 | # self._grabbed = True 127 | # self.capture_mouse(True) 128 | # 129 | # async def _on_mouse_move(self, event: events.MouseMove) -> None: 130 | # mouse_offset = event.get_content_offset(self) 131 | # if self._grabbed and mouse_offset is not None: 132 | # width = self.content_size.width 133 | # height = self.content_size.height 134 | # mouse_y_norm = mouse_offset.y / (height - 1) 135 | # mouse_x_norm = mouse_offset.x / (width - 1) 136 | # 137 | # hue = self.hsv.h 138 | # saturation = mouse_x_norm 139 | # value = 1 - mouse_y_norm 140 | # self.hsv = HSV(hue, saturation, value) 141 | # 142 | # async def _on_mouse_up(self, event: events.MouseUp) -> None: 143 | # if self._grabbed: 144 | # self._grabbed = False 145 | # self.release_mouse() 146 | 147 | 148 | if __name__ == "__main__": 149 | from textual.app import App, ComposeResult 150 | 151 | class SaturationValuePickerApp(App): 152 | CSS = """ 153 | Screen { 154 | align: center middle; 155 | } 156 | 157 | SaturationValuePicker { 158 | width: 80%; 159 | height: 80%; 160 | } 161 | """ 162 | 163 | def compose(self) -> ComposeResult: 164 | yield SaturationValuePicker() 165 | 166 | app = SaturationValuePickerApp() 167 | app.run() 168 | -------------------------------------------------------------------------------- /tests/color_inputs/test_hsv_inputs.py: -------------------------------------------------------------------------------- 1 | from textual.app import App, ComposeResult 2 | from textual.color import HSV, Color 3 | from textual.widgets import Input 4 | 5 | from textual_colorpicker.color_inputs import HsvInputs 6 | 7 | 8 | class HSVInputsApp(App): 9 | def __init__(self) -> None: 10 | super().__init__() 11 | self.messages: list[str] = [] 12 | 13 | def compose(self) -> ComposeResult: 14 | yield HsvInputs() 15 | 16 | def on_hsv_inputs_changed(self, event: HsvInputs.Changed) -> None: 17 | self.messages.append(event.__class__.__name__) 18 | 19 | 20 | def test_hsv_value_is_clamped() -> None: 21 | hsv_inputs = HsvInputs(HSV(99.0, 99.0, 99.0)) 22 | assert hsv_inputs.hsv == HSV(1.0, 1.0, 1.0) 23 | 24 | hsv_inputs.hsv = HSV(-99.0, -99.0, -99.0) 25 | assert hsv_inputs.hsv == HSV(0.0, 0.0, 0.0) 26 | 27 | 28 | async def test_inputs_show_scaled_hsv_values() -> None: 29 | app = HSVInputsApp() 30 | async with app.run_test() as pilot: 31 | hsv_inputs = pilot.app.query_one(HsvInputs) 32 | hue_input = hsv_inputs.query_one(".--hue-input", Input) 33 | saturation_input = hsv_inputs.query_one(".--saturation-input", Input) 34 | value_input = hsv_inputs.query_one(".--value-input", Input) 35 | 36 | assert hue_input.value == str(0) 37 | assert saturation_input.value == str(100) 38 | assert value_input.value == str(100) 39 | 40 | 41 | async def test_changing_hsv_updates_all_inputs() -> None: 42 | app = HSVInputsApp() 43 | async with app.run_test() as pilot: 44 | hsv_inputs = pilot.app.query_one(HsvInputs) 45 | hue_input = hsv_inputs.query_one(".--hue-input", Input) 46 | saturation_input = hsv_inputs.query_one(".--saturation-input", Input) 47 | value_input = hsv_inputs.query_one(".--value-input", Input) 48 | 49 | hsv_inputs.hsv = HSV(0.1, 0.1, 0.1) 50 | await pilot.pause() 51 | 52 | assert hue_input.value == str(36) 53 | assert saturation_input.value == str(10) 54 | assert value_input.value == str(10) 55 | 56 | 57 | async def test_updating_inputs_changes_hsv() -> None: 58 | app = HSVInputsApp() 59 | async with app.run_test() as pilot: 60 | hsv_inputs = pilot.app.query_one(HsvInputs) 61 | 62 | hue_input = hsv_inputs.query_one(".--hue-input", Input) 63 | hue_input.focus() 64 | hue_input.value = str(36) 65 | # Test hsv is updated after input submitted 66 | await hue_input.action_submit() 67 | await pilot.pause() 68 | assert hsv_inputs.hsv == HSV(0.1, 1.0, 1.0) 69 | 70 | saturation_input = hsv_inputs.query_one(".--saturation-input", Input) 71 | saturation_input.focus() 72 | saturation_input.value = str(10) 73 | # Test hsv is updated after input blurred 74 | saturation_input.blur() 75 | await pilot.pause() 76 | assert hsv_inputs.hsv == HSV(0.1, 0.1, 1.0) 77 | 78 | value_input = hsv_inputs.query_one(".--value-input", Input) 79 | value_input.value = str(10) 80 | await value_input.action_submit() 81 | await pilot.pause() 82 | assert hsv_inputs.hsv == HSV(0.1, 0.1, 0.1) 83 | 84 | 85 | async def test_changed_hsv_posts_message() -> None: 86 | app = HSVInputsApp() 87 | async with app.run_test() as pilot: 88 | hsv_inputs = pilot.app.query_one(HsvInputs) 89 | expected_messages: list[str] = [] 90 | assert app.messages == expected_messages 91 | 92 | hsv_inputs.hsv = HSV(0.1, 0.1, 0.1) 93 | await pilot.pause() 94 | expected_messages.append("Changed") 95 | assert app.messages == expected_messages 96 | 97 | 98 | async def test_submitted_value_set_to_zero_if_not_a_number() -> None: 99 | app = HSVInputsApp() 100 | async with app.run_test() as pilot: 101 | hsv_inputs = pilot.app.query_one(HsvInputs) 102 | saturation_input = hsv_inputs.query_one(".--saturation-input", Input) 103 | 104 | saturation_input.value = "NOT A NUMBER" 105 | await saturation_input.action_submit() 106 | await pilot.pause() 107 | 108 | assert saturation_input.value == str(0) 109 | assert hsv_inputs.hsv == HSV(0.0, 0.0, 1.0) 110 | 111 | 112 | async def test_submitted_value_rounded_if_float() -> None: 113 | app = HSVInputsApp() 114 | async with app.run_test() as pilot: 115 | hsv_inputs = pilot.app.query_one(HsvInputs) 116 | value_input = hsv_inputs.query_one(".--value-input", Input) 117 | 118 | value_input.value = str(50.2) 119 | await value_input.action_submit() 120 | await pilot.pause() 121 | 122 | assert value_input.value == str(50) 123 | assert hsv_inputs.hsv == HSV(0.0, 1.0, 0.5) 124 | 125 | 126 | async def test_submitted_value_clamped_if_not_in_range() -> None: 127 | app = HSVInputsApp() 128 | async with app.run_test() as pilot: 129 | hsv_inputs = pilot.app.query_one(HsvInputs) 130 | saturation_input = hsv_inputs.query_one(".--saturation-input", Input) 131 | 132 | saturation_input.value = str(999) 133 | await saturation_input.action_submit() 134 | await pilot.pause() 135 | assert saturation_input.value == str(100) 136 | assert hsv_inputs.hsv == HSV(0.0, 1.0, 1.0) 137 | 138 | saturation_input.value = str(-999) 139 | await saturation_input.action_submit() 140 | await pilot.pause() 141 | assert saturation_input.value == str(0) 142 | assert hsv_inputs.hsv == HSV(0.0, 0.0, 1.0) 143 | 144 | 145 | async def test_hsv_updated_only_when_input_changed() -> None: 146 | """Test that the HSV is only updated when the input value has changed. 147 | This prevents unwanted updates from the scaled integer values. 148 | """ 149 | app = HSVInputsApp() 150 | async with app.run_test() as pilot: 151 | hsv_inputs = pilot.app.query_one(HsvInputs) 152 | hsv = Color(255, 78, 78).hsv 153 | hsv_inputs.hsv = hsv 154 | 155 | hue_input = hsv_inputs.query_one(".--hue-input", Input) 156 | await hue_input.action_submit() 157 | await pilot.pause() 158 | 159 | assert hsv_inputs.hsv == hsv # No change 160 | -------------------------------------------------------------------------------- /tests/test_color_picker.py: -------------------------------------------------------------------------------- 1 | from textual.app import App, ComposeResult 2 | from textual.color import HSV, Color 3 | 4 | from textual_colorpicker.color_inputs import HexInput, HsvInputs, RgbInputs 5 | from textual_colorpicker.color_picker import ColorPicker 6 | from textual_colorpicker.color_preview import ColorPreview 7 | from textual_colorpicker.hue_picker import HuePicker 8 | from textual_colorpicker.saturation_value_picker import SaturationValuePicker 9 | 10 | 11 | class ColorPickerApp(App): 12 | def __init__(self) -> None: 13 | super().__init__() 14 | self.messages: list[str] = [] 15 | 16 | def compose(self) -> ComposeResult: 17 | yield ColorPicker() 18 | 19 | def on_color_picker_changed(self, event: HuePicker.Changed) -> None: 20 | self.messages.append(event.__class__.__name__) 21 | 22 | 23 | def test_color_value_is_clamped() -> None: 24 | color_picker = ColorPicker(Color(999, 999, 999)) 25 | assert color_picker.color == Color(255, 255, 255) 26 | 27 | color_picker.color = Color(-999, -999, -999) 28 | assert color_picker.color == Color(0, 0, 0) 29 | 30 | 31 | async def test_changing_color_updates_all_widgets() -> None: 32 | app = ColorPickerApp() 33 | async with app.run_test() as pilot: 34 | color_picker = pilot.app.query_one(ColorPicker) 35 | 36 | color_picker.color = Color(0, 255, 255) 37 | await pilot.pause() 38 | expected_color = Color(0, 255, 255) 39 | expected_hsv = HSV(0.5, 1.0, 1.0) 40 | 41 | color_preview = pilot.app.query_one(ColorPreview) 42 | assert color_preview.color == expected_color 43 | 44 | hue_picker = pilot.app.query_one(HuePicker) 45 | saturation_value_picker = pilot.app.query_one(SaturationValuePicker) 46 | assert hue_picker.hue == expected_hsv.h 47 | assert saturation_value_picker.hsv == expected_hsv 48 | 49 | rgb_inputs = pilot.app.query_one(RgbInputs) 50 | hsv_inputs = pilot.app.query_one(HsvInputs) 51 | hex_input = pilot.app.query_one(HexInput) 52 | assert rgb_inputs.color == expected_color 53 | assert hsv_inputs.hsv == expected_hsv 54 | assert hex_input.value == expected_color.hex 55 | 56 | 57 | async def test_changing_hsv_updates_all_widgets() -> None: 58 | app = ColorPickerApp() 59 | async with app.run_test() as pilot: 60 | color_picker = pilot.app.query_one(ColorPicker) 61 | 62 | color_picker._hsv = HSV(0.5, 1.0, 1.0) 63 | await pilot.pause() 64 | expected_color = Color(0, 255, 255) 65 | expected_hsv = HSV(0.5, 1.0, 1.0) 66 | 67 | color_preview = pilot.app.query_one(ColorPreview) 68 | assert color_preview.color == expected_color 69 | 70 | hue_picker = pilot.app.query_one(HuePicker) 71 | saturation_value_picker = pilot.app.query_one(SaturationValuePicker) 72 | assert hue_picker.hue == expected_hsv.h 73 | assert saturation_value_picker.hsv == expected_hsv 74 | 75 | rgb_inputs = pilot.app.query_one(RgbInputs) 76 | hsv_inputs = pilot.app.query_one(HsvInputs) 77 | hex_input = pilot.app.query_one(HexInput) 78 | assert rgb_inputs.color == expected_color 79 | assert hsv_inputs.hsv == expected_hsv 80 | assert hex_input.value == expected_color.hex 81 | 82 | 83 | async def test_updating_hue_picker_changes_color() -> None: 84 | app = ColorPickerApp() 85 | async with app.run_test() as pilot: 86 | color_picker = pilot.app.query_one(ColorPicker) 87 | hue_picker = pilot.app.query_one(HuePicker) 88 | 89 | hue_picker.hue = 0.5 90 | await pilot.pause() 91 | 92 | assert color_picker.color == Color(0, 255, 255) 93 | 94 | 95 | async def test_updating_saturation_value_picker_changes_color() -> None: 96 | app = ColorPickerApp() 97 | async with app.run_test() as pilot: 98 | color_picker = pilot.app.query_one(ColorPicker) 99 | saturation_value_picker = pilot.app.query_one(SaturationValuePicker) 100 | 101 | saturation_value_picker.hsv = HSV(0.0, 0.0, 1.0) 102 | await pilot.pause() 103 | 104 | assert color_picker.color == Color(255, 255, 255) 105 | 106 | 107 | async def test_updating_rgb_inputs_changes_color() -> None: 108 | app = ColorPickerApp() 109 | async with app.run_test() as pilot: 110 | color_picker = pilot.app.query_one(ColorPicker) 111 | rgb_inputs = pilot.app.query_one(RgbInputs) 112 | 113 | rgb_inputs.color = Color(0, 255, 255) 114 | await pilot.pause() 115 | 116 | assert color_picker.color == Color(0, 255, 255) 117 | 118 | 119 | async def test_updating_hsv_inputs_changes_color() -> None: 120 | app = ColorPickerApp() 121 | async with app.run_test() as pilot: 122 | color_picker = pilot.app.query_one(ColorPicker) 123 | hsv_inputs = pilot.app.query_one(HsvInputs) 124 | 125 | hsv_inputs.hsv = HSV(0.5, 1.0, 1.0) 126 | await pilot.pause() 127 | 128 | assert color_picker.color == Color(0, 255, 255) 129 | 130 | 131 | async def test_updating_hex_input_changes_color() -> None: 132 | app = ColorPickerApp() 133 | async with app.run_test() as pilot: 134 | color_picker = pilot.app.query_one(ColorPicker) 135 | hex_input = pilot.app.query_one(HexInput) 136 | 137 | hex_input.value = "#00FFFF" 138 | await pilot.pause() 139 | 140 | assert color_picker.color == Color(0, 255, 255) 141 | 142 | 143 | async def test_changed_color_posts_message() -> None: 144 | app = ColorPickerApp() 145 | async with app.run_test() as pilot: 146 | color_picker = pilot.app.query_one(ColorPicker) 147 | expected_messages: list[str] = [] 148 | assert app.messages == expected_messages 149 | 150 | color_picker.color = Color(0, 0, 0) 151 | await pilot.pause() 152 | expected_messages.append("Changed") 153 | assert app.messages == expected_messages 154 | 155 | color_picker._hsv = HSV(1.0, 1.0, 0.0) # Black 156 | await pilot.pause() 157 | # The RGB has not changed so no message should have been posted 158 | assert color_picker.color == Color(0, 0, 0) 159 | assert app.messages == expected_messages 160 | -------------------------------------------------------------------------------- /src/textual_colorpicker/color_inputs.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | import re 4 | 5 | from textual import on 6 | from textual.app import ComposeResult 7 | from textual.color import HSV, Color 8 | from textual.containers import HorizontalGroup 9 | from textual.geometry import clamp 10 | from textual.message import Message 11 | from textual.reactive import var 12 | from textual.validation import Integer, Regex 13 | from textual.widget import Widget 14 | from textual.widgets import Input, Label 15 | 16 | 17 | class RgbInputs(Widget): 18 | """An RGB inputs widget that combines fields for Red, Green and Blue values.""" 19 | 20 | DEFAULT_CSS = """ 21 | RgbInputs { 22 | width: auto; 23 | height: auto; 24 | 25 | HorizontalGroup { 26 | width: auto; 27 | } 28 | 29 | Label { 30 | padding: 1 0; 31 | } 32 | 33 | Input { 34 | width: 10; 35 | } 36 | } 37 | """ 38 | 39 | color: var[Color] = var(Color(255, 0, 0), init=False) 40 | """The current color value.""" 41 | 42 | class Changed(Message): 43 | """Posted when the color value changes. 44 | 45 | This message can be handled using an `on_rgb_inputs_changed` method. 46 | """ 47 | 48 | def __init__(self, rgb_inputs: RgbInputs, color: Color) -> None: 49 | super().__init__() 50 | self.color: Color = color 51 | self.rgb_inputs: RgbInputs = rgb_inputs 52 | 53 | @property 54 | def control(self) -> RgbInputs: 55 | return self.rgb_inputs 56 | 57 | def __init__( 58 | self, 59 | color: Color = Color(255, 0, 0), 60 | *, 61 | name: str | None = None, 62 | id: str | None = None, 63 | classes: str | None = None, 64 | disabled: bool = False, 65 | ) -> None: 66 | """Create an RGB inputs widget. 67 | 68 | Args: 69 | color: The initial color value. 70 | name: The name of the widget. 71 | id: The ID of the widget in the DOM. 72 | classes: The CSS classes of the widget. 73 | disabled: Whether the widget is disabled or not. 74 | """ 75 | super().__init__(name=name, id=id, classes=classes, disabled=disabled) 76 | self.color = color 77 | 78 | def compose(self) -> ComposeResult: 79 | r, g, b = self.color.rgb 80 | with HorizontalGroup(): 81 | yield Label("R:") 82 | yield Input( 83 | str(r), 84 | validators=Integer(0, 255), 85 | classes="--red-input", 86 | ) 87 | with HorizontalGroup(): 88 | yield Label("G:") 89 | yield Input( 90 | str(g), 91 | validators=Integer(0, 255), 92 | classes="--green-input", 93 | ) 94 | with HorizontalGroup(): 95 | yield Label("B:") 96 | yield Input( 97 | str(b), 98 | validators=Integer(0, 255), 99 | classes="--blue-input", 100 | ) 101 | 102 | def validate_color(self, color: Color) -> Color: 103 | return color.clamped 104 | 105 | def watch_color(self) -> None: 106 | self._update_all_from_color() 107 | 108 | self.post_message(self.Changed(self, self.color)) 109 | 110 | def _update_all_from_color(self) -> None: 111 | if not self.is_mounted: 112 | return 113 | red_input = self.query_one(".--red-input", Input) 114 | green_input = self.query_one(".--green-input", Input) 115 | blue_input = self.query_one(".--blue-input", Input) 116 | 117 | r, g, b = self.color.rgb 118 | 119 | red_input.value = str(r) 120 | green_input.value = str(g) 121 | blue_input.value = str(b) 122 | 123 | @on(Input.Blurred) 124 | @on(Input.Submitted) 125 | def _on_input_blurred_or_submitted( 126 | self, event: Input.Blurred | Input.Submitted 127 | ) -> None: 128 | event.stop() 129 | validation_result = event.validation_result 130 | assert validation_result is not None 131 | if not validation_result.is_valid: 132 | failure = validation_result.failures[0] 133 | # If the value is not a number, set the input to zero. 134 | if isinstance(failure, Integer.NotANumber): 135 | event.input.value = str(0) 136 | # If the value is not in range, set the input to the clamped value. 137 | # NOTE: The value may also be a float, so we convert it as necessary. 138 | elif isinstance(failure, Integer.NotInRange): 139 | clamped_value = clamp(float(event.value), 0, 255) 140 | event.input.value = str(int(clamped_value)) 141 | # If the value is a float, round to the nearest integer. 142 | elif isinstance(failure, Integer.NotAnInteger): 143 | rounded_value = int(float(event.value) + 0.5) 144 | event.input.value = str(rounded_value) 145 | 146 | r = int(self.query_one(".--red-input", Input).value) 147 | g = int(self.query_one(".--green-input", Input).value) 148 | b = int(self.query_one(".--blue-input", Input).value) 149 | color = Color(r, g, b) 150 | 151 | self.color = color 152 | 153 | @on(Input.Changed) 154 | def _on_input_changed(self, event: Input.Changed) -> None: 155 | event.stop() 156 | 157 | 158 | class HsvInputs(Widget): 159 | """An HSV inputs widget that combines fields for Hue, Saturation and Value values.""" 160 | 161 | DEFAULT_CSS = """ 162 | HsvInputs { 163 | width: auto; 164 | height: auto; 165 | 166 | HorizontalGroup { 167 | width: auto; 168 | } 169 | 170 | Label { 171 | padding: 1 0; 172 | } 173 | 174 | Input { 175 | width: 10; 176 | } 177 | } 178 | """ 179 | 180 | hsv: var[HSV] = var(HSV(0.0, 1.0, 1.0), init=False) 181 | """The current HSV (Hue, Saturation, Value) values in the range 0 to 1.""" 182 | 183 | class Changed(Message): 184 | """Posted when the HSV (Hue, Saturation, Value) value changes. 185 | 186 | This message can be handled using an `on_hsv_inputs_changed` method. 187 | """ 188 | 189 | def __init__(self, hsv_inputs: HsvInputs, hsv: HSV) -> None: 190 | super().__init__() 191 | self.hsv: HSV = hsv 192 | self.hsv_inputs: HsvInputs = hsv_inputs 193 | 194 | @property 195 | def control(self) -> HsvInputs: 196 | return self.hsv_inputs 197 | 198 | def __init__( 199 | self, 200 | hsv: HSV = HSV(0.0, 1.0, 1.0), 201 | *, 202 | name: str | None = None, 203 | id: str | None = None, 204 | classes: str | None = None, 205 | disabled: bool = False, 206 | ) -> None: 207 | """Create an HSV inputs widget. 208 | 209 | Args: 210 | hsv: The initial HSV (Hue, Saturation, Value) values in the range 0 to 1. 211 | name: The name of the widget. 212 | id: The ID of the widget in the DOM. 213 | classes: The CSS classes of the widget. 214 | disabled: Whether the widget is disabled or not. 215 | """ 216 | super().__init__(name=name, id=id, classes=classes, disabled=disabled) 217 | hsv = self.validate_hsv(hsv) 218 | self.hsv = hsv 219 | self._hsv_scaled_integers = self._get_hsv_scaled_integers(hsv) 220 | 221 | def compose(self) -> ComposeResult: 222 | h, s, v = self._hsv_scaled_integers 223 | with HorizontalGroup(): 224 | yield Label("H:") 225 | yield Input( 226 | str(h), 227 | validators=Integer(0, 360), 228 | classes="--hue-input", 229 | ) 230 | with HorizontalGroup(): 231 | yield Label("S:") 232 | yield Input( 233 | str(s), 234 | validators=Integer(0, 100), 235 | classes="--saturation-input", 236 | ) 237 | with HorizontalGroup(): 238 | yield Label("V:") 239 | yield Input( 240 | str(v), 241 | validators=Integer(0, 100), 242 | classes="--value-input", 243 | ) 244 | 245 | def validate_hsv(self, hsv: HSV) -> HSV: 246 | h, s, v = hsv 247 | clamped_hsv = HSV( 248 | clamp(h, 0.0, 1.0), 249 | clamp(s, 0.0, 1.0), 250 | clamp(v, 0.0, 1.0), 251 | ) 252 | 253 | return clamped_hsv 254 | 255 | def watch_hsv(self) -> None: 256 | self._update_all_from_hsv() 257 | 258 | self.post_message(self.Changed(self, self.hsv)) 259 | 260 | def _get_hsv_scaled_integers(self, hsv: HSV) -> tuple[int, int, int]: 261 | h = int(hsv.h * 360 + 0.5) 262 | s = int(hsv.s * 100 + 0.5) 263 | v = int(hsv.v * 100 + 0.5) 264 | 265 | return h, s, v 266 | 267 | def _update_all_from_hsv(self) -> None: 268 | self._hsv_scaled_integers = self._get_hsv_scaled_integers(self.hsv) 269 | 270 | if not self.is_mounted: 271 | return 272 | hue_input = self.query_one(".--hue-input", Input) 273 | saturation_input = self.query_one(".--saturation-input", Input) 274 | value_input = self.query_one(".--value-input", Input) 275 | 276 | h, s, v = self._hsv_scaled_integers 277 | 278 | hue_input.value = str(h) 279 | saturation_input.value = str(s) 280 | value_input.value = str(v) 281 | 282 | @on(Input.Blurred) 283 | @on(Input.Submitted) 284 | def _on_input_blurred_or_submitted( 285 | self, event: Input.Blurred | Input.Submitted 286 | ) -> None: 287 | event.stop() 288 | input_corrected = False 289 | validation_result = event.validation_result 290 | assert validation_result is not None 291 | if not validation_result.is_valid: 292 | failure = validation_result.failures[0] 293 | # If the value is not a number, set the input to zero. 294 | if isinstance(failure, Integer.NotANumber): 295 | event.input.value = str(0) 296 | # If the value is not in range, set the input to the clamped value. 297 | # NOTE: The value may also be a float, so we convert it as necessary. 298 | elif isinstance(failure, Integer.NotInRange): 299 | max = 360 if event.input.has_class(".--hue-input") else 100 300 | clamped_value = clamp(float(event.value), 0, max) 301 | event.input.value = str(int(clamped_value)) 302 | # If the value is a float, round to the nearest integer. 303 | elif isinstance(failure, Integer.NotAnInteger): 304 | rounded_value = int(float(event.value) + 0.5) 305 | event.input.value = str(rounded_value) 306 | 307 | input_corrected = True 308 | 309 | h = int(self.query_one(".--hue-input", Input).value) 310 | s = int(self.query_one(".--saturation-input", Input).value) 311 | v = int(self.query_one(".--value-input", Input).value) 312 | 313 | # Update the HSV only if the input value has changed. 314 | # This prevents unwanted updates from the scaled integer values. 315 | if (h, s, v) != self._hsv_scaled_integers or input_corrected: 316 | hsv = HSV(h / 360, s / 100, v / 100) 317 | self.hsv = hsv 318 | 319 | @on(Input.Changed) 320 | def _on_input_changed(self, event: Input.Changed) -> None: 321 | event.stop() 322 | 323 | 324 | class HexInput(Widget): 325 | """A hex color input widget.""" 326 | 327 | DEFAULT_CSS = """ 328 | HexInput { 329 | width: auto; 330 | height: auto; 331 | 332 | HorizontalGroup { 333 | width: auto; 334 | } 335 | 336 | Label { 337 | padding: 1 0; 338 | } 339 | 340 | Input { 341 | width: 13; 342 | } 343 | } 344 | """ 345 | 346 | # TODO: Allow shorthand hex values 347 | _HEX_COLOR_PATTERN = r"#[0-9a-fA-F]{6}" 348 | 349 | value: var[str] = var("#FF0000", init=False) 350 | """The current hex color value.""" 351 | 352 | class Changed(Message): 353 | """Posted when the hex color value changes. 354 | 355 | This message can be handled using an `on_hex_input_changed` method. 356 | """ 357 | 358 | def __init__(self, hex_input: HexInput, value: str) -> None: 359 | super().__init__() 360 | self.value: str = value 361 | self.hex_input = hex_input 362 | 363 | @property 364 | def control(self) -> HexInput: 365 | return self.hex_input 366 | 367 | def __init__( 368 | self, 369 | value: str = "#FF0000", 370 | *, 371 | name: str | None = None, 372 | id: str | None = None, 373 | classes: str | None = None, 374 | disabled: bool = False, 375 | ) -> None: 376 | """Create a hex color input widget. 377 | 378 | Args: 379 | value: The initial hex color value. 380 | name: The name of the widget. 381 | id: The ID of the widget in the DOM. 382 | classes: The CSS classes of the widget. 383 | disabled: Whether the widget is disabled or not. 384 | """ 385 | super().__init__(name=name, id=id, classes=classes, disabled=disabled) 386 | self.value = value.upper() 387 | 388 | def compose(self) -> ComposeResult: 389 | hex_value = self._format_hex_value(self.value) 390 | with HorizontalGroup(): 391 | yield Label("#") 392 | yield Input( 393 | hex_value, 394 | validators=Regex(self._HEX_COLOR_PATTERN[1:]), 395 | ) 396 | 397 | def validate_value(self, value: str) -> str: 398 | if re.fullmatch(self._HEX_COLOR_PATTERN, value): 399 | return value.upper() 400 | raise ValueError(f"Invalid hex color: {value}") 401 | 402 | def watch_value(self) -> None: 403 | if self.is_mounted: 404 | hex_value = self._format_hex_value(self.value) 405 | self.query_one(Input).value = hex_value 406 | 407 | self.post_message(self.Changed(self, self.value)) 408 | 409 | def _format_hex_value(self, hex: str) -> str: 410 | return hex.lower().lstrip("#") 411 | 412 | @on(Input.Blurred) 413 | @on(Input.Submitted) 414 | def _on_input_blurred_or_submitted( 415 | self, event: Input.Blurred | Input.Submitted 416 | ) -> None: 417 | event.stop() 418 | validation_result = event.validation_result 419 | assert validation_result is not None 420 | if not validation_result.is_valid: 421 | # If the value is not a valid hex color, reset the input to the 422 | # current hex value. 423 | if not re.fullmatch(self._HEX_COLOR_PATTERN, event.value): 424 | hex_value = self._format_hex_value(self.value) 425 | event.input.value = hex_value 426 | return 427 | 428 | # If the value is a valid hex color but starts with the "#" prefix, 429 | # simply strip the "#" from the input. 430 | hex_value = self._format_hex_value(event.value) 431 | event.input.value = hex_value 432 | 433 | hex_color = f"#{hex_value.upper()}" 434 | self.value = hex_color 435 | 436 | @on(Input.Changed) 437 | def _on_input_changed(self, event: Input.Changed) -> None: 438 | event.stop() 439 | 440 | 441 | class ColorInputs(Widget): 442 | """A color inputs widget that combines fields for RGB, HSV and Hex values.""" 443 | 444 | DEFAULT_CSS = """ 445 | ColorInputs { 446 | width: auto; 447 | height: auto; 448 | 449 | HorizontalGroup { 450 | width: auto; 451 | } 452 | 453 | HexInput { 454 | margin-top: 1; 455 | margin-left: 1; 456 | } 457 | } 458 | """ 459 | 460 | def __init__( 461 | self, 462 | color: Color = Color(255, 0, 0), 463 | *, 464 | name: str | None = None, 465 | id: str | None = None, 466 | classes: str | None = None, 467 | disabled: bool = False, 468 | ) -> None: 469 | """Create a color inputs widget. 470 | 471 | Args: 472 | color: The initial color value. 473 | name: The name of the widget. 474 | id: The ID of the widget in the DOM. 475 | classes: The CSS classes of the widget. 476 | disabled: Whether the widget is disabled or not. 477 | """ 478 | super().__init__(name=name, id=id, classes=classes, disabled=disabled) 479 | self._color = color.clamped 480 | 481 | def compose(self) -> ComposeResult: 482 | color = self._color 483 | with HorizontalGroup(): 484 | yield RgbInputs(color) 485 | yield HsvInputs(color.hsv) 486 | yield HexInput(color.hex) 487 | 488 | 489 | if __name__ == "__main__": 490 | from textual.app import App 491 | 492 | class ColorInputsApp(App): 493 | CSS = """ 494 | Screen { 495 | align: center middle; 496 | } 497 | """ 498 | 499 | def compose(self) -> ComposeResult: 500 | yield ColorInputs() 501 | 502 | app = ColorInputsApp() 503 | app.run() 504 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------