Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Commit

Permalink
update typedoc readme
Browse files Browse the repository at this point in the history
  • Loading branch information
blutorange committed Jan 15, 2020
1 parent d10432b commit b5d38a2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
10 changes: 6 additions & 4 deletions docs/typedoc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,12 @@ <h1>Overview</h1>
consists of the following pieces:</p>
<ul>
<li>You can use <code>PF(&quot;editor&quot;)</code> to get access to the widget instance. This will
return an instance of <a href="./interfaces/primefaces.widget.extmonacoeditor.html">ExtMonacoEditor</a>.</li>
<li>If specified, the <code>extender</code> needs to evaluate to an instance of
<a href="./interfaces/monacoextender.html">MonacoExtender</a>. It lets you customize the
editor if the widget options should not suffice.</li>
return an instance of <a href="./interfaces/primefaces.widget.extmonacoeditorinline.html">ExtMonacoEditorInline</a> or <a href="./interfaces/primefaces.widget.extmonacoeditorframed.html">ExtMonacoEditorFramed</a>.</li>
<li>If specified, the <code>extender</code> needs to either evaluate to an instance of
<a href="./interfaces/monacoextenderinline.html">MonacoExtenderInline</a> (inline widget); or
be an URL to a script that creates an instance of <a href="./interfaces/monacoextenderframed.html">MonacoExtenderFramed</a>
(framed widget) and saves it to <code>window.MonacoEnvironment.Extender</code>. It lets you
customize the editor if the widget options should not suffice.</li>
<li>If you use this widget, the monaco editor library will be loaded and is available
via <a href="./modules/monaco.html">window.monaco</a>. This is the same as the
<a href="https://microsoft.github.io/monaco-editor/api/index.html">official monaco editor API</a>.</li>
Expand Down
10 changes: 6 additions & 4 deletions src/npm/typedoc-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ See [here](../vdldoc/index.html) for the tag documentation. The client-side API
consists of the following pieces:

* You can use `PF("editor")` to get access to the widget instance. This will
return an instance of [ExtMonacoEditor](./interfaces/primefaces.widget.extmonacoeditor.html).
* If specified, the `extender` needs to evaluate to an instance of
[MonacoExtender](./interfaces/monacoextender.html). It lets you customize the
editor if the widget options should not suffice.
return an instance of [ExtMonacoEditorInline](./interfaces/primefaces.widget.extmonacoeditorinline.html) or [ExtMonacoEditorFramed](./interfaces/primefaces.widget.extmonacoeditorframed.html).
* If specified, the `extender` needs to either evaluate to an instance of
[MonacoExtenderInline](./interfaces/monacoextenderinline.html) (inline widget); or
be an URL to a script that creates an instance of [MonacoExtenderFramed](./interfaces/monacoextenderframed.html)
(framed widget) and saves it to `window.MonacoEnvironment.Extender`. It lets you
customize the editor if the widget options should not suffice.
* If you use this widget, the monaco editor library will be loaded and is available
via [window.monaco](./modules/monaco.html). This is the same as the
[official monaco editor API](https://microsoft.github.io/monaco-editor/api/index.html).

0 comments on commit b5d38a2

Please sign in to comment.