yafowil.widget.tiptap 2.0.0__tar.gz

yafowil_widget_tiptap-2.0.0/.gitignore

@@ -0,0 +1,20 @@
+*.egg-info
+*.pyc
+*.pyo
+/.coverage
+/.mxmake/
+/build
+/constraints-mxdev.txt
+/coverage/
+/dist/
+/htmlcov/
+/js/karma/
+/node_modules/
+/package-lock.json
+/pnpm-lock.yaml
+/py2/
+/py3/
+/pypy3/
+/requirements-mxdev.txt
+/sources/
+/venv/

yafowil_widget_tiptap-2.0.0/CHANGES.rst

@@ -0,0 +1,33 @@
+Changes
+=======
+
+2.0.0 (2026-02-03)
+------------------
+
+- Refactor package layout to use ``pyproject.toml`` and implicit namespace packages.
+  [rnix]
+
+- Introduce ``display_class`` widget property.
+  [lenadax]
+
+- Update jQuery to version ``4.0.0-beta.2``.
+  [lenadax]
+
+- Use rollup for bundling scss. Use ``make rollup`` to compile js and scss.
+  [lenadax]
+
+- Use ``webtestrunner`` instead of ``karma`` for js tests. Use ``make wtr`` to run tests.
+  [lenadax]
+
+- Use ``pnpm`` as package manager.
+  [lenadax]
+
+- Create Bootstrap5 widget version.
+  [lenadax]
+
+- Extend JS by ``tiptap_on_array_add`` and ``register_array_subscribers``
+  functions to enable usage in ``yafowil.widget.array``.
+  [lenadax]
+
+- Make it work.
+  [lenadax]

yafowil_widget_tiptap-2.0.0/LICENSE.rst

@@ -0,0 +1,26 @@
+License
+=======
+
+Copyright (c) 2021-2025, Yafowil Contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

yafowil_widget_tiptap-2.0.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.5
+Name: yafowil.widget.tiptap
+Version: 2.0.0
+Summary: Tiptap Editor Widget for YAFOWIL
+Author-email: Yafowil Contributors <dev@conestack.org>
+License: Simplified BSD
+License-File: LICENSE.rst
+Classifier: Environment :: Web Environment
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Dist: yafowil>3.99
+Provides-Extra: test
+Requires-Dist: lxml; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/x-rst
+
+.. image:: https://img.shields.io/pypi/v/yafowil.widget.tiptap.svg
+    :target: https://pypi.python.org/pypi/yafowil.widget.tiptap
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/yafowil.widget.tiptap.svg
+    :target: https://pypi.python.org/pypi/yafowil.widget.tiptap
+    :alt: Number of PyPI downloads
+
+.. image:: https://github.com/conestack/yafowil.widget.tiptap/actions/workflows/test_py.yaml/badge.svg
+    :target: https://github.com/conestack/yafowil.widget.tiptap/actions/workflows/test_py.yaml
+    :alt: Test yafowil.widget.tiptap Python
+
+.. image:: https://github.com/conestack/yafowil.widget.tiptap/actions/workflows/test_js.yaml/badge.svg
+    :target: https://github.com/conestack/yafowil.widget.tiptap/actions/workflows/test_js.yaml
+    :alt: Test yafowil.widget.tiptap JS
+
+This is a **tiptap editor widget** for `YAFOWIL
+<http://pypi.python.org/pypi/yafowil>`_
+
+- `Tiptap Editor <https://github.com/ueberdosis/tiptap>`_
+- `DEMO - see it Live <http://demo.yafowil.info/++widget++yafowil.widget.tiptap/index.html>`_
+
+Currently included version of tiptap editor is 2.0.0-beta.166.
+
+
+Source Code
+===========
+
+The sources are in a GIT DVCS with its main branches at
+`github <http://github.com/conestack/yafowil.widget.tiptap>`_.
+
+We'd be happy to see many forks and pull-requests to make YAFOWIL even better.
+
+
+Contributors
+============
+
+- Robert Niederreiter
+
+- Lena Daxenbichler

yafowil_widget_tiptap-2.0.0/README.rst

@@ -0,0 +1,40 @@
+.. image:: https://img.shields.io/pypi/v/yafowil.widget.tiptap.svg
+    :target: https://pypi.python.org/pypi/yafowil.widget.tiptap
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/yafowil.widget.tiptap.svg
+    :target: https://pypi.python.org/pypi/yafowil.widget.tiptap
+    :alt: Number of PyPI downloads
+
+.. image:: https://github.com/conestack/yafowil.widget.tiptap/actions/workflows/test_py.yaml/badge.svg
+    :target: https://github.com/conestack/yafowil.widget.tiptap/actions/workflows/test_py.yaml
+    :alt: Test yafowil.widget.tiptap Python
+
+.. image:: https://github.com/conestack/yafowil.widget.tiptap/actions/workflows/test_js.yaml/badge.svg
+    :target: https://github.com/conestack/yafowil.widget.tiptap/actions/workflows/test_js.yaml
+    :alt: Test yafowil.widget.tiptap JS
+
+This is a **tiptap editor widget** for `YAFOWIL
+<http://pypi.python.org/pypi/yafowil>`_
+
+- `Tiptap Editor <https://github.com/ueberdosis/tiptap>`_
+- `DEMO - see it Live <http://demo.yafowil.info/++widget++yafowil.widget.tiptap/index.html>`_
+
+Currently included version of tiptap editor is 2.0.0-beta.166.
+
+
+Source Code
+===========
+
+The sources are in a GIT DVCS with its main branches at
+`github <http://github.com/conestack/yafowil.widget.tiptap>`_.
+
+We'd be happy to see many forks and pull-requests to make YAFOWIL even better.
+
+
+Contributors
+============
+
+- Robert Niederreiter
+
+- Lena Daxenbichler

yafowil_widget_tiptap-2.0.0/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+requires = ["hatchling", "hatch-fancy-pypi-readme"]
+build-backend = "hatchling.build"
+
+[project]
+name = "yafowil.widget.tiptap"
+version = "2.0.0"
+description = "Tiptap Editor Widget for YAFOWIL"
+readme = "README.rst"
+license = {text = "Simplified BSD"}
+authors = [{name = "Yafowil Contributors", email = "dev@conestack.org"}]
+classifiers = [
+    "License :: OSI Approved :: BSD License",
+    "Environment :: Web Environment",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+dependencies = [
+    "yafowil>3.99",
+]
+
+[project.optional-dependencies]
+test = [
+    "lxml",
+    "pytest",
+]
+
+[project.entry-points."yafowil.plugin"]
+register = "yafowil.widget.tiptap:register"
+example = "yafowil.widget.tiptap.example:get_example"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/x-rst"
+fragments = [
+    {path = "README.rst"},
+    {text = "\n\n"},
+    {path = "CHANGES.rst"},
+    {text = "\n\n"},
+    {path = "LICENSE.rst"},
+]
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "/.github/",
+    "/js/",
+    "/Makefile",
+    "/mx.ini",
+    "/mxmake.yaml",
+    "/package.json",
+    "/pnpm-lock.yaml",
+    "/scss",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/yafowil"]
+
+[tool.pytest.ini_options]
+consider_namespace_packages = true
+addopts = ["--import-mode=importlib"]
+pythonpath = "src"
+
+[tool.zest-releaser]
+create-wheel = true

yafowil_widget_tiptap-2.0.0/src/yafowil/widget/tiptap/__init__.py

@@ -0,0 +1,145 @@
+from yafowil.base import factory
+from yafowil.utils import entry_point
+import os
+import webresource as wr
+
+
+resources_dir = os.path.join(os.path.dirname(__file__), 'resources')
+
+
+##############################################################################
+# Tiptap
+##############################################################################
+
+# webresource ################################################################
+
+tiptap_js = wr.ScriptResource(
+    name='tiptap-js',
+    directory=os.path.join(resources_dir, 'tiptap'),
+    path='yafowil-tiptap/tiptap',
+    resource='tiptap.js',
+    compressed='tiptap.min.js'
+)
+
+##############################################################################
+# Default
+##############################################################################
+
+# webresource ################################################################
+
+resources = wr.ResourceGroup(
+    name='yafowil.widget.tiptap',
+    directory=resources_dir,
+    path='yafowil-tiptap'
+)
+resources.add(tiptap_js)
+resources.add(wr.ScriptResource(
+    name='yafowil-tiptap-js',
+    directory=os.path.join(resources_dir, 'default'),
+    path='yafowil-tiptap/default',
+    depends=['jquery-js', 'tiptap-js'],
+    resource='widget.js',
+    compressed='widget.min.js'
+))
+resources.add(wr.StyleResource(
+    name='yafowil-tiptap-css',
+    directory=os.path.join(resources_dir, 'default'),
+    path='yafowil-tiptap/default',
+    resource='widget.min.css'
+))
+
+# B/C resources ##############################################################
+
+js = [{
+    'group': 'yafowil.widget.tiptap.dependencies',
+    'resource': 'tiptap/tiptap.js',
+    'order': 21,
+}, {
+    'group': 'yafowil.widget.tiptap.common',
+    'resource': 'default/widget.js',
+    'order': 21,
+}]
+css = [{
+    'group': 'yafowil.widget.tiptap.common',
+    'resource': 'default/widget.min.css',
+    'order': 21,
+}]
+
+##############################################################################
+# Bootstrap 5
+##############################################################################
+
+# webresource ################################################################
+
+bootstrap5_resources = wr.ResourceGroup(
+    name='yafowil.widget.tiptap',
+    directory=resources_dir,
+    path='yafowil-tiptap'
+)
+bootstrap5_resources.add(tiptap_js)
+bootstrap5_resources.add(wr.ScriptResource(
+    name='yafowil-tiptap-js',
+    directory=os.path.join(resources_dir, 'bootstrap5'),
+    path='yafowil-tiptap/bootstrap5',
+    depends=['jquery-js', 'tiptap-js'],
+    resource='widget.js',
+    compressed='widget.min.js'
+))
+bootstrap5_resources.add(wr.StyleResource(
+    name='yafowil-tiptap-css',
+    directory=os.path.join(resources_dir, 'bootstrap5'),
+    path='yafowil-tiptap/bootstrap5',
+    resource='widget.min.css'
+))
+# B/C resources ##############################################################
+
+bootstrap5_js = [{
+    'group': 'yafowil.widget.tiptap.dependencies',
+    'resource': 'tiptap/tiptap.js',
+    'order': 20,
+}, {
+    'group': 'yafowil.widget.tiptap.common',
+    'resource': 'bootstrap5/widget.js',
+    'order': 21,
+}]
+bootstrap5_css = [{
+    'group': 'yafowil.widget.tiptap.common',
+    'resource': 'bootstrap5/widget.min.css',
+    'order': 21,
+}]
+
+
+##############################################################################
+# Registration
+##############################################################################
+
+@entry_point(order=10)
+def register():
+    from yafowil.widget.tiptap import widget  # noqa
+
+    widget_name = 'yafowil.widget.tiptap'
+
+    # Default
+    factory.register_theme(
+        'default',
+        widget_name,
+        resources_dir,
+        js=js,
+        css=css
+    )
+    factory.register_resources('default', widget_name, resources)
+
+    # Bootstrap 5
+    factory.register_theme(
+        ['bootstrap5'],
+        widget_name,
+        resources_dir,
+        js=bootstrap5_js,
+        css=bootstrap5_css
+    )
+
+    factory.register_resources(
+        ['bootstrap5'],
+        widget_name,
+        bootstrap5_resources
+    )

yafowil_widget_tiptap-2.0.0/src/yafowil/widget/tiptap/example.py

@@ -0,0 +1,226 @@
+# -*- coding: utf-8 -*-
+from yafowil.base import factory
+
+
+DOC_DEFAULT_TIPTAP = """
+Default Tiptap widget
+---------------------
+
+.. code-block:: python
+
+    tiptap = factory('tiptap', value="<p>Hello World!</p>", props={
+        'label': 'Default Widget'
+    })
+"""
+
+
+def default_example():
+    part = factory(u'fieldset', name='yafowil.widget.tiptap')
+    part['tiptap'] = factory(
+        '#field:tiptap',
+        value='<p>Hello World!</p>',
+        props={
+            'label': 'Default Widget'
+        })
+    return {
+        'widget': part,
+        'doc': DOC_DEFAULT_TIPTAP,
+        'title': 'Tiptap'
+    }
+
+
+DOC_ACTIONS_TIPTAP = """
+Tiptap widget actions
+---------------------
+
+Actions of the tiptap widget can be customized. Action buttons can be grouped
+together by putting them in a list.
+
+.. code-block:: python
+
+    tiptap = factory(
+        'tiptap',
+        value='<p>This widget has customized actions.</p>',
+        props={
+            'label': 'Tiptap Widget with customized actions',
+            'actions': [
+                ['heading', 'color'],
+                ['bold', 'italic', 'underline'],
+                ['bulletList', 'orderedList', 'indent', 'outdent'],
+                ['html'],
+                ['image', 'link'],
+                ['code', 'codeBlock']
+            ]
+        })
+"""
+
+
+def actions_example():
+    part = factory(u'fieldset', name='yafowil.widget.tiptap')
+    part['tiptap'] = factory(
+        '#field:tiptap',
+        value='<p>This widget has customized actions.</p>',
+        props={
+            'label': 'Tiptap Widget with customized actions',
+            'actions': [
+                ['heading', 'color'],
+                ['bold', 'italic', 'underline'],
+                ['bulletList', 'orderedList', 'indent', 'outdent'],
+                ['html'],
+                ['image', 'link'],
+                ['code', 'codeBlock']
+            ]
+        })
+    return {
+        'widget': part,
+        'doc': DOC_ACTIONS_TIPTAP,
+        'title': 'Tiptap Widget with customized actions',
+    }
+
+
+
+DOC_COLORS_TIPTAP = """
+Tiptap Widget colors
+--------------------
+
+To customize the color selection of the ``colors`` action, pass a list
+of colors to widget properties.
+
+Colors can only be supplied as rgb() values.
+
+.. code-block:: python
+
+    tiptap = factory(
+        'tiptap',
+        value=(
+            '<p>'
+              '<span style="color: rgb(66,209,245)">This widget</span> has '
+              '<span style="color: rgb(161,66,245)">custom colors</span>.'
+            '</p>'
+        ),
+        props={
+            'label': 'Tiptap Widget with custom colors',
+            'actions': ['color'],
+            'colors': [
+                {'name': 'Purple', 'color': 'rgb(161,66,245)'},
+                {'name': 'Blue', 'color': 'rgb(66,111,245)'},
+                {'name': 'Turqoise', 'color': 'rgb(66,209,245)'},
+                {'name': 'Green', 'color': 'rgb(105,245,66)'},
+                {'name': 'Yellow', 'color': 'rgb(245,236,66)'},
+                {'name': 'Orange', 'color': 'rgb(245,167,66'},
+                {'name': 'Red', 'color': 'rgb(245,66,66)'}
+            ]
+        })
+"""
+
+
+def colors_example():
+    part = factory(u'fieldset', name='yafowil.widget.tiptap')
+    part['tiptap'] = factory(
+        'tiptap',
+        value=(
+            '<p>'
+              '<span style="color: rgb(66,209,245)">This widget</span> has '
+              '<span style="color: rgb(161,66,245)">custom colors</span>.'
+            '</p>'
+        ),
+        props={
+            'label': 'Tiptap Widget with custom colors',
+            'actions': ['color'],
+            'colors': [
+                {'name': 'Purple', 'color': 'rgb(161,66,245)'},
+                {'name': 'Blue', 'color': 'rgb(66,111,245)'},
+                {'name': 'Turqoise', 'color': 'rgb(66,209,245)'},
+                {'name': 'Green', 'color': 'rgb(105,245,66)'},
+                {'name': 'Yellow', 'color': 'rgb(245,236,66)'},
+                {'name': 'Orange', 'color': 'rgb(245,167,66'},
+                {'name': 'Red', 'color': 'rgb(245,66,66)'}
+            ]
+        })
+    return {
+        'widget': part,
+        'doc': DOC_COLORS_TIPTAP,
+        'title': 'Tiptap Widget with custom colors',
+    }
+
+
+DOC_DISPLAY_TIPTAP = """
+Display Mode
+------------
+
+In Display Mode, the widget is not editable and Actions will not be rendered.
+The ``display_class`` widget property can be used to style the div containing the
+widget value.
+
+.. code-block:: python
+
+    tiptap = factory(
+        'tiptap',
+        value=(
+            '<p>'
+              'This widget is in '
+              '<strong style="color: rgb(66,209,245)">display mode</strong>, '
+              'but it will still show <strong>custom formatting</strong>.'
+              '<br />'
+              'Its border was adding with the <strong>display_class</strong> property.'
+            '</p>'
+        ),
+        props={
+            'label': 'Tiptap Widget in display mode',
+            'actions': ['color'],
+            'colors': [
+                {'name': 'Purple', 'color': 'rgb(161,66,245)'},
+                {'name': 'Blue', 'color': 'rgb(66,111,245)'},
+                {'name': 'Turqoise', 'color': 'rgb(66,209,245)'},
+                {'name': 'Green', 'color': 'rgb(105,245,66)'},
+                {'name': 'Yellow', 'color': 'rgb(245,236,66)'},
+                {'name': 'Orange', 'color': 'rgb(245,167,66'},
+                {'name': 'Red', 'color': 'rgb(245,66,66)'}
+            ],
+            'display_class': 'form-control border-2 border-info'
+        },
+        mode='display')
+"""
+
+
+def display_example():
+    part = factory(u'fieldset', name='yafowil.widget.tiptap')
+    part['tiptap'] = factory(
+        'tiptap',
+        value=(
+            '<p>'
+              'This widget is in '
+              '<strong style="color: rgb(66,209,245)">display mode</strong>, '
+              'but it will still show <strong>custom formatting</strong>.'
+              '<br />'
+              'Its border was adding with the <strong>display_class</strong> property.'
+            '</p>'
+        ),
+        props={
+            'label': 'Tiptap Widget in display mode',
+            'actions': ['color'],
+            'colors': [
+                {'name': 'Purple', 'color': 'rgb(161,66,245)'},
+                {'name': 'Blue', 'color': 'rgb(66,111,245)'},
+                {'name': 'Turqoise', 'color': 'rgb(66,209,245)'},
+                {'name': 'Green', 'color': 'rgb(105,245,66)'},
+                {'name': 'Yellow', 'color': 'rgb(245,236,66)'},
+                {'name': 'Orange', 'color': 'rgb(245,167,66'},
+                {'name': 'Red', 'color': 'rgb(245,66,66)'}
+            ],
+            'display_class': 'form-control border-2 border-info'
+        }, mode='display')
+    return {
+        'widget': part,
+        'doc': DOC_DISPLAY_TIPTAP,
+        'title': 'Tiptap Widget in display mode',
+    }
+
+
+def get_example():
+    return [
+        default_example(),
+        actions_example(),
+        colors_example(),
+        display_example()
+    ]