updated document document

change.md

@@ -1,3 +1,14 @@
+# 0.6.14
+- Allow custom fragement as page 
+```python 
+INPUTZENPAGE = ZenPage(
+    name="Inputs",
+    icon="delete",
+    page=inputPage,
+    tab_number=0,
+    custom_name="my_page"
+)
+```
 # 0.6.13
 - fixing date issue 
 - You can pass `date.today().isoformat()` or `datetime.now().isoformat()`

demo/main.py

@@ -123,7 +123,6 @@ async def scripts(request: Request):
 
 @app.websocket("/backend/ws")
 async def websocket_func(websocket: WebSocket):
-    print("hi")
     p = [BOXPAGE, CHARTPAGE, TABLEPAGE, CUSTOMPAGE]
     await websocket.accept()
     while True:

demo/pages/input_page/__init__.py

@@ -78,5 +78,6 @@
     name="Inputs",
     icon="delete",
     page=inputPage,
-    tab_number=0
+    tab_number=0,
+    custom_name="my_page"
 )

docs/_modules/zen_dash/objects.html

@@ -65,7 +65,7 @@
            <div itemprop="articleBody">
 
   <h1>Source code for zen_dash.objects</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Type</span>
+<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Type</span>
 <span class="kn">from</span> <span class="nn">pydantic</span> <span class="kn">import</span> <span class="n">BaseModel</span><span class="p">,</span> <span class="n">root_validator</span>
 
 <span class="kn">from</span> <span class="nn">zen_dash.objects.page</span> <span class="kn">import</span> <span class="n">Page</span>
@@ -109,7 +109,8 @@ <h1>Source code for zen_dash.objects</h1><div class="highlight"><pre>
     <span class="n">websocket_calls</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Type</span><span class="p">[</span><span class="n">Zen</span><span class="p">]]</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="n">pydantic_class</span><span class="p">:</span> <span class="n">Type</span><span class="p">[</span><span class="n">BaseModel</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="n">tab_number</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
-    <span class="n">subtab_number</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span></div>
+    <span class="n">subtab_number</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
+    <span class="n">custom_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span></div>
 
 <div class="viewcode-block" id="RefreshInfo"><a class="viewcode-back" href="../../zen_dash.objects.html#zen_dash.objects.RefreshInfo">[docs]</a><span class="k">class</span> <span class="nc">RefreshInfo</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
     <span class="n">refresh</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>

docs/_modules/zen_dash/page.html

@@ -73,6 +73,7 @@ <h1>Source code for zen_dash.page</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="get_page_dict"><a class="viewcode-back" href="../../zen_dash.html#zen_dash.page.get_page_dict">[docs]</a><span class="k">def</span> <span class="nf">get_page_dict</span><span class="p">(</span><span class="n">pages</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">ZenPage</span><span class="p">]):</span>
     <span class="n">page_dict</span> <span class="o">=</span> <span class="p">{}</span>
+    <span class="n">custom_dict</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">pages</span><span class="p">:</span>
         <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">tab_number</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Tab number is not define in Zen Page&quot;</span><span class="p">)</span>
@@ -87,13 +88,21 @@ <h1>Source code for zen_dash.page</h1><div class="highlight"><pre>
 
         <span class="k">else</span><span class="p">:</span>
             <span class="n">page_dict</span><span class="p">[</span><span class="n">page_number</span><span class="p">]</span> <span class="o">=</span> <span class="n">p</span>
-    <span class="k">return</span> <span class="n">page_dict</span></div>
+
+        <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">custom_name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="n">custom_dict</span><span class="p">[</span><span class="n">p</span><span class="o">.</span><span class="n">custom_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">p</span>
+    <span class="k">return</span> <span class="n">page_dict</span><span class="p">,</span> <span class="n">custom_dict</span></div>
 
 <div class="viewcode-block" id="RenderPage"><a class="viewcode-back" href="../../zen_dash.html#zen_dash.page.RenderPage">[docs]</a><span class="k">def</span> <span class="nf">RenderPage</span><span class="p">(</span><span class="n">pages</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">ZenPage</span><span class="p">],</span> <span class="n">fragment</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
-    <span class="n">PAGEDICT</span> <span class="o">=</span> <span class="n">get_page_dict</span><span class="p">(</span><span class="n">pages</span><span class="p">)</span>
+    <span class="n">PAGEDICT</span><span class="p">,</span> <span class="n">CUSTOMDICT</span> <span class="o">=</span> <span class="n">get_page_dict</span><span class="p">(</span><span class="n">pages</span><span class="p">)</span>
+
     <span class="n">p</span> <span class="o">=</span> <span class="n">PAGEDICT</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">fragment</span><span class="p">)</span>
+    <span class="n">p1</span> <span class="o">=</span> <span class="n">CUSTOMDICT</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">fragment</span><span class="p">)</span>
+
     <span class="k">if</span> <span class="n">p</span><span class="p">:</span>
         <span class="k">return</span> <span class="n">p</span><span class="o">.</span><span class="n">page</span>
+    <span class="k">elif</span> <span class="n">p1</span><span class="p">:</span>
+        <span class="k">return</span> <span class="n">p1</span><span class="o">.</span><span class="n">page</span>
     <span class="k">else</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Page is not define&quot;</span><span class="p">)</span></div>
 </pre></div>

docs/genindex.html

@@ -192,10 +192,10 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="zen_dash.objects.html#zen_dash.objects.instances.ButtonFloating.color">color (zen_dash.objects.instances.ButtonFloating attribute)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="zen_dash.objects.html#zen_dash.objects.instances.TableColumn.columnDef">columnDef (zen_dash.objects.instances.TableColumn attribute)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="zen_dash.objects.html#zen_dash.objects.instances.TableData.columns">columns (zen_dash.objects.instances.TableData attribute)</a>
 </li>
       <li><a href="zen_dash.tag.html#zen_dash.tag.TAG.compile">compile() (zen_dash.tag.TAG method)</a>
@@ -211,6 +211,8 @@ <h2 id="C">C</h2>
       <li><a href="zen_dash.objects.html#zen_dash.objects.instances.ReturnData.custom_html_data">custom_html_data (zen_dash.objects.instances.ReturnData attribute)</a>
 </li>
       <li><a href="zen_dash.objects.html#zen_dash.objects.instances.DisplayDialog.custom_message">custom_message (zen_dash.objects.instances.DisplayDialog attribute)</a>
+</li>
+      <li><a href="zen_dash.objects.html#zen_dash.objects.ZenPage.custom_name">custom_name (zen_dash.objects.ZenPage attribute)</a>
 </li>
       <li><a href="zen_dash.objects.html#zen_dash.objects.instances.CustomHTML">CustomHTML (class in zen_dash.objects.instances)</a>
 </li>

docs/zen_dash.objects.html

@@ -1862,8 +1862,13 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="py class">
 <dt class="sig sig-object py" id="zen_dash.objects.ZenPage">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zen_dash.objects.</span></span><span class="sig-name descname"><span class="pre">ZenPage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">icon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#zen_dash.objects.page.Page" title="zen_dash.objects.page.Page"><span class="pre">Page</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_calls</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#zen_dash.objects.Zen" title="zen_dash.objects.Zen"><span class="pre">Zen</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pydantic_class</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">BaseModel</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tab_number</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subtab_number</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zen_dash/objects.html#ZenPage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zen_dash.objects.ZenPage" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">zen_dash.objects.</span></span><span class="sig-name descname"><span class="pre">ZenPage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">icon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#zen_dash.objects.page.Page" title="zen_dash.objects.page.Page"><span class="pre">Page</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">websocket_calls</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#zen_dash.objects.Zen" title="zen_dash.objects.Zen"><span class="pre">Zen</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pydantic_class</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">BaseModel</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tab_number</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subtab_number</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/zen_dash/objects.html#ZenPage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#zen_dash.objects.ZenPage" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="zen_dash.objects.ZenPage.custom_name">
+<span class="sig-name descname"><span class="pre">custom_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#zen_dash.objects.ZenPage.custom_name" title="Permalink to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="zen_dash.objects.ZenPage.icon">
 <span class="sig-name descname"><span class="pre">icon</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#zen_dash.objects.ZenPage.icon" title="Permalink to this definition"></a></dt>

frontend/src/app/page/page.component.ts

@@ -30,6 +30,7 @@ export class PageComponent implements OnInit {
   ngOnInit(): void {
     new SetTitleService().set_title(this.aRoute, this.titleService, this.http);
     this.aRoute.queryParamMap.subscribe((fragment) => {
+
       let page = this.dataService.get_page()
       let params = new HttpParams().set('fragment', page);
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zen_dash"
-version = "0.6.13"
+version = "0.6.14"
 license = "MIT"
 description = "Simple yet scable and production ready python dashboard that is better than shiny application for business."
 readme = "README.md"