nicegui-extentions


Namenicegui-extentions JSON
Version 0.0.3 PyPI version JSON
download
home_pageNone
Summarynicegui extensions
upload_time2024-08-17 12:31:07
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # nicegui_extentions

provide extension features for Nicegui

<a title="MIT" target="_blank" href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-orange.svg?style=flat-square"></a>

<p align="center">
<a href="https://github.com/T2XX/nicegui_extentions/blob/main/README.md">English</a>  |  <a href="https://github.com/T2XX/nicegui_extentions/blob/main/README_zh_CN">简体中文</a>
</p>

# extentions

### [markdown](https://github.com/T2XX/nicegui_extentions/blob/main/src/nicegui_extentions/markdown.py)

- powered by [vditor](https://github.com/Vanessa219/vditor/blob/master/README_en_US.md)![vditor](https://b3log.org/images/brand/vditor-128.png), you can see the feature from [here](https://github.com/Vanessa219/vditor/blob/master/README_en_US.md#--features)

#### how to use it

1. step 1, load Dependence before page require

```python
from nicegui_extentions.markdown import MarkdownPreViewer, initMarkdownPreViewerDependence
initMarkdownPreViewerDependence()
```

2. step 2, create widget and render markdown

```python
md = MarkdownPreViewer().render(markdown)
```

3. (optional)step 3, update markdown

```python
md.render(new_markdown)
```

### [reconnect_box](https://github.com/T2XX/nicegui_extentions/blob/main/src/nicegui_extentions/reconnect_box.py)

- before

  ![before](https://github.com/T2XX/nicegui_extentions/blob/main/image/1723880105580.png?raw=true)
- after

  ![after](https://github.com/T2XX/nicegui_extentions/blob/main/image/1723879996849.png?raw=true)

#### how to use it

1. step 1

```python
from nicegui_extentions.reconnect_box import set_reconnect_box
```

1. step 2

```python
# just can use after page load
set_reconnect_box()
# after page load to use it
app.on_connect(lambda: set_reconnect_box())
```

### [reorderable](https://github.com/T2XX/nicegui_extentions/blob/main/src/nicegui_extentions/draggable.py)

let an item reorderable in row or column

#### how to use it

1. step 1

```python
nicegui_extentions.reorderable import ReorderableItem,ReorderableColumn
```

1. step 2

```python
with ReorderableColumn() as col:
    with ReorderableItem(width_class="w-20") as draggable:
        ui.label("Draggable Item 1")

    with ReorderableItem(width_class="w-20") as draggable:
        ui.label("Draggable Item 2")

    with ReorderableItem(width_class="w-20") as draggable:
        ui.label("Draggable Item 3")
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nicegui-extentions",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "T2XX <antongong@foxmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/e7/b1/9397ca2068127b6ccf3408a8f6d7ad68e344ba85be890504220643640d61/nicegui_extentions-0.0.3.tar.gz",
    "platform": null,
    "description": "# nicegui_extentions\r\n\r\nprovide extension features for Nicegui\r\n\r\n<a title=\"MIT\" target=\"_blank\" href=\"https://opensource.org/licenses/MIT\"><img src=\"https://img.shields.io/badge/license-MIT-orange.svg?style=flat-square\"></a>\r\n\r\n<p align=\"center\">\r\n<a href=\"https://github.com/T2XX/nicegui_extentions/blob/main/README.md\">English</a> \u00a0|\u00a0 <a href=\"https://github.com/T2XX/nicegui_extentions/blob/main/README_zh_CN\">\u7b80\u4f53\u4e2d\u6587</a>\r\n</p>\r\n\r\n# extentions\r\n\r\n### [markdown](https://github.com/T2XX/nicegui_extentions/blob/main/src/nicegui_extentions/markdown.py)\r\n\r\n- powered by [vditor](https://github.com/Vanessa219/vditor/blob/master/README_en_US.md)![vditor](https://b3log.org/images/brand/vditor-128.png), you can see the feature from [here](https://github.com/Vanessa219/vditor/blob/master/README_en_US.md#--features)\r\n\r\n#### how to use it\r\n\r\n1. step 1, load Dependence before page require\r\n\r\n```python\r\nfrom nicegui_extentions.markdown import MarkdownPreViewer, initMarkdownPreViewerDependence\r\ninitMarkdownPreViewerDependence()\r\n```\r\n\r\n2. step 2, create widget and render markdown\r\n\r\n```python\r\nmd = MarkdownPreViewer().render(markdown)\r\n```\r\n\r\n3. (optional)step 3, update markdown\r\n\r\n```python\r\nmd.render(new_markdown)\r\n```\r\n\r\n### [reconnect_box](https://github.com/T2XX/nicegui_extentions/blob/main/src/nicegui_extentions/reconnect_box.py)\r\n\r\n- before\r\n\r\n  ![before](https://github.com/T2XX/nicegui_extentions/blob/main/image/1723880105580.png?raw=true)\r\n- after\r\n\r\n  ![after](https://github.com/T2XX/nicegui_extentions/blob/main/image/1723879996849.png?raw=true)\r\n\r\n#### how to use it\r\n\r\n1. step 1\r\n\r\n```python\r\nfrom nicegui_extentions.reconnect_box import set_reconnect_box\r\n```\r\n\r\n1. step 2\r\n\r\n```python\r\n# just can use after page load\r\nset_reconnect_box()\r\n# after page load to use it\r\napp.on_connect(lambda: set_reconnect_box())\r\n```\r\n\r\n### [reorderable](https://github.com/T2XX/nicegui_extentions/blob/main/src/nicegui_extentions/draggable.py)\r\n\r\nlet an item reorderable in row or column\r\n\r\n#### how to use it\r\n\r\n1. step 1\r\n\r\n```python\r\nnicegui_extentions.reorderable import ReorderableItem,ReorderableColumn\r\n```\r\n\r\n1. step 2\r\n\r\n```python\r\nwith ReorderableColumn() as col:\r\n    with ReorderableItem(width_class=\"w-20\") as draggable:\r\n        ui.label(\"Draggable Item 1\")\r\n\r\n    with ReorderableItem(width_class=\"w-20\") as draggable:\r\n        ui.label(\"Draggable Item 2\")\r\n\r\n    with ReorderableItem(width_class=\"w-20\") as draggable:\r\n        ui.label(\"Draggable Item 3\")\r\n```\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "nicegui extensions",
    "version": "0.0.3",
    "project_urls": {
        "Homepage": "https://github.com/T2XX/nicegui_extentions",
        "Issues": "https://github.com/T2XX/nicegui_extentions/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9007b34aaabc03f48ba5d39d39126798bdeb4661e4bdd56aeb59f066bc55f5dc",
                "md5": "5410d70afeb35341747dab0aa72335d8",
                "sha256": "696aa6611f5b1bb4d58251369a93d9c585d543fc7b0633f3e4e7ecfeed183908"
            },
            "downloads": -1,
            "filename": "nicegui_extentions-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5410d70afeb35341747dab0aa72335d8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7334,
            "upload_time": "2024-08-17T12:31:05",
            "upload_time_iso_8601": "2024-08-17T12:31:05.521449Z",
            "url": "https://files.pythonhosted.org/packages/90/07/b34aaabc03f48ba5d39d39126798bdeb4661e4bdd56aeb59f066bc55f5dc/nicegui_extentions-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e7b19397ca2068127b6ccf3408a8f6d7ad68e344ba85be890504220643640d61",
                "md5": "293a7f2bb975d6fa50adbda38c698f1e",
                "sha256": "69e999647b0592a3fc8570725b68c613ba55c909631b4fb8dc681cd8cec49885"
            },
            "downloads": -1,
            "filename": "nicegui_extentions-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "293a7f2bb975d6fa50adbda38c698f1e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 11539,
            "upload_time": "2024-08-17T12:31:07",
            "upload_time_iso_8601": "2024-08-17T12:31:07.825780Z",
            "url": "https://files.pythonhosted.org/packages/e7/b1/9397ca2068127b6ccf3408a8f6d7ad68e344ba85be890504220643640d61/nicegui_extentions-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-17 12:31:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "T2XX",
    "github_project": "nicegui_extentions",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "nicegui-extentions"
}
        
Elapsed time: 0.32771s