@suluk/editor - v0.1.0
↑ Suluk
GitHub
Preparing search index...
EditorOptions
Interface EditorOptions
interface
EditorOptions
{
pageTitle
?:
string
;
brand
?:
string
;
forkSrc
?:
string
;
clientSrc
?:
string
;
faviconHref
?:
string
;
examples
?:
EditorExample
[]
;
initialDoc
?:
unknown
;
customCss
?:
string
;
}
Index
Properties
page
Title?
brand?
fork
Src?
client
Src?
favicon
Href?
examples?
initial
Doc?
custom
Css?
Properties
Optional
page
Title
pageTitle
?:
string
Browser
+ toolbar heading suffix.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MahmoodKhalil57/suluk/blob/aaf30cfa393544c0ef54e004d9e2f37412540fa8/tooling/ts/packages/editor/src/index.ts#L17">index.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="brand"><code class="tsd-tag">Optional</code><span>brand</span><a href="#brand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">brand</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Brand shown in the toolbar (default "Suluk").</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MahmoodKhalil57/suluk/blob/aaf30cfa393544c0ef54e004d9e2f37412540fa8/tooling/ts/packages/editor/src/index.ts#L19">index.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="forksrc"><code class="tsd-tag">Optional</code><span>fork<wbr/>Src</span><a href="#forksrc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">forkSrc</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>URL of the suluk Scalar fork standalone bundle (defines window.Scalar). Default "/vendor/scalar/standalone-suluk.js".</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MahmoodKhalil57/suluk/blob/aaf30cfa393544c0ef54e004d9e2f37412540fa8/tooling/ts/packages/editor/src/index.ts#L21">index.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clientsrc"><code class="tsd-tag">Optional</code><span>client<wbr/>Src</span><a href="#clientsrc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clientSrc</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>URL of the built editor client bundle (this package's dist/editor.client.js). Default "/editor.client.js".</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MahmoodKhalil57/suluk/blob/aaf30cfa393544c0ef54e004d9e2f37412540fa8/tooling/ts/packages/editor/src/index.ts#L23">index.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="faviconhref"><code class="tsd-tag">Optional</code><span>favicon<wbr/>Href</span><a href="#faviconhref" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">faviconHref</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Favicon href.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MahmoodKhalil57/suluk/blob/aaf30cfa393544c0ef54e004d9e2f37412540fa8/tooling/ts/packages/editor/src/index.ts#L25">index.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="examples"><code class="tsd-tag">Optional</code><span>examples</span><a href="#examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">examples</span><span class="tsd-signature-symbol">?:</span> <a href="EditorExample.html" class="tsd-signature-type tsd-kind-interface">EditorExample</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Seed documents for the Examples dropdown (default: this package's examples).</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MahmoodKhalil57/suluk/blob/aaf30cfa393544c0ef54e004d9e2f37412540fa8/tooling/ts/packages/editor/src/index.ts#L27">index.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="initialdoc"><code class="tsd-tag">Optional</code><span>initial<wbr/>Doc</span><a href="#initialdoc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">initialDoc</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>Document the editor opens with when there is no ?url=, #share, or saved draft. Default: the Suluk Galaxy example.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MahmoodKhalil57/suluk/blob/aaf30cfa393544c0ef54e004d9e2f37412540fa8/tooling/ts/packages/editor/src/index.ts#L29">index.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="customcss"><code class="tsd-tag">Optional</code><span>custom<wbr/>Css</span><a href="#customcss" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">customCss</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Extra CSS appended to the page.</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/MahmoodKhalil57/suluk/blob/aaf30cfa393544c0ef54e004d9e2f37412540fa8/tooling/ts/packages/editor/src/index.ts#L31">index.ts:31</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#pagetitle"><svg viewBox="0 0 16 16" aria-hidden="true" class="tsd-kind-icon" style="color:var(--color-ts-property)"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Title</span></a><a href="#brand"><svg viewBox="0 0 16 16" aria-hidden="true" class="tsd-kind-icon" style="color:var(--color-ts-property)"><use href="../assets/icons.svg#icon-1024"></use></svg><span>brand</span></a><a href="#forksrc"><svg viewBox="0 0 16 16" aria-hidden="true" class="tsd-kind-icon" style="color:var(--color-ts-property)"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fork<wbr/>Src</span></a><a href="#clientsrc"><svg viewBox="0 0 16 16" aria-hidden="true" class="tsd-kind-icon" style="color:var(--color-ts-property)"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Src</span></a><a href="#faviconhref"><svg viewBox="0 0 16 16" aria-hidden="true" class="tsd-kind-icon" style="color:var(--color-ts-property)"><use href="../assets/icons.svg#icon-1024"></use></svg><span>favicon<wbr/>Href</span></a><a href="#examples"><svg viewBox="0 0 16 16" aria-hidden="true" class="tsd-kind-icon" style="color:var(--color-ts-property)"><use href="../assets/icons.svg#icon-1024"></use></svg><span>examples</span></a><a href="#initialdoc"><svg viewBox="0 0 16 16" aria-hidden="true" class="tsd-kind-icon" style="color:var(--color-ts-property)"><use href="../assets/icons.svg#icon-1024"></use></svg><span>initial<wbr/>Doc</span></a><a href="#customcss"><svg viewBox="0 0 16 16" aria-hidden="true" class="tsd-kind-icon" style="color:var(--color-ts-property)"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom<wbr/>Css</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://mahmoodkhalil57.github.io/suluk/" class="tsd-nav-link">↑ Suluk</a><a href="https://github.com/MahmoodKhalil57/suluk/tree/main/tooling/ts/packages/editor" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="../modules.html">@suluk/editor - v0.1.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with <a href="https://github.com/JulianWowra/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
Browser