More Docs

codespede · Nov 14, 2021 · e52bc38 · e52bc38
1 parent 46251c6
commit e52bc38
Show file tree

Hide file tree

Showing 50 changed files with 1,249 additions and 780 deletions.
diff --git a/docs/api-docs/assets/highlight.css b/docs/api-docs/assets/highlight.css
@@ -1,26 +1,26 @@
 :root {
     --light-hl-0: #000000;
-    --dark-hl-0: #C8C8C8;
-    --light-hl-1: #000000;
-    --dark-hl-1: #D4D4D4;
-    --light-hl-2: #008000;
-    --dark-hl-2: #6A9955;
-    --light-hl-3: #001080;
-    --dark-hl-3: #9CDCFE;
-    --light-hl-4: #0000FF;
-    --dark-hl-4: #569CD6;
-    --light-hl-5: #AF00DB;
-    --dark-hl-5: #C586C0;
-    --light-hl-6: #A31515;
-    --dark-hl-6: #CE9178;
+    --dark-hl-0: #D4D4D4;
+    --light-hl-1: #AF00DB;
+    --dark-hl-1: #C586C0;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
+    --light-hl-3: #A31515;
+    --dark-hl-3: #CE9178;
+    --light-hl-4: #008000;
+    --dark-hl-4: #6A9955;
+    --light-hl-5: #0000FF;
+    --dark-hl-5: #569CD6;
+    --light-hl-6: #0070C1;
+    --dark-hl-6: #4FC1FF;
     --light-hl-7: #795E26;
     --dark-hl-7: #DCDCAA;
-    --light-hl-8: #098658;
-    --dark-hl-8: #B5CEA8;
-    --light-hl-9: #267F99;
-    --dark-hl-9: #4EC9B0;
-    --light-hl-10: #0070C1;
-    --dark-hl-10: #4FC1FF;
+    --light-hl-8: #000000;
+    --dark-hl-8: #C8C8C8;
+    --light-hl-9: #098658;
+    --dark-hl-9: #B5CEA8;
+    --light-hl-10: #267F99;
+    --dark-hl-10: #4EC9B0;
     --light-hl-11: #CD3131;
     --dark-hl-11: #F44747;
     --light-code-background: #FFFFFF;

diff --git a/docs/api-docs/assets/search.js b/docs/api-docs/assets/search.js
diff --git a/docs/api-docs/classes/ActionColumn.html b/docs/api-docs/classes/ActionColumn.html
diff --git a/docs/api-docs/classes/ActiveDataProvider.html b/docs/api-docs/classes/ActiveDataProvider.html
diff --git a/docs/api-docs/classes/ActiveField.html b/docs/api-docs/classes/ActiveField.html
diff --git a/docs/api-docs/classes/ActiveForm.html b/docs/api-docs/classes/ActiveForm.html
diff --git a/docs/api-docs/classes/Application.html b/docs/api-docs/classes/Application.html
diff --git a/docs/api-docs/classes/ArrayDataProvider.html b/docs/api-docs/classes/ArrayDataProvider.html
diff --git a/docs/api-docs/classes/CheckboxColumn.html b/docs/api-docs/classes/CheckboxColumn.html
diff --git a/docs/api-docs/classes/CollectionView.html b/docs/api-docs/classes/CollectionView.html
diff --git a/docs/api-docs/classes/Column.html b/docs/api-docs/classes/Column.html
diff --git a/docs/api-docs/classes/Component.html b/docs/api-docs/classes/Component.html
@@ -1,9 +1,9 @@
 <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Component | pwoli</title><meta name="description" content="Documentation for pwoli"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">pwoli</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">pwoli</a></li><li><a href="Component.html">Component</a></li></ul><h1>Class Component</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Component is the base class for all the other classes in Pwoli</p>
 </div><dl class="tsd-comment-tags"><dt>author</dt><dd><p>Mahesh S Warrier <a href="https://github.com/codespede">https://github.com/codespede</a></p>
-</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Component</span><ul class="tsd-hierarchy"><li><a href="ActiveField.html" class="tsd-signature-type" data-tsd-kind="Class">ActiveField</a></li><li><a href="Application.html" class="tsd-signature-type" data-tsd-kind="Class">Application</a></li><li><a href="Column.html" class="tsd-signature-type" data-tsd-kind="Class">Column</a></li><li><a href="DataHelper.html" class="tsd-signature-type" data-tsd-kind="Class">DataHelper</a></li><li><a href="DataProvider.html" class="tsd-signature-type" data-tsd-kind="Class">DataProvider</a></li><li><a href="Html.html" class="tsd-signature-type" data-tsd-kind="Class">Html</a></li><li><a href="Pagination.html" class="tsd-signature-type" data-tsd-kind="Class">Pagination</a></li><li><a href="Sort.html" class="tsd-signature-type" data-tsd-kind="Class">Sort</a></li><li><a href="View.html" class="tsd-signature-type" data-tsd-kind="Class">View</a></li><li><a href="Widget.html" class="tsd-signature-type" data-tsd-kind="Class">Widget</a></li><li><a href="Serializer.html" class="tsd-signature-type" data-tsd-kind="Class">Serializer</a></li><li><a href="../interfaces/IORMAdapter.html" class="tsd-signature-type" data-tsd-kind="Interface">IORMAdapter</a></li><li><a href="ORMAdapter.html" class="tsd-signature-type" data-tsd-kind="Class">ORMAdapter</a></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Component.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="Component.html#initialization" class="tsd-kind-icon">initialization</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="Component.html#init" class="tsd-kind-icon">init</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Component<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Component.html" class="tsd-signature-type" data-tsd-kind="Class">Component</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/internetmango/pwoli/blob/23c7e71/src/base/Component.ts#L11">base/Component.ts:11</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>config: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Component.html" class="tsd-signature-type" data-tsd-kind="Class">Component</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="initialization" class="tsd-anchor"></a><h3>initialization</h3><div class="tsd-signature tsd-kind-icon">initialization<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/internetmango/pwoli/blob/23c7e71/src/base/Component.ts#L10">base/Component.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Component</span><ul class="tsd-hierarchy"><li><a href="Application.html" class="tsd-signature-type" data-tsd-kind="Class">Application</a></li><li><a href="Column.html" class="tsd-signature-type" data-tsd-kind="Class">Column</a></li><li><a href="DataHelper.html" class="tsd-signature-type" data-tsd-kind="Class">DataHelper</a></li><li><a href="DataProvider.html" class="tsd-signature-type" data-tsd-kind="Class">DataProvider</a></li><li><a href="Html.html" class="tsd-signature-type" data-tsd-kind="Class">Html</a></li><li><a href="Pagination.html" class="tsd-signature-type" data-tsd-kind="Class">Pagination</a></li><li><a href="Sort.html" class="tsd-signature-type" data-tsd-kind="Class">Sort</a></li><li><a href="View.html" class="tsd-signature-type" data-tsd-kind="Class">View</a></li><li><a href="Widget.html" class="tsd-signature-type" data-tsd-kind="Class">Widget</a></li><li><a href="Serializer.html" class="tsd-signature-type" data-tsd-kind="Class">Serializer</a></li><li><a href="ActiveField.html" class="tsd-signature-type" data-tsd-kind="Class">ActiveField</a></li><li><a href="../interfaces/IORMAdapter.html" class="tsd-signature-type" data-tsd-kind="Interface">IORMAdapter</a></li><li><a href="ORMAdapter.html" class="tsd-signature-type" data-tsd-kind="Class">ORMAdapter</a></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Component.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="Component.html#initialization" class="tsd-kind-icon">initialization</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="Component.html#init" class="tsd-kind-icon">init</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Component<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Component.html" class="tsd-signature-type" data-tsd-kind="Class">Component</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/internetmango/pwoli/blob/46251c6/src/base/Component.ts#L11">base/Component.ts:11</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>config: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Component.html" class="tsd-signature-type" data-tsd-kind="Class">Component</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="initialization" class="tsd-anchor"></a><h3>initialization</h3><div class="tsd-signature tsd-kind-icon">initialization<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/internetmango/pwoli/blob/46251c6/src/base/Component.ts#L10">base/Component.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>A Promise which resolves when this Component has been successfully initialized.</p>
-</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="init" class="tsd-anchor"></a><h3>init</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/internetmango/pwoli/blob/23c7e71/src/base/Component.ts#L20">base/Component.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="init" class="tsd-anchor"></a><h3>init</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/internetmango/pwoli/blob/46251c6/src/base/Component.ts#L20">base/Component.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Initializes the object.
 This method is invoked at the end of the constructor after the object is initialized with the
 given configuration.</p>