UNPKG

ngx-editor-sodo

Version:

WYSIWYG Editor for Angular Applications

716 lines (632 loc) 32.6 kB
<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>NgxEditor</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../styles/style.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top visible-xs"> <a href="../" class="navbar-brand">NgxEditor</a> <button type="button" class="btn btn-default btn-menu fa fa-bars" id="btn-menu"></button> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"> <input type="text" placeholder="Type to search"> </div> <nav> <ul class="list"> <li class="title"> <a href="index.html" data-type="index-link">NgxEditor</a> </li> <li class="divider"></li> <li class="chapter"> <a data-type="chapter-link" href="index.html"><span class="fa fa-home"></span>Getting started</a> <ul class="links"> <li class="link"> <a href="overview.html" href="overview.html" data-type="chapter-link"> <span class="fa fa-fw fa-th"></span>Overview </a> </li> <li class="link"> <a href="index.html" data-type="chapter-link"><span class="fa fa-file-text-o"></span>README</a> </li> <li class="link"> <a href="license.html" data-type="chapter-link"> <span class="fa fa-fw fa-file-text-o"></span>LICENSE </a> </li> <li class="link"> <a href="dependencies.html" data-type="chapter-link"> <span class="fa fa-fw fa-list"></span>Dependencies </a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-additional-pages" > <span class="fa fa-fw fa-book"></span> <span>Wiki</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse" id="xs-additional-pages" > <li class="link "> <a href="additional-documentation/prerequisites.html" data-type="entity-link" data-context-id="additional">Prerequisites</a> </li> <li class="link "> <a href="additional-documentation/configuration.html" data-type="entity-link" data-context-id="additional">Configuration</a> </li> <li class="link "> <a href="additional-documentation/toolbar.html" data-type="entity-link" data-context-id="additional">Toolbar</a> </li> <li class="link "> <a href="additional-documentation/font-size.html" data-type="entity-link" data-context-id="additional">Font Size</a> </li> <li class="link "> <a href="additional-documentation/colors.html" data-type="entity-link" data-context-id="additional">Colors</a> </li> <li class="link "> <a href="additional-documentation/image-uploader.html" data-type="entity-link" data-context-id="additional">Image Uploader</a> </li> <li class="link "> <a href="additional-documentation/insert-video.html" data-type="entity-link" data-context-id="additional">Insert Video</a> </li> <li class="link "> <a href="additional-documentation/resizer.html" data-type="entity-link" data-context-id="additional">Resizer</a> </li> <li class="link "> <a href="additional-documentation/errors.html" data-type="entity-link" data-context-id="additional">Errors</a> </li> </ul> </li> <li class="chapter modules"> <a data-type="chapter-link" href="modules.html"> <div class="menu-toggler linked" data-toggle="collapse" data-target="#xs-modules-links" > <span class="fa fa-fw fa-archive"></span> <span class="link-name">Modules</span> <span class="fa fa-angle-down"></span> </div> </a> <ul class="links collapse" id="xs-modules-links" > <li class="link"> <a href="modules/NgxEditorModule.html" data-type="entity-link">NgxEditorModule</a> <li class="chapter inner"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-components-links-module-NgxEditorModule-839ea65a-ab8c-410e-bac6-f433ae77f0e2" > <span class="fa fa-fw fa-cogs"></span> <span>Components</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse" id="xs-components-links-module-NgxEditorModule-839ea65a-ab8c-410e-bac6-f433ae77f0e2" > <li class="link"> <a href="components/NgxEditorComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorComponent</a> </li> <li class="link"> <a href="components/NgxGrippieComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxGrippieComponent</a> </li> <li class="link"> <a href="components/NgxEditorMessageComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorMessageComponent</a> </li> <li class="link"> <a href="components/NgxEditorToolbarComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorToolbarComponent</a> </li> </ul> </li> <li class="chapter inner"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-injectables-links-module-NgxEditorModule-839ea65a-ab8c-410e-bac6-f433ae77f0e2" > <span class="fa fa-fw fa-long-arrow-down"></span> <span>Injectables</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse" id="xs-injectables-links-module-NgxEditorModule-839ea65a-ab8c-410e-bac6-f433ae77f0e2" > <li class="link"> <a href="injectables/CommandExecutorService.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules"}>CommandExecutorService</a> </li> <li class="link"> <a href="injectables/MessageService.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules"}>MessageService</a> </li> </ul> </li> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-injectables-links" > <span class="fa fa-fw fa-long-arrow-down"></span> <span>Injectables</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse" id="xs-injectables-links" > <li class="link"> <a href="injectables/CommandExecutorService.html" data-type="entity-link">CommandExecutorService</a> </li> <li class="link"> <a href="injectables/MessageService.html" data-type="entity-link">MessageService</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#xs-miscellaneous-links" > <span class="fa fa-fw fa-cubes"></span> <span>Miscellaneous</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse" id="xs-miscellaneous-links" > <li class="link"> <a href="miscellaneous/functions.html" data-type="entity-link">Functions</a> </li> <li class="link"> <a href="miscellaneous/variables.html" data-type="entity-link">Variables</a> </li> </ul> </li> </ul> </nav> </div> <div class="container-fluid main"> <div class="row main"> <div class="hidden-xs menu"> <nav> <ul class="list"> <li class="title"> <a href="index.html" data-type="index-link">NgxEditor</a> </li> <li class="divider"></li> <div id="book-search-input" role="search"> <input type="text" placeholder="Type to search"> </div> <li class="chapter"> <a data-type="chapter-link" href="index.html"><span class="fa fa-home"></span>Getting started</a> <ul class="links"> <li class="link"> <a href="overview.html" href="overview.html" data-type="chapter-link"> <span class="fa fa-fw fa-th"></span>Overview </a> </li> <li class="link"> <a href="index.html" data-type="chapter-link"><span class="fa fa-file-text-o"></span>README</a> </li> <li class="link"> <a href="license.html" data-type="chapter-link"> <span class="fa fa-fw fa-file-text-o"></span>LICENSE </a> </li> <li class="link"> <a href="dependencies.html" data-type="chapter-link"> <span class="fa fa-fw fa-list"></span>Dependencies </a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#additional-pages" > <span class="fa fa-fw fa-book"></span> <span>Wiki</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse" id="additional-pages" > <li class="link "> <a href="additional-documentation/prerequisites.html" data-type="entity-link" data-context-id="additional">Prerequisites</a> </li> <li class="link "> <a href="additional-documentation/configuration.html" data-type="entity-link" data-context-id="additional">Configuration</a> </li> <li class="link "> <a href="additional-documentation/toolbar.html" data-type="entity-link" data-context-id="additional">Toolbar</a> </li> <li class="link "> <a href="additional-documentation/font-size.html" data-type="entity-link" data-context-id="additional">Font Size</a> </li> <li class="link "> <a href="additional-documentation/colors.html" data-type="entity-link" data-context-id="additional">Colors</a> </li> <li class="link "> <a href="additional-documentation/image-uploader.html" data-type="entity-link" data-context-id="additional">Image Uploader</a> </li> <li class="link "> <a href="additional-documentation/insert-video.html" data-type="entity-link" data-context-id="additional">Insert Video</a> </li> <li class="link "> <a href="additional-documentation/resizer.html" data-type="entity-link" data-context-id="additional">Resizer</a> </li> <li class="link "> <a href="additional-documentation/errors.html" data-type="entity-link" data-context-id="additional">Errors</a> </li> </ul> </li> <li class="chapter modules"> <a data-type="chapter-link" href="modules.html"> <div class="menu-toggler linked" data-toggle="collapse" data-target="#modules-links" > <span class="fa fa-fw fa-archive"></span> <span class="link-name">Modules</span> <span class="fa fa-angle-down"></span> </div> </a> <ul class="links collapse" id="modules-links" > <li class="link"> <a href="modules/NgxEditorModule.html" data-type="entity-link">NgxEditorModule</a> <li class="chapter inner"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#components-links-module-NgxEditorModule-839ea65a-ab8c-410e-bac6-f433ae77f0e2" > <span class="fa fa-fw fa-cogs"></span> <span>Components</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse" id="components-links-module-NgxEditorModule-839ea65a-ab8c-410e-bac6-f433ae77f0e2" > <li class="link"> <a href="components/NgxEditorComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorComponent</a> </li> <li class="link"> <a href="components/NgxGrippieComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxGrippieComponent</a> </li> <li class="link"> <a href="components/NgxEditorMessageComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorMessageComponent</a> </li> <li class="link"> <a href="components/NgxEditorToolbarComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorToolbarComponent</a> </li> </ul> </li> <li class="chapter inner"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#injectables-links-module-NgxEditorModule-839ea65a-ab8c-410e-bac6-f433ae77f0e2" > <span class="fa fa-fw fa-long-arrow-down"></span> <span>Injectables</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse" id="injectables-links-module-NgxEditorModule-839ea65a-ab8c-410e-bac6-f433ae77f0e2" > <li class="link"> <a href="injectables/CommandExecutorService.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules"}>CommandExecutorService</a> </li> <li class="link"> <a href="injectables/MessageService.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules"}>MessageService</a> </li> </ul> </li> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#injectables-links" > <span class="fa fa-fw fa-long-arrow-down"></span> <span>Injectables</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse" id="injectables-links" > <li class="link"> <a href="injectables/CommandExecutorService.html" data-type="entity-link">CommandExecutorService</a> </li> <li class="link"> <a href="injectables/MessageService.html" data-type="entity-link">MessageService</a> </li> </ul> </li> <li class="chapter"> <div class="simple menu-toggler" data-toggle="collapse" data-target="#miscellaneous-links" > <span class="fa fa-fw fa-cubes"></span> <span>Miscellaneous</span> <span class="fa fa-angle-down"></span> </div> <ul class="links collapse" id="miscellaneous-links" > <li class="link"> <a href="miscellaneous/functions.html" data-type="entity-link">Functions</a> </li> <li class="link"> <a href="miscellaneous/variables.html" data-type="entity-link">Variables</a> </li> </ul> </li> </ul> </nav> </div> <!-- START CONTENT --> <div class="content miscellaneous-variables"> <div class="content-data"> <ol class="breadcrumb"> <li>Miscellaneous</li> <li>Variables</li> </ol> <section> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#DURATION" title="src/app/ngx-editor/common/services/message.service.ts"><b>DURATION</b>&nbsp;&nbsp;&nbsp;(src/.../message.service.ts)</a> </li> <li> <a href="#environment" title="src/environments/environment.ts"><b>environment</b>&nbsp;&nbsp;&nbsp;(src/.../environment.ts)</a> </li> <li> <a href="#environment" title="src/environments/environment.prod.ts"><b>environment</b>&nbsp;&nbsp;&nbsp;(src/.../environment.prod.ts)</a> </li> <li> <a href="#ngxEditorConfig" title="src/app/ngx-editor/common/ngx-editor.defaults.ts"><b>ngxEditorConfig</b>&nbsp;&nbsp;&nbsp;(src/.../ngx-editor.defaults.ts)</a> </li> </ul> </td> </tr> </tbody> </table> </section> <h3>src/app/ngx-editor/common/services/message.service.ts</h3> <section> <h3></h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="DURATION"></a> <span class="name"> <b> DURATION </b> <a href="#DURATION"><span class="fa fa-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>DURATION: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code> </code> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>7000</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>time in which the message has to be cleared </p> </div> </td> </tr> </tbody> </table> </section> <h3>src/environments/environment.ts</h3> <section> <h3></h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="environment"></a> <span class="name"> <b> environment </b> <a href="#environment"><span class="fa fa-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>environment: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code> </code> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>{ production: false }</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>The file contents for the current environment will overwrite these during build. The build system defaults to the dev environment which uses <code>environment.ts</code>, but if you do <code>ng build --env=prod</code> then <code>environment.prod.ts</code> will be used instead. The list of which env maps to which file can be found in <code>.angular-cli.json</code>.</p> </div> </td> </tr> </tbody> </table> </section> <h3>src/environments/environment.prod.ts</h3> <section> <h3></h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="environment"></a> <span class="name"> <b> environment </b> <a href="#environment"><span class="fa fa-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>environment: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code> </code> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>{ production: true }</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>environment variables for production </p> </div> </td> </tr> </tbody> </table> </section> <h3>src/app/ngx-editor/common/ngx-editor.defaults.ts</h3> <section> <h3></h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="ngxEditorConfig"></a> <span class="name"> <b> ngxEditorConfig </b> <a href="#ngxEditorConfig"><span class="fa fa-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>ngxEditorConfig: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code> </code> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>{ editable: true, spellcheck: true, height: &#x27;auto&#x27;, minHeight: &#x27;0&#x27;, width: &#x27;auto&#x27;, minWidth: &#x27;0&#x27;, translate: &#x27;yes&#x27;, enableToolbar: true, showToolbar: true, placeholder: &#x27;Enter text here...&#x27;, imageEndPoint: &#x27;&#x27;, toolbar: [ [&#x27;bold&#x27;, &#x27;italic&#x27;, &#x27;underline&#x27;, &#x27;strikeThrough&#x27;, &#x27;superscript&#x27;, &#x27;subscript&#x27;], [&#x27;fontName&#x27;, &#x27;fontSize&#x27;, &#x27;color&#x27;], [&#x27;justifyLeft&#x27;, &#x27;justifyCenter&#x27;, &#x27;justifyRight&#x27;, &#x27;justifyFull&#x27;, &#x27;indent&#x27;, &#x27;outdent&#x27;], [&#x27;cut&#x27;, &#x27;copy&#x27;, &#x27;delete&#x27;, &#x27;removeFormat&#x27;, &#x27;undo&#x27;, &#x27;redo&#x27;], [&#x27;paragraph&#x27;, &#x27;blockquote&#x27;, &#x27;removeBlockquote&#x27;, &#x27;horizontalLine&#x27;, &#x27;orderedList&#x27;, &#x27;unorderedList&#x27;], [&#x27;link&#x27;, &#x27;unlink&#x27;, &#x27;image&#x27;, &#x27;video&#x27;] ] }</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>toolbar default configuration</p> </div> </td> </tr> </tbody> </table> </section> </div><div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div> <!-- END CONTENT --> </div> </div> <script src="../js/libs/bootstrap-native.js"></script> <script src="../js/libs/es6-shim.min.js"></script> <script src="../js/libs/EventDispatcher.js"></script> <script src="../js/libs/promise.min.js"></script> <script src="../js/libs/zepto.min.js"></script> <script src="../js/compodoc.js"></script> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_URL = 'variables.html'; </script> <script src="../js/search/search.js"></script> <script src="../js/search/lunr.min.js"></script> <script src="../js/search/search-lunr.js"></script> <script src="../js/tabs.js"></script> <script src="../js/menu.js"></script> <script src="../js/libs/prism.js"></script> <script src="../js/sourceCode.js"></script> <script src="../js/search/search_index.js"></script> </body> </html>