dash-prism 0.1.0__tar.gz

dash_prism-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Ludwig Jonsson
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dash_prism-0.1.0/MANIFEST.in

@@ -0,0 +1,7 @@
+recursive-include dash_prism *.js *.js.map *.json *.css *.html
+include LICENSE
+include README.md
+prune tests
+prune .github
+global-exclude __pycache__
+global-exclude *.py[cod]

dash_prism-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: dash_prism
+Version: 0.1.0
+Summary: Prism: Advanced multi-panel workspace manager for Plotly Dash
+Author-email: Ludwig Jonsson <developer-prism@protonmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/LudwigAJ/dash-prism
+Project-URL: Repository, https://github.com/LudwigAJ/dash-prism.git
+Project-URL: Issues, https://github.com/LudwigAJ/dash-prism/issues
+Keywords: dash,plotly,plotly-dash,dashboard,workspace,tabs,panels,layout,ui,components,drag-and-drop
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Dash
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dash>=3.1.1
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: pytest-xdist>=3.0.0; extra == "test"
+Requires-Dist: dash[testing]>=3.1.1; extra == "test"
+Provides-Extra: dev
+Requires-Dist: dash[dev]>=3.1.1; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: wheel>=0.40.0; extra == "dev"
+Requires-Dist: pyyaml>=6.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0.0; extra == "docs"
+Dynamic: license-file
+
+# Dash Prism
+
+[![CI](https://github.com/LudwigAJ/dash-prism/actions/workflows/ci.yml/badge.svg)](https://github.com/LudwigAJ/dash-prism/actions/workflows/ci.yml)
+[![Docs](https://github.com/LudwigAJ/dash-prism/actions/workflows/docs.yml/badge.svg)](https://ludwigaj.github.io/dash-prism/)
+
+A multi-panel workspace manager for Plotly Dash applications.
+
+**Documentation:** https://ludwigaj.github.io/dash-prism/
+
+## What is Dash Prism?
+
+Dash Prism provides a unified workspace where multiple Dash layouts coexist as
+tabs within resizable, splittable panels. Users arrange their workspace via
+drag-and-drop while developers focus on building content.
+
+## The Problem
+
+Building dashboards with Plotly Dash typically means:
+
+- **Fragmented applications** - Each dashboard lives in isolation, requiring
+  users to switch between browser tabs or navigate complex menus.
+- **Repetitive UI work** - Developers spend time on layout scaffolding, tab
+  systems, and panel management instead of business logic.
+- **One-size-fits-all layouts** - Users get a fixed arrangement that may not
+  match their workflow.
+- **No personalization** - Workspaces reset on every visit; users cannot save
+  their preferred view.
+
+## The Solution
+
+Dash Prism addresses these issues by providing:
+
+- **Unified workspace** - Register any number of layouts; users open them as
+  tabs in a single interface.
+- **User-driven design** - Drag tabs to split panels, resize areas, and
+  rearrange freely. Developers define content; users define structure.
+- **Persistence** - Workspace state saves to localStorage, sessionStorage, or
+  memory so users return to exactly where they left off.
+- **Minimal boilerplate** - A decorator-based API keeps layout registration
+  concise and readable.
+
+## Installation
+
+**Requirements:** Python 3.10+, Dash 3.1.1+
+
+```bash
+pip install dash-prism
+```
+
+## Quick Start
+
+```python
+import dash
+from dash import html
+import dash_prism
+
+app = dash.Dash(__name__)
+
+@dash_prism.register_layout(id='home', name='Home', icon='Home')
+def home():
+    return html.Div('Welcome to Dash Prism')
+
+@dash_prism.register_layout(id='analytics', name='Analytics', icon='BarChart3')
+def analytics():
+    return html.Div('Analytics content here')
+
+app.layout = html.Div([
+    dash_prism.Prism(id='workspace', persistence=True)
+])
+
+dash_prism.init('workspace', app)
+
+if __name__ == '__main__':
+    app.run(debug=True)
+```
+
+## Development
+
+### Setup
+
+```bash
+# Clone and enter the project
+git clone https://github.com/LudwigAJ/dash-prism.git
+cd dash-prism
+
+# Create a virtual environment
+python -m venv .venv
+source .venv/bin/activate  # Windows: .venv\Scripts\activate
+
+# Install dependencies
+pip install -r requirements.txt
+npm install
+
+# Build
+npm run build
+```
+
+### Using Just
+
+If you have [just](https://github.com/casey/just) installed:
+
+```bash
+just install   # Install Python and npm dependencies
+just build     # Build the package
+just test      # Run tests
+```
+
+## Contributing
+
+Contributions are welcome. Please:
+
+1. Fork the repository.
+2. Create a feature branch.
+3. Write tests for new functionality.
+4. Ensure all tests pass (`pytest`).
+5. Submit a pull request.
+
+See the [Contributing Guide](https://ludwigaj.github.io/dash-prism/contributing.html)
+in the documentation for more details.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) for details.

dash_prism-0.1.0/README.md

@@ -0,0 +1,123 @@
+# Dash Prism
+
+[![CI](https://github.com/LudwigAJ/dash-prism/actions/workflows/ci.yml/badge.svg)](https://github.com/LudwigAJ/dash-prism/actions/workflows/ci.yml)
+[![Docs](https://github.com/LudwigAJ/dash-prism/actions/workflows/docs.yml/badge.svg)](https://ludwigaj.github.io/dash-prism/)
+
+A multi-panel workspace manager for Plotly Dash applications.
+
+**Documentation:** https://ludwigaj.github.io/dash-prism/
+
+## What is Dash Prism?
+
+Dash Prism provides a unified workspace where multiple Dash layouts coexist as
+tabs within resizable, splittable panels. Users arrange their workspace via
+drag-and-drop while developers focus on building content.
+
+## The Problem
+
+Building dashboards with Plotly Dash typically means:
+
+- **Fragmented applications** - Each dashboard lives in isolation, requiring
+  users to switch between browser tabs or navigate complex menus.
+- **Repetitive UI work** - Developers spend time on layout scaffolding, tab
+  systems, and panel management instead of business logic.
+- **One-size-fits-all layouts** - Users get a fixed arrangement that may not
+  match their workflow.
+- **No personalization** - Workspaces reset on every visit; users cannot save
+  their preferred view.
+
+## The Solution
+
+Dash Prism addresses these issues by providing:
+
+- **Unified workspace** - Register any number of layouts; users open them as
+  tabs in a single interface.
+- **User-driven design** - Drag tabs to split panels, resize areas, and
+  rearrange freely. Developers define content; users define structure.
+- **Persistence** - Workspace state saves to localStorage, sessionStorage, or
+  memory so users return to exactly where they left off.
+- **Minimal boilerplate** - A decorator-based API keeps layout registration
+  concise and readable.
+
+## Installation
+
+**Requirements:** Python 3.10+, Dash 3.1.1+
+
+```bash
+pip install dash-prism
+```
+
+## Quick Start
+
+```python
+import dash
+from dash import html
+import dash_prism
+
+app = dash.Dash(__name__)
+
+@dash_prism.register_layout(id='home', name='Home', icon='Home')
+def home():
+    return html.Div('Welcome to Dash Prism')
+
+@dash_prism.register_layout(id='analytics', name='Analytics', icon='BarChart3')
+def analytics():
+    return html.Div('Analytics content here')
+
+app.layout = html.Div([
+    dash_prism.Prism(id='workspace', persistence=True)
+])
+
+dash_prism.init('workspace', app)
+
+if __name__ == '__main__':
+    app.run(debug=True)
+```
+
+## Development
+
+### Setup
+
+```bash
+# Clone and enter the project
+git clone https://github.com/LudwigAJ/dash-prism.git
+cd dash-prism
+
+# Create a virtual environment
+python -m venv .venv
+source .venv/bin/activate  # Windows: .venv\Scripts\activate
+
+# Install dependencies
+pip install -r requirements.txt
+npm install
+
+# Build
+npm run build
+```
+
+### Using Just
+
+If you have [just](https://github.com/casey/just) installed:
+
+```bash
+just install   # Install Python and npm dependencies
+just build     # Build the package
+just test      # Run tests
+```
+
+## Contributing
+
+Contributions are welcome. Please:
+
+1. Fork the repository.
+2. Create a feature branch.
+3. Write tests for new functionality.
+4. Ensure all tests pass (`pytest`).
+5. Submit a pull request.
+
+See the [Contributing Guide](https://ludwigaj.github.io/dash-prism/contributing.html)
+in the documentation for more details.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) for details.

dash_prism-0.1.0/dash_prism/Action.py

@@ -0,0 +1,192 @@
+"""Action Component Wrapper.
+
+User-facing wrapper for the Action component with comprehensive documentation.
+This file provides a clean Python API that wraps the auto-generated PrismActionComponent.
+"""
+
+from __future__ import annotations
+
+from .PrismActionComponent import PrismActionComponent
+
+
+class Action(PrismActionComponent):
+    """A clickable action button for the Prism status bar.
+
+    Action components are displayed in the status bar and provide
+    interactive buttons that users can click to trigger callbacks. Each action
+    is an independent Dash component with its own ``n_clicks`` property,
+    allowing for individual callback handling per button.
+
+    :param id: Unique identifier for this action in Dash callbacks.
+        Use this ID to create callbacks responding to button clicks.
+    :type id: str or None
+    :param label: Button label text displayed in the status bar.
+        This is the visible text users will see on the button. **Required**.
+    :type label: str
+    :param icon: Icon name to display before the label.
+        Use :func:`get_available_icons` to see all available icons, or check
+        if a specific icon exists with ``icon_name in AVAILABLE_ICONS``.
+        Examples: ``'Rocket'``, ``'Brain'``, ``'BarChart3'``, ``'Coffee'``.
+    :type icon: str or None
+    :param tooltip: Tooltip text shown on hover.
+        If not provided, defaults to ``"Click to trigger {label}"``.
+    :type tooltip: str or None
+    :param style: Button style variant or custom hex color.
+        Preset styles: ``'default'``, ``'primary'``, ``'secondary'``,
+        ``'success'``, ``'warning'``, ``'danger'``.
+        Custom color: Any valid hex color (e.g., ``'#FF5500'``).
+    :type style: str or None
+    :param disabled: Whether the button is disabled. Disabled buttons cannot
+        be clicked and appear grayed out. Can be controlled via Dash callbacks
+        for dynamic enabling/disabling. Defaults to ``False``.
+    :type disabled: bool
+    :param loading: Whether to show a loading spinner. When ``True``, replaces
+        the icon with a spinner and disables the button. Useful for indicating
+        async operations are in progress. Defaults to ``False``.
+    :type loading: bool
+    :param n_clicks: Number of times the button has been clicked. Use as an
+        ``Input`` in Dash callbacks to respond to clicks. Automatically
+        incremented each time the button is clicked. Defaults to ``0``.
+    :type n_clicks: int
+
+    .. rubric:: Examples
+
+    Basic action button:
+
+    .. code-block:: python
+
+        import dash_prism
+        from dash import Dash, html, Input, Output
+
+        app = Dash(__name__)
+
+        app.layout = html.Div([
+            dash_prism.Prism(
+                id='workspace',
+                actions=[
+                    dash_prism.Action(
+                        id='save-action',
+                        label='Save',
+                        icon='Save',
+                        tooltip='Save current workspace'
+                    )
+                ]
+            )
+        ])
+
+        @app.callback(
+            Output('save-action', 'loading'),
+            Input('save-action', 'n_clicks'),
+            prevent_initial_call=True
+        )
+        def handle_save(n_clicks):
+            # Perform save operation
+            import time
+            time.sleep(1)  # Simulate async operation
+            return False  # Stop loading spinner
+
+    Multiple actions with different styles:
+
+    .. code-block:: python
+
+        actions = [
+            dash_prism.Action(
+                id='save',
+                label='Save',
+                icon='Save',
+                style='primary'
+            ),
+            dash_prism.Action(
+                id='export',
+                label='Export',
+                icon='Download',
+                style='secondary'
+            ),
+            dash_prism.Action(
+                id='delete',
+                label='Delete All',
+                icon='Trash2',
+                style='danger',
+                tooltip='WARNING: This will delete all data'
+            ),
+        ]
+
+        app.layout = html.Div([
+            dash_prism.Prism(id='workspace', actions=actions)
+        ])
+
+    Dynamic enabling/disabling:
+
+    .. code-block:: python
+
+        from dash import State
+
+        @app.callback(
+            Output('save-action', 'disabled'),
+            Input('workspace', 'readWorkspace')
+        )
+        def update_save_button(workspace):
+            # Disable save button if no tabs are open
+            if not workspace or not workspace.get('tabs'):
+                return True  # Disabled
+            return False  # Enabled
+
+    Custom color action:
+
+    .. code-block:: python
+
+        custom_action = dash_prism.Action(
+            id='custom',
+            label='Custom',
+            icon='Palette',
+            style='#FF5500',  # Custom orange color
+            tooltip='Custom colored action'
+        )
+
+    Loading state management:
+
+    .. code-block:: python
+
+        @app.callback(
+            Output('export-action', 'loading'),
+            Input('export-action', 'n_clicks'),
+            prevent_initial_call=True
+        )
+        def handle_export(n_clicks):
+            # Set loading=True while operation runs
+            import time
+            time.sleep(2)  # Simulate export operation
+            return False  # Loading complete
+
+    .. seealso::
+
+        :class:`Prism`
+            Main workspace component
+
+        :func:`dash_prism.init`
+            Initialize Prism with Dash app
+
+    .. note::
+
+        - Actions must be passed to the Prism component's ``actions`` parameter
+        - Each action has an independent ``n_clicks`` counter
+        - The ``loading`` state automatically disables the button
+        - Custom hex colors must be valid CSS hex colors (e.g., ``#RGB`` or ``#RRGGBB``)
+        - Icons use the Lucide icon library - ensure icon names match exactly
+    """
+
+    # Override _type to match what init.py expects (internal wire protocol)
+    _type = "PrismAction"
+
+    def __init__(self, **kwargs):
+        """Initialize Action component.
+
+        :param kwargs: All parameters accepted by the Action component.
+            See class docstring for full parameter list.
+        :type kwargs: dict
+        """
+        super().__init__(**kwargs)
+
+
+# Backwards compatibility alias
+PrismAction = Action