Skip to content

Handle load in docs #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 21, 2022
Merged

Handle load in docs #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba63a70
chore: handle load in docs
ariansobczak-rst Feb 21, 2022
dbde1bb
chore: handle load in docs
ariansobczak-rst Feb 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion better-docs
Open in desktop
Submodule better-docs updated 5 files
+2 −0 fixtures/typescript/abstract-class.ts
+24 −0 fixtures/typescript/index.doc.md
+8 −0 fixtures/typescript/index.ts
+4 −1 jsdoc.json
+1 −1 load.js
84 changes: 42 additions & 42 deletions docs/Action.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/ActionButton.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ <h4 class="name" id="ActionButton">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Renders Button which redirects to given action</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Renders Button which redirects to given action
<h3>Usage</h3>
<pre class="prettyprint source"><code>import { ActionButton } from 'adminjs'
</code></pre>
Expand Down
24 changes: 12 additions & 12 deletions docs/ActionDecorator.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ <h4 class="name" id="action">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Original action object</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Original action object
</div>


Expand Down Expand Up @@ -558,7 +558,7 @@ <h4 class="name" id="canInvokeAction">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Indicates if user can invoke given action</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Indicates if user can invoke given action
</div>


Expand Down Expand Up @@ -756,7 +756,7 @@ <h4 class="name" id="handler">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Original handler wrapped with the hook <code>before</code> and <code>after</code> methods.</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Original handler wrapped with the hook `before` and `after` methods.
</div>


Expand Down Expand Up @@ -981,7 +981,7 @@ <h4 class="name" id="invokeAfterHook">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Invokes after action hooks if there are any</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Invokes after action hooks if there are any
</div>


Expand Down Expand Up @@ -1206,7 +1206,7 @@ <h4 class="name" id="invokeBeforeHook">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Invokes before action hooks if there are any</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Invokes before action hooks if there are any
</div>


Expand Down Expand Up @@ -1406,7 +1406,7 @@ <h4 class="name" id="invokeHandler">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Invokes action handler if there is any</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Invokes action handler if there is any
</div>


Expand Down Expand Up @@ -1627,7 +1627,7 @@ <h4 class="name" id="isAccessible">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Is action accessible</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Is action accessible
</div>


Expand Down Expand Up @@ -1845,7 +1845,7 @@ <h4 class="name" id="isBulkType">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Returns true when action can be performed on selected records</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Returns true when action can be performed on selected records
</div>


Expand Down Expand Up @@ -1965,7 +1965,7 @@ <h4 class="name" id="isRecordType">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Returns true when action can be performed on a record</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Returns true when action can be performed on a record
</div>


Expand Down Expand Up @@ -2085,7 +2085,7 @@ <h4 class="name" id="isResourceType">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Returns true when action can be performed on an entire resource</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Returns true when action can be performed on an entire resource
</div>


Expand Down Expand Up @@ -2205,7 +2205,7 @@ <h4 class="name" id="isVisible">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Is action visible in the UI</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Is action visible in the UI
</div>


Expand Down Expand Up @@ -2423,7 +2423,7 @@ <h4 class="name" id="toJSON">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Serializes action to JSON format</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Serializes action to JSON format
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/ActionHeader.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ <h4 class="name" id="ActionHeader">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Header of an action. It renders Action name with buttons for all the actions.</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Header of an action. It renders Action name with buttons for all the actions.
<h3>Usage</h3>
<pre class="prettyprint source"><code>import { ActionHeader } from 'adminjs'
</code></pre>
Expand Down
38 changes: 19 additions & 19 deletions docs/ActionJSON.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ <h2>ActionJSON</h2>
<div class="container-overview">


<div class="description"><script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>JSON representation of an <a href="Action.html">Action</a></p></div>
<div class="description"><script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>JSON representation of an <a href="Action.html">Action</a></div>



Expand Down Expand Up @@ -301,7 +301,7 @@ <h4 class="name" id="actionType">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Type of an action</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Type of an action
</div>


Expand Down Expand Up @@ -386,8 +386,8 @@ <h4 class="name" id="component">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Action component. When set to false action will be invoked immediately after clicking it,
to put in another words: there wont be an action view</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Action component. When set to false action will be invoked immediately after clicking it,
<p>to put in another words: there wont be an action view</p>
</div>


Expand Down Expand Up @@ -470,7 +470,7 @@ <h4 class="name" id="containerWidth">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>containerWidth passed from the action setup.</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>containerWidth passed from the action setup.
</div>


Expand Down Expand Up @@ -547,7 +547,7 @@ <h4 class="name" id="custom">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Any custom options passed from the <a href="Action.html">Action</a> configuration.</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Any custom options passed from the <a href="Action.html">Action</a> configuration.
</div>


Expand Down Expand Up @@ -626,7 +626,7 @@ <h4 class="name" id="guard">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Guarding message which should be presented in <code>alert()</code> after clicking the action button</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Guarding message which should be presented in `alert()` after clicking the action button
</div>


Expand Down Expand Up @@ -703,7 +703,7 @@ <h4 class="name" id="hasHandler">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Indicates if action has action handler defined</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Indicates if action has action handler defined
</div>


Expand Down Expand Up @@ -780,7 +780,7 @@ <h4 class="name" id="hideActionHeader">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Whether given action have an action header</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Whether given action have an action header
</div>


Expand Down Expand Up @@ -859,7 +859,7 @@ <h4 class="name" id="icon">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Action icon</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Action icon
</div>


Expand Down Expand Up @@ -936,7 +936,7 @@ <h4 class="name" id="label">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Action label - visible on the frontend</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Action label - visible on the frontend
</div>


Expand Down Expand Up @@ -1016,7 +1016,7 @@ <h4 class="name" id="layout">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Parsed layout passed in <a href="Action.html#layout">Action#layout</a></p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Parsed layout passed in <a href="Action.html#layout">Action#layout</a>
</div>


Expand Down Expand Up @@ -1093,7 +1093,7 @@ <h4 class="name" id="name">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Unique action name</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Unique action name
</div>


Expand Down Expand Up @@ -1173,7 +1173,7 @@ <h4 class="name" id="parent">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>If action is nested</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>If action is nested
</div>


Expand Down Expand Up @@ -1250,7 +1250,7 @@ <h4 class="name" id="resourceId">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Id of a resource to which given action belongs.</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Id of a resource to which given action belongs.
</div>


Expand Down Expand Up @@ -1327,7 +1327,7 @@ <h4 class="name" id="showFilter">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>If action should have a filter (for resource actions)</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>If action should have a filter (for resource actions)
</div>


Expand Down Expand Up @@ -1404,7 +1404,7 @@ <h4 class="name" id="showInDrawer">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>Whether given action should be seen in a drawer</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>Whether given action should be seen in a drawer
</div>


Expand Down Expand Up @@ -1481,7 +1481,7 @@ <h4 class="name" id="variant">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>action variant</p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>action variant
</div>


Expand Down Expand Up @@ -1569,7 +1569,7 @@ <h4 class="name" id="ParsedLayoutElement">


<div class="description">
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script><p>It is generated from Array.&lt;<a href="Action.html#LayoutElement">LayoutElement</a>> passed in <a href="Action.html#layout">Action#layout</a></p>
<script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>It is generated from Array.&lt;<a href="Action.html#LayoutElement">LayoutElement</a>> passed in <a href="Action.html#layout">Action#layout</a>
</div>


Expand Down
Loading