# ✨ panel-modal
We want to make it easy to use *modals* with Panel on both the server and in the notebook.
A *modal* is an element that displays in front of and deactivates all other page content. Panel
already includes a modal. But it only works if you using a *template* on a server. It does not
work in the notebook.
You can install and use the package as simple as.
```bash
pip install panel-modal
```
```python
import panel as pn
from panel_modal import Modal
pn.extension()
modal = Modal(pn.panel("Hi. I am the Panel Modal!", width=200))
pn.Column(modal.param.open, modal).servable()
```
Check out the [api](#api) section below and the [examples](apps) folder for more details.
## Api
### Parameters
- `objects` : The objects to display in the modal. You can define the size of the modal if you
wrap the objects in a layout like a Column.
- `is_open`: Whether or not the modal is open. Set this to `True` to open the modal.
- `show_close_button`: Whether to show a close button in the modal.
- `style`: The css styles applied to the modal.
### Events
- `open`: Trigger this to open the modal.
- `close`: Trigger this to close the modal.
## 🚀 Get started in under a minute
Install `panel-modal` including the *`examples` dependencies*.
```bash
pip install panel-modal[examples]
```
Explore the sample apps
```bash
pn hello panel-modal
```
You can now find the *reference* and *gallery* notebooks in the `examples/awesome-panel/panel-modal` folder. Check them out by running `jupyter lab`.
## 📒 Explore the examples online
Click one of the buttons
[](https://nbviewer.org/github/awesome-panel/panel-modal/tree/main/examples/)
[](https://mybinder.org/v2/gh/awesome-panel/panel-modal/HEAD)
## ⭐ Support
Please support [Panel](https://panel.holoviz.org) and
[awesome-panel](https://awesome-panel.org) by giving the projects a star on Github:
- [holoviz/panel](https://github.com/holoviz/panel).
- [awesome-panel/awesome-panel](https://github.com/awesome-panel/awesome-panel).
Thanks
## ❤️ Contribute
If you are looking to contribute to this project you can find ideas in the [issue tracker](https://github.com/awesome-panel/panel-modal/issues). To get started check out the [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md).
I would love to support and receive your contributions. Thanks.
[](https://github.com/awesome-panel/panel-modal/issues).
## Monitor
[](https://pypi.org/project/panel-modal/)
[](https://pepy.tech/project/panel-modal)
[](https://opensource.org/licenses/MIT)
Raw data
{
"_id": null,
"home_page": "",
"name": "panel-modal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "python,holoviz,panel,dataviz,dataapp,dashboard,datascience,analytics",
"author": "awesome-panel",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f6/58/ab3dd82fb8534b2432bef62b08b3005bda0b9e5010d11e8a6b4bf645f6d7/panel-modal-0.4.0.tar.gz",
"platform": null,
"description": "# \u2728 panel-modal\n\nWe want to make it easy to use *modals* with Panel on both the server and in the notebook.\n\nA *modal* is an element that displays in front of and deactivates all other page content. Panel\nalready includes a modal. But it only works if you using a *template* on a server. It does not\nwork in the notebook.\n\nYou can install and use the package as simple as.\n\n```bash\npip install panel-modal\n```\n\n```python\nimport panel as pn\n\nfrom panel_modal import Modal\n\npn.extension()\n\nmodal = Modal(pn.panel(\"Hi. I am the Panel Modal!\", width=200))\n\npn.Column(modal.param.open, modal).servable()\n```\n\n\n\nCheck out the [api](#api) section below and the [examples](apps) folder for more details.\n\n\n\n## Api\n\n### Parameters\n\n- `objects` : The objects to display in the modal. You can define the size of the modal if you\nwrap the objects in a layout like a Column.\n- `is_open`: Whether or not the modal is open. Set this to `True` to open the modal.\n- `show_close_button`: Whether to show a close button in the modal.\n- `style`: The css styles applied to the modal.\n\n### Events\n\n- `open`: Trigger this to open the modal.\n- `close`: Trigger this to close the modal.\n\n## \ud83d\ude80 Get started in under a minute\n\nInstall `panel-modal` including the *`examples` dependencies*.\n\n```bash\npip install panel-modal[examples]\n```\n\nExplore the sample apps\n\n```bash\npn hello panel-modal\n```\n\nYou can now find the *reference* and *gallery* notebooks in the `examples/awesome-panel/panel-modal` folder. Check them out by running `jupyter lab`.\n\n## \ud83d\udcd2 Explore the examples online\n\nClick one of the buttons\n\n[](https://nbviewer.org/github/awesome-panel/panel-modal/tree/main/examples/)\n[](https://mybinder.org/v2/gh/awesome-panel/panel-modal/HEAD)\n\n## \u2b50 Support\n\nPlease support [Panel](https://panel.holoviz.org) and\n[awesome-panel](https://awesome-panel.org) by giving the projects a star on Github:\n\n- [holoviz/panel](https://github.com/holoviz/panel).\n- [awesome-panel/awesome-panel](https://github.com/awesome-panel/awesome-panel).\n\nThanks\n\n## \u2764\ufe0f Contribute\n\nIf you are looking to contribute to this project you can find ideas in the [issue tracker](https://github.com/awesome-panel/panel-modal/issues). To get started check out the [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md).\n\nI would love to support and receive your contributions. Thanks.\n\n[](https://github.com/awesome-panel/panel-modal/issues).\n\n## Monitor\n\n[](https://pypi.org/project/panel-modal/)\n[](https://pepy.tech/project/panel-modal)\n\n[](https://opensource.org/licenses/MIT)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "This package makes it super simple to do exploratory data analysis and develop high-quality Panel data apps ...",
"version": "0.4.0",
"project_urls": {
"repository": "https://github.com/awesome-panel/panel-modal"
},
"split_keywords": [
"python",
"holoviz",
"panel",
"dataviz",
"dataapp",
"dashboard",
"datascience",
"analytics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ca1d1739c27ff77d8b46686460531c2abf81e4b47fa56d9159f550af48f5f22d",
"md5": "b8adad233989fa4c90b1df9d9d6e8af2",
"sha256": "b8fcf65bf4a02ff365813912f5cbc025e43334ac572b9fb4c048b5f314e878c9"
},
"downloads": -1,
"filename": "panel_modal-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8adad233989fa4c90b1df9d9d6e8af2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7249,
"upload_time": "2023-11-19T09:41:50",
"upload_time_iso_8601": "2023-11-19T09:41:50.751800Z",
"url": "https://files.pythonhosted.org/packages/ca/1d/1739c27ff77d8b46686460531c2abf81e4b47fa56d9159f550af48f5f22d/panel_modal-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f658ab3dd82fb8534b2432bef62b08b3005bda0b9e5010d11e8a6b4bf645f6d7",
"md5": "a80550ce3b4102dd02c1768d3e89ed45",
"sha256": "d5be8c37d740f9768bad7bb54b61e7243c2b74cb552978d9d97d3886549c9700"
},
"downloads": -1,
"filename": "panel-modal-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "a80550ce3b4102dd02c1768d3e89ed45",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9459,
"upload_time": "2023-11-19T09:41:52",
"upload_time_iso_8601": "2023-11-19T09:41:52.497585Z",
"url": "https://files.pythonhosted.org/packages/f6/58/ab3dd82fb8534b2432bef62b08b3005bda0b9e5010d11e8a6b4bf645f6d7/panel-modal-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-19 09:41:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "awesome-panel",
"github_project": "panel-modal",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "panel-modal"
}
JSON
