Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@zadam
zadam committed Nov 3, 2023
1 parent a45b801 commit 6dd466d
Show file tree
Hide file tree
Showing 9 changed files with 124 additions and 141 deletions.
6 changes: 3 additions & 3 deletions docs/backend_api/becca_entities_bnote.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h1 class="page-title">Source: becca/entities/bnote.js</h1>
this.utcDateCreated = utcDateCreated || dateUtils.utcNowDateTime();
/** @type {string} */
this.utcDateModified = utcDateModified;
/**
/**
* set during the deletion operation, before it is completed (removed from becca completely)
* @type {boolean}
*/
Expand Down Expand Up @@ -784,7 +784,7 @@ <h1 class="page-title">Source: becca/entities/bnote.js</h1>
} else if (a.parentNote?.isHiddenCompletely()) {
return 1;
} else {
return -1;
return 0;
}
});

Expand All @@ -804,7 +804,7 @@ <h1 class="page-title">Source: becca/entities/bnote.js</h1>
const aBranch = becca.getBranchFromChildAndParent(a.noteId, this.noteId);
const bBranch = becca.getBranchFromChildAndParent(b.noteId, this.noteId);

return aBranch?.notePosition &lt; bBranch?.notePosition ? -1 : 1;
return (aBranch?.notePosition - bBranch?.notePosition) || 0;
});
}

Expand Down
27 changes: 3 additions & 24 deletions docs/frontend_api/BasicWidget.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ <h5>Returns:</h5>



<h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span class="signature">()</span><span class="type-signature"> &rarr; {JQuery.&lt;HTMLElement>}</span></h4>
<h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span class="signature">()</span><span class="type-signature"></span></h4>



Expand All @@ -321,6 +321,7 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span
Method used for rendering the widget.

Your class should override this method.
The method is expected to create a this.$widget containing jQuery object
</div>


Expand Down Expand Up @@ -364,7 +365,7 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line131">line 131</a>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line132">line 132</a>
</li></ul></dd>


Expand All @@ -389,28 +390,6 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span



<h5>Returns:</h5>


<div class="param-desc">
Your widget.
</div>



<dl>
<dt>
Type
</dt>
<dd>

<span class="param-type">JQuery.&lt;HTMLElement></span>


</dd>
</dl>





Expand Down
27 changes: 3 additions & 24 deletions docs/frontend_api/NoteContextAwareWidget.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ <h5>Returns:</h5>



<h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span class="signature">()</span><span class="type-signature"> &rarr; {JQuery.&lt;HTMLElement>}</span></h4>
<h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span class="signature">()</span><span class="type-signature"></span></h4>



Expand All @@ -639,6 +639,7 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span
Method used for rendering the widget.

Your class should override this method.
The method is expected to create a this.$widget containing jQuery object
</div>


Expand Down Expand Up @@ -687,7 +688,7 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line131">line 131</a>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line132">line 132</a>
</li></ul></dd>


Expand All @@ -712,28 +713,6 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span



<h5>Returns:</h5>


<div class="param-desc">
Your widget.
</div>



<dl>
<dt>
Type
</dt>
<dd>

<span class="param-type">JQuery.&lt;HTMLElement></span>


</dd>
</dl>





Expand Down
86 changes: 45 additions & 41 deletions docs/frontend_api/RightPanelWidget.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ <h4 class="name" id="RightPanelWidget"><span class="type-signature"></span>new R

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_right_panel_widget.js.html">widgets/right_panel_widget.js</a>, <a href="widgets_right_panel_widget.js.html#line16">line 16</a>
<a href="widgets_right_panel_widget.js.html">widgets/right_panel_widget.js</a>, <a href="widgets_right_panel_widget.js.html#line19">line 19</a>
</li></ul></dd>


Expand Down Expand Up @@ -172,8 +172,10 @@ <h4 class="name" id="hoistedNoteId"><span class="type-signature"></span>hoistedN



<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>


<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="NoteContextAwareWidget.html#hoistedNoteId">NoteContextAwareWidget#hoistedNoteId</a>
</li></ul></dd>

Expand All @@ -194,8 +196,6 @@ <h4 class="name" id="hoistedNoteId"><span class="type-signature"></span>hoistedN






<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Expand Down Expand Up @@ -235,8 +235,10 @@ <h4 class="name" id="note"><span class="type-signature"></span>note<span class="



<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>


<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="NoteContextAwareWidget.html#note">NoteContextAwareWidget#note</a>
</li></ul></dd>

Expand All @@ -257,8 +259,6 @@ <h4 class="name" id="note"><span class="type-signature"></span>note<span class="






<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Expand Down Expand Up @@ -308,8 +308,10 @@ <h5>Type:</h5>



<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>


<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="NoteContextAwareWidget.html#noteContext">NoteContextAwareWidget#noteContext</a>
</li></ul></dd>

Expand All @@ -330,8 +332,6 @@ <h5>Type:</h5>






<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Expand Down Expand Up @@ -371,8 +371,10 @@ <h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span cla



<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>


<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="NoteContextAwareWidget.html#noteId">NoteContextAwareWidget#noteId</a>
</li></ul></dd>

Expand All @@ -393,8 +395,6 @@ <h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span cla






<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Expand Down Expand Up @@ -434,8 +434,10 @@ <h4 class="name" id="notePath"><span class="type-signature"></span>notePath<span



<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>


<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="NoteContextAwareWidget.html#notePath">NoteContextAwareWidget#notePath</a>
</li></ul></dd>

Expand All @@ -456,8 +458,6 @@ <h4 class="name" id="notePath"><span class="type-signature"></span>notePath<span






<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Expand Down Expand Up @@ -523,7 +523,7 @@ <h4 class="name" id="widgetTitle"><span class="type-signature"></span>widgetTitl

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_right_panel_widget.js.html">widgets/right_panel_widget.js</a>, <a href="widgets_right_panel_widget.js.html#line18">line 18</a>
<a href="widgets_right_panel_widget.js.html">widgets/right_panel_widget.js</a>, <a href="widgets_right_panel_widget.js.html#line21">line 21</a>
</li></ul></dd>


Expand Down Expand Up @@ -629,14 +629,14 @@ <h5>Parameters:</h5>




<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="BasicWidget.html#cssBlock">BasicWidget#cssBlock</a>
</li></ul></dd>



<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="NoteContextAwareWidget.html#cssBlock">NoteContextAwareWidget#cssBlock</a>
</li></ul></dd>




Expand Down Expand Up @@ -724,6 +724,7 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span

<div class="description">
Do not override this method unless you know what you're doing.
Do not override this method unless you know what you're doing.
</div>


Expand Down Expand Up @@ -772,7 +773,7 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_right_panel_widget.js.html">widgets/right_panel_widget.js</a>, <a href="widgets_right_panel_widget.js.html#line25">line 25</a>
<a href="widgets_right_panel_widget.js.html">widgets/right_panel_widget.js</a>, <a href="widgets_right_panel_widget.js.html#line37">line 37</a>
</li></ul></dd>


Expand Down Expand Up @@ -808,15 +809,15 @@ <h4 class="name" id="doRender"><span class="type-signature"></span>doRender<span



<h4 class="name" id="doRenderBody"><span class="type-signature">(async) </span>doRenderBody<span class="signature">()</span><span class="type-signature"> &rarr; {JQuery.&lt;HTMLElement>}</span></h4>
<h4 class="name" id="doRenderBody"><span class="type-signature">(async) </span>doRenderBody<span class="signature">()</span><span class="type-signature"> &rarr; {Promise|undefined}</span></h4>






<div class="description">
Method used for rendering the body of the widget.
Method used for rendering the body of the widget (via existing this.$body)

Your class should override this method.
</div>
Expand Down Expand Up @@ -862,7 +863,7 @@ <h4 class="name" id="doRenderBody"><span class="type-signature">(async) </span>d

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_right_panel_widget.js.html">widgets/right_panel_widget.js</a>, <a href="widgets_right_panel_widget.js.html#line47">line 47</a>
<a href="widgets_right_panel_widget.js.html">widgets/right_panel_widget.js</a>, <a href="widgets_right_panel_widget.js.html#line66">line 66</a>
</li></ul></dd>


Expand Down Expand Up @@ -891,7 +892,7 @@ <h5>Returns:</h5>


<div class="param-desc">
The body of your widget.
if widget needs async operation to initialize, it can return a Promise
</div>


Expand All @@ -902,7 +903,10 @@ <h5>Returns:</h5>
</dt>
<dd>

<span class="param-type">JQuery.&lt;HTMLElement></span>
<span class="param-type">Promise</span>
|

<span class="param-type">undefined</span>


</dd>
Expand Down Expand Up @@ -946,8 +950,10 @@ <h4 class="name" id="isEnabled"><span class="type-signature"></span>isEnabled<sp



<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>


<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="NoteContextAwareWidget.html#isEnabled">NoteContextAwareWidget#isEnabled</a>
</li></ul></dd>

Expand All @@ -968,8 +974,6 @@ <h4 class="name" id="isEnabled"><span class="type-signature"></span>isEnabled<sp






<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Expand Down Expand Up @@ -1111,8 +1115,10 @@ <h5>Parameters:</h5>



<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>


<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="NoteContextAwareWidget.html#refreshWithNote">NoteContextAwareWidget#refreshWithNote</a>
</li></ul></dd>

Expand All @@ -1133,8 +1139,6 @@ <h5>Parameters:</h5>






<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Expand Down
Loading

0 comments on commit 6dd466d

Please sign in to comment.