Merge pull request #1127 from xcube-dev/forman-add_markdown_component

Add markdown component

Author: forman

CHANGES.md

@@ -15,6 +15,11 @@
      datasets and variable CF attributes.
 * Improved axis labeling in 2D histogram visualization in the Panel demo.
 
+* Added support for the xcube Viewer's `Markdown` component so it can be used in 
+  server-side viewer extensions. See new package `xcube.webapi.viewer.components`
+  exporting class `Markdown` which has a single `text` property that takes 
+  the markdown text.
+
 ### Other changes
 
 * Reformatted code base according to the default settings used by 

test/webapi/viewer/test_components.py

@@ -0,0 +1,18 @@
+# Copyright (c) 2018-2025 by xcube team and contributors
+# Permissions are hereby granted under the terms of the MIT License:
+# https://opensource.org/licenses/MIT.
+
+
+import unittest
+
+from xcube.webapi.viewer.components import Markdown
+
+
+class ViewerComponentsTest(unittest.TestCase):
+    # noinspection PyMethodMayBeStatic
+    def test_markdown(self):
+        markdown = Markdown(text="_Hello_ **world**!")
+        self.assertEqual(
+            {"type": "Markdown", "text": "_Hello_ **world**!"},
+            markdown.to_dict(),
+        )

xcube/webapi/viewer/components/__init__.py

@@ -0,0 +1,9 @@
+#  Copyright (c) 2018-2025 by xcube team and contributors
+#  Permissions are hereby granted under the terms of the MIT License:
+#  https://opensource.org/licenses/MIT.
+
+from .markdown import Markdown
+
+__all__ = [
+    "Markdown",
+]

xcube/webapi/viewer/components/markdown.py

@@ -0,0 +1,15 @@
+#  Copyright (c) 2018-2025 by xcube team and contributors
+#  Permissions are hereby granted under the terms of the MIT License:
+#  https://opensource.org/licenses/MIT.
+
+from dataclasses import dataclass
+
+from chartlets import Component
+
+
+@dataclass(frozen=True)
+class Markdown(Component):
+    """A div-element in which the given markdown text is rendered."""
+
+    text: str | None = None
+    """The markdown text."""

xcube/webapi/viewer/context.py

@@ -101,4 +101,4 @@ def prepend_sys_path(path: Path | str | None):
     finally:
         if prev_sys_path:
             sys.path = prev_sys_path
-            LOG.info(f"Restored sys.path")
+            LOG.info("Restored sys.path")