# NiceGUI 补充 / Adds
补充`NiceGUI`未实现的一些组件
在使用`NiceGUI`的过程中，我查阅了组件库文档和`quasarchs`文档，但突然发现有些组件竟然没有实现，如`BreadCrumbs`，感觉还是挺重要的，就专门创了一个项目
## 安装 / Installation
```bash
# nicegui>=1.4.0
pip install nicegui-add
```
## 构建 / Build
本库是使用`Poetry`构建，更多需查询官方文档
```bash
poetry build
poetry publish --build
```
## 文档构建 / Documents Build
文档是使用`Sphinx`构建
```bash
cd docs
python make.py
```
>`make.py`
>```python
>import os
>
>make = "make.bat "
>
>os.system(make + "clear")
>os.system(make + "html")
>```
## 组件 / Elements
### Breadcrumbs 面包屑
> 类似于文件管理器上的导航栏
#### 用法 / Usage
```python
aui.breadcrumbs(separator: str = ...)
```
* separator为每个元件`BreadcrumbsEl`之间的隔开符，默认是`/`
```python
aui.breadcrumbs_el(text: str = ..., icon: str = ..., on_click=...)
```
* `text`为显示文本
* `icon`为显示图标
* `on_click`为被点击时的事件
#### 例子 / Example
```python
from nicegui import ui
from nicegui_add import aui
with aui.breadcrumbs():
aui.breadcrumbs_el("Home", icon="home", on_click=lambda: print("'Home' Clicked"))
aui.breadcrumbs_el("System", icon="windows", on_click=lambda: print("'Windows' Clicked"))
aui.breadcrumbs_el("Apps", icon="apps", on_click=lambda: print("'Apps' Clicked"))
ui.run()
```
## 开发笔记 / Development Notes
> 选择存储库平台时，我本来是打算用`Github`的，但是`Github`的登录特别繁琐，干脆改用`Gitlab`算了，而且`Gitlab`在中国地区可以正常访问，而不像`Github`一样，老是登不上去
## 版本记录 / Version Records
> `0.0.1`
>> `0011` 第一次发布，包含 `bar`, `breadcrumbs`, `breadcrumbs_el`, `space`, `toolbar`, `toolbar_title`组件
> `0.0.2`
>> `0021` 补充项目资料
>
>> `0022` 添加组件`Intersection / 交叉`，可以为`ui.Card`组件做显示效果
> `0.0.3`
>> `0031` 补充项目资料
> `0.0.4`
>> `0041` 添加组件`ButtonGroup / 按钮组`
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/XiangQinxi/nicegui-add",
"name": "nicegui-add",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "nicegui,web",
"author": "XiangQinxi",
"author_email": "XiangQinxi@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/bb/b5/b93e601aa7753ab69debb2e272a6fe4d5f2455a876ae31212ae853387270/nicegui_add-0.0.4.tar.gz",
"platform": null,
"description": "# NiceGUI \u8865\u5145 / Adds\n\u8865\u5145`NiceGUI`\u672a\u5b9e\u73b0\u7684\u4e00\u4e9b\u7ec4\u4ef6\n\n\u5728\u4f7f\u7528`NiceGUI`\u7684\u8fc7\u7a0b\u4e2d\uff0c\u6211\u67e5\u9605\u4e86\u7ec4\u4ef6\u5e93\u6587\u6863\u548c`quasarchs`\u6587\u6863\uff0c\u4f46\u7a81\u7136\u53d1\u73b0\u6709\u4e9b\u7ec4\u4ef6\u7adf\u7136\u6ca1\u6709\u5b9e\u73b0\uff0c\u5982`BreadCrumbs`\uff0c\u611f\u89c9\u8fd8\u662f\u633a\u91cd\u8981\u7684\uff0c\u5c31\u4e13\u95e8\u521b\u4e86\u4e00\u4e2a\u9879\u76ee\n\n## \u5b89\u88c5 / Installation\n\n```bash\n# nicegui>=1.4.0\npip install nicegui-add\n```\n\n## \u6784\u5efa / Build\n\u672c\u5e93\u662f\u4f7f\u7528`Poetry`\u6784\u5efa\uff0c\u66f4\u591a\u9700\u67e5\u8be2\u5b98\u65b9\u6587\u6863\n\n```bash\npoetry build\npoetry publish --build\n```\n\n## \u6587\u6863\u6784\u5efa / Documents Build\n\u6587\u6863\u662f\u4f7f\u7528`Sphinx`\u6784\u5efa\n```bash\ncd docs\npython make.py\n```\n\n>`make.py`\n>```python\n>import os\n>\n>make = \"make.bat \"\n>\n>os.system(make + \"clear\")\n>os.system(make + \"html\")\n>```\n\n\n\n## \u7ec4\u4ef6 / Elements\n### Breadcrumbs \u9762\u5305\u5c51\n> \u7c7b\u4f3c\u4e8e\u6587\u4ef6\u7ba1\u7406\u5668\u4e0a\u7684\u5bfc\u822a\u680f\n\n#### \u7528\u6cd5 / Usage\n```python\naui.breadcrumbs(separator: str = ...)\n```\n* separator\u4e3a\u6bcf\u4e2a\u5143\u4ef6`BreadcrumbsEl`\u4e4b\u95f4\u7684\u9694\u5f00\u7b26\uff0c\u9ed8\u8ba4\u662f`/`\n\n\n```python\naui.breadcrumbs_el(text: str = ..., icon: str = ..., on_click=...)\n```\n* `text`\u4e3a\u663e\u793a\u6587\u672c\n* `icon`\u4e3a\u663e\u793a\u56fe\u6807\n* `on_click`\u4e3a\u88ab\u70b9\u51fb\u65f6\u7684\u4e8b\u4ef6\n\n#### \u4f8b\u5b50 / Example\n```python\nfrom nicegui import ui\nfrom nicegui_add import aui\n\nwith aui.breadcrumbs():\n aui.breadcrumbs_el(\"Home\", icon=\"home\", on_click=lambda: print(\"'Home' Clicked\"))\n aui.breadcrumbs_el(\"System\", icon=\"windows\", on_click=lambda: print(\"'Windows' Clicked\"))\n aui.breadcrumbs_el(\"Apps\", icon=\"apps\", on_click=lambda: print(\"'Apps' Clicked\"))\n \nui.run()\n```\n\n## \u5f00\u53d1\u7b14\u8bb0 / Development Notes\n> \u9009\u62e9\u5b58\u50a8\u5e93\u5e73\u53f0\u65f6\uff0c\u6211\u672c\u6765\u662f\u6253\u7b97\u7528`Github`\u7684\uff0c\u4f46\u662f`Github`\u7684\u767b\u5f55\u7279\u522b\u7e41\u7410\uff0c\u5e72\u8106\u6539\u7528`Gitlab`\u7b97\u4e86\uff0c\u800c\u4e14`Gitlab`\u5728\u4e2d\u56fd\u5730\u533a\u53ef\u4ee5\u6b63\u5e38\u8bbf\u95ee\uff0c\u800c\u4e0d\u50cf`Github`\u4e00\u6837\uff0c\u8001\u662f\u767b\u4e0d\u4e0a\u53bb\n\n\n## \u7248\u672c\u8bb0\u5f55 / Version Records\n\n> `0.0.1`\n>> `0011` \u7b2c\u4e00\u6b21\u53d1\u5e03\uff0c\u5305\u542b `bar`, `breadcrumbs`, `breadcrumbs_el`, `space`, `toolbar`, `toolbar_title`\u7ec4\u4ef6\n\n> `0.0.2`\n>> `0021` \u8865\u5145\u9879\u76ee\u8d44\u6599\n>\n>> `0022` \u6dfb\u52a0\u7ec4\u4ef6`Intersection / \u4ea4\u53c9`\uff0c\u53ef\u4ee5\u4e3a`ui.Card`\u7ec4\u4ef6\u505a\u663e\u793a\u6548\u679c\n\n> `0.0.3`\n>> `0031` \u8865\u5145\u9879\u76ee\u8d44\u6599\n\n> `0.0.4`\n>> `0041` \u6dfb\u52a0\u7ec4\u4ef6`ButtonGroup / \u6309\u94ae\u7ec4`",
"bugtrack_url": null,
"license": "",
"summary": "nicegui\u8865\u5145\u7ec4\u4ef6",
"version": "0.0.4",
"project_urls": {
"Documentation": "https://nicegui-add.netlify.app",
"Homepage": "https://gitlab.com/XiangQinxi/nicegui-add",
"Repository": "https://gitlab.com/XiangQinxi/nicegui-add"
},
"split_keywords": [
"nicegui",
"web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6863ee9f51a17644a51ad5d540d86e3612ed329c803e352090932fc6fa8f6675",
"md5": "2f28e72021f7ae79b17d394e9ddbb136",
"sha256": "4922b59af1486f14af6d18cb1e4c7e47b35d47f50b09108b33bf6c126db26150"
},
"downloads": -1,
"filename": "nicegui_add-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f28e72021f7ae79b17d394e9ddbb136",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 9800,
"upload_time": "2023-11-17T11:47:02",
"upload_time_iso_8601": "2023-11-17T11:47:02.546347Z",
"url": "https://files.pythonhosted.org/packages/68/63/ee9f51a17644a51ad5d540d86e3612ed329c803e352090932fc6fa8f6675/nicegui_add-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bbb5b93e601aa7753ab69debb2e272a6fe4d5f2455a876ae31212ae853387270",
"md5": "de66afdf8974f54af0cf53c9a5f2150d",
"sha256": "28dd0f705ffd838d70a9f67599b49f44b2a12c1a9e5604ea56c54579defee05c"
},
"downloads": -1,
"filename": "nicegui_add-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "de66afdf8974f54af0cf53c9a5f2150d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 8108,
"upload_time": "2023-11-17T11:47:05",
"upload_time_iso_8601": "2023-11-17T11:47:05.637060Z",
"url": "https://files.pythonhosted.org/packages/bb/b5/b93e601aa7753ab69debb2e272a6fe4d5f2455a876ae31212ae853387270/nicegui_add-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-17 11:47:05",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "XiangQinxi",
"gitlab_project": "nicegui-add",
"lcname": "nicegui-add"
}
JSON