diff --git a/docs/api/references/plugin_api/assets/css/main.css b/docs/api/references/plugin_api/assets/css/main.css new file mode 100644 index 0000000000..0174b4fe66 --- /dev/null +++ b/docs/api/references/plugin_api/assets/css/main.css @@ -0,0 +1,2707 @@ +/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ +/* ========================================================================== + * * HTML5 display definitions + * * ========================================================================== */ +/** + * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ +article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { + display: block; +} + +/** + * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ +audio, canvas, video { + display: inline-block; + *display: inline; + *zoom: 1; +} + +/** + * * Prevent modern browsers from displaying `audio` without controls. + * * Remove excess height in iOS 5 devices. */ +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. + * * Known issue: no IE 6 support. */ +[hidden] { + display: none; +} + +/* ========================================================================== + * * Base + * * ========================================================================== */ +/** + * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using + * * `em` units. + * * 2. Prevent iOS text size adjust after orientation change, without disabling + * * user zoom. */ +html { + font-size: 100%; + /* 1 */ + -ms-text-size-adjust: 100%; + /* 2 */ + -webkit-text-size-adjust: 100%; + /* 2 */ + font-family: sans-serif; +} + +/** + * * Address `font-family` inconsistency between `textarea` and other form + * * elements. */ +button, input, select, textarea { + font-family: sans-serif; +} + +/** + * * Address margins handled incorrectly in IE 6/7. */ +body { + margin: 0; +} + +/* ========================================================================== + * * Links + * * ========================================================================== */ +/** + * * Address `outline` inconsistency between Chrome and other browsers. */ +a:focus { + outline: thin dotted; +} +a:active, a:hover { + outline: 0; +} + +/** + * * Improve readability when focused and also mouse hovered in all browsers. */ +/* ========================================================================== + * * Typography + * * ========================================================================== */ +/** + * * Address font sizes and margins set differently in IE 6/7. + * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, + * * and Chrome. */ +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, .tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +/** + * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ +b, strong { + font-weight: bold; +} + +blockquote { + margin: 1em 40px; +} + +/** + * * Address styling not present in Safari 5 and Chrome. */ +dfn { + font-style: italic; +} + +/** + * * Address differences between Firefox and other browsers. + * * Known issue: no IE 6/7 normalization. */ +hr { + box-sizing: content-box; + height: 0; +} + +/** + * * Address styling not present in IE 6/7/8/9. */ +mark { + background: #ff0; + color: #000; +} + +/** + * * Address margins set differently in IE 6/7. */ +p, pre { + margin: 1em 0; +} + +/** + * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ +code, kbd, pre, samp { + font-family: monospace, serif; + _font-family: "courier new", monospace; + font-size: 1em; +} + +/** + * * Improve readability of pre-formatted text in all browsers. */ +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +/** + * * Address CSS quotes not supported in IE 6/7. */ +q { + quotes: none; +} +q:before, q:after { + content: ""; + content: none; +} + +/** + * * Address `quotes` property not supported in Safari 4. */ +/** + * * Address inconsistent and variable font size in all browsers. */ +small { + font-size: 80%; +} + +/** + * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ +sub { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* ========================================================================== + * * Lists + * * ========================================================================== */ +/** + * * Address margins set differently in IE 6/7. */ +dl, menu, ol, ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +/** + * * Address paddings set differently in IE 6/7. */ +menu, ol, ul { + padding: 0 0 0 40px; +} + +/** + * * Correct list images handled incorrectly in IE 7. */ +nav ul, nav ol { + list-style: none; + list-style-image: none; +} + +/* ========================================================================== + * * Embedded content + * * ========================================================================== */ +/** + * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. + * * 2. Improve image quality when scaled in IE 7. */ +img { + border: 0; + /* 1 */ + -ms-interpolation-mode: bicubic; +} + +/* 2 */ +/** + * * Correct overflow displayed oddly in IE 9. */ +svg:not(:root) { + overflow: hidden; +} + +/* ========================================================================== + * * Figures + * * ========================================================================== */ +/** + * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ +figure, form { + margin: 0; +} + +/* ========================================================================== + * * Forms + * * ========================================================================== */ +/** + * * Correct margin displayed oddly in IE 6/7. */ +/** + * * Define consistent border, margin, and padding. */ +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * * 1. Correct color not being inherited in IE 6/7/8/9. + * * 2. Correct text not wrapping in Firefox 3. + * * 3. Correct alignment displayed oddly in IE 6/7. */ +legend { + border: 0; + /* 1 */ + padding: 0; + white-space: normal; + /* 2 */ + *margin-left: -7px; +} + +/* 3 */ +/** + * * 1. Correct font size not being inherited in all browsers. + * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, + * * and Chrome. + * * 3. Improve appearance and consistency in all browsers. */ +button, input, select, textarea { + font-size: 100%; + /* 1 */ + margin: 0; + /* 2 */ + vertical-align: baseline; + /* 3 */ + *vertical-align: middle; +} + +/* 3 */ +/** + * * Address Firefox 3+ setting `line-height` on `input` using `!important` in + * * the UA stylesheet. */ +button, input { + line-height: normal; +} + +/** + * * Address inconsistent `text-transform` inheritance for `button` and `select`. + * * All other form control elements do not inherit `text-transform` values. + * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. + * * Correct `select` style inheritance in Firefox 4+ and Opera. */ +button, select { + text-transform: none; +} + +/** + * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * * and `video` controls. + * * 2. Correct inability to style clickable `input` types in iOS. + * * 3. Improve usability and consistency of cursor style between image-type + * * `input` and others. + * * 4. Remove inner spacing in IE 7 without affecting normal text inputs. + * * Known issue: inner spacing remains in IE 6. */ +button, html input[type=button] { + -webkit-appearance: button; + /* 2 */ + cursor: pointer; + /* 3 */ + *overflow: visible; +} + +/* 4 */ +input[type=reset], input[type=submit] { + -webkit-appearance: button; + /* 2 */ + cursor: pointer; + /* 3 */ + *overflow: visible; +} + +/* 4 */ +/** + * * Re-set default cursor for disabled elements. */ +button[disabled], html input[disabled] { + cursor: default; +} + +/** + * * 1. Address box sizing set to content-box in IE 8/9. + * * 2. Remove excess padding in IE 8/9. + * * 3. Remove excess padding in IE 7. + * * Known issue: excess padding remains in IE 6. */ +input { + /* 3 */ +} +input[type=checkbox], input[type=radio] { + box-sizing: border-box; + /* 1 */ + padding: 0; + /* 2 */ + *height: 13px; + /* 3 */ + *width: 13px; +} +input[type=search] { + -webkit-appearance: textfield; + /* 1 */ + /* 2 */ + box-sizing: content-box; +} +input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. + * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome + * * (include `-moz` to future-proof). */ +/** + * * Remove inner padding and search cancel button in Safari 5 and Chrome + * * on OS X. */ +/** + * * Remove inner padding and border in Firefox 3+. */ +button::-moz-focus-inner, input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * * 1. Remove default vertical scrollbar in IE 6/7/8/9. + * * 2. Improve readability and alignment in all browsers. */ +textarea { + overflow: auto; + /* 1 */ + vertical-align: top; +} + +/* 2 */ +/* ========================================================================== + * * Tables + * * ========================================================================== */ +/** + * * Remove most spacing between table cells. */ +table { + border-collapse: collapse; + border-spacing: 0; +} + +/* * + * *Visual Studio-like style based on original C# coloring by Jason Diamond */ +.hljs { + display: inline-block; + padding: 0.5em; + background: white; + color: black; +} + +.hljs-comment, .hljs-annotation, .hljs-template_comment, .diff .hljs-header, .hljs-chunk, .apache .hljs-cbracket { + color: #008000; +} + +.hljs-keyword, .hljs-id, .hljs-built_in, .css .smalltalk .hljs-class, .hljs-winutils, .bash .hljs-variable, .tex .hljs-command, .hljs-request, .hljs-status, .nginx .hljs-title { + color: #00f; +} + +.xml .hljs-tag { + color: #00f; +} +.xml .hljs-tag .hljs-value { + color: #00f; +} + +.hljs-string, .hljs-title, .hljs-parent, .hljs-tag .hljs-value, .hljs-rules .hljs-value { + color: #a31515; +} + +.ruby .hljs-symbol { + color: #a31515; +} +.ruby .hljs-symbol .hljs-string { + color: #a31515; +} + +.hljs-template_tag, .django .hljs-variable, .hljs-addition, .hljs-flow, .hljs-stream, .apache .hljs-tag, .hljs-date, .tex .hljs-formula, .coffeescript .hljs-attribute { + color: #a31515; +} + +.ruby .hljs-string, .hljs-decorator, .hljs-filter .hljs-argument, .hljs-localvars, .hljs-array, .hljs-attr_selector, .hljs-pseudo, .hljs-pi, .hljs-doctype, .hljs-deletion, .hljs-envvar, .hljs-shebang, .hljs-preprocessor, .hljs-pragma, .userType, .apache .hljs-sqbracket, .nginx .hljs-built_in, .tex .hljs-special, .hljs-prompt { + color: #2b91af; +} + +.hljs-phpdoc, .hljs-javadoc, .hljs-xmlDocTag { + color: #808080; +} + +.vhdl .hljs-typename { + font-weight: bold; +} +.vhdl .hljs-string { + color: #666666; +} +.vhdl .hljs-literal { + color: #a31515; +} +.vhdl .hljs-attribute { + color: #00b0e8; +} + +.xml .hljs-attribute { + color: #f00; +} + +ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col > :first-child > :first-child, +.col-11 > :first-child > :first-child, +.col-10 > :first-child > :first-child, +.col-9 > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-7 > :first-child > :first-child, +.col-6 > :first-child > :first-child, +.col-5 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +.col-3 > :first-child > :first-child, +.col-2 > :first-child > :first-child, +.col-1 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col > :first-child > :first-child > :first-child, +.col-11 > :first-child > :first-child > :first-child, +.col-10 > :first-child > :first-child > :first-child, +.col-9 > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-7 > :first-child > :first-child > :first-child, +.col-6 > :first-child > :first-child > :first-child, +.col-5 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child, +.col-3 > :first-child > :first-child > :first-child, +.col-2 > :first-child > :first-child > :first-child, +.col-1 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col > :last-child > :last-child, +.col-11 > :last-child > :last-child, +.col-10 > :last-child > :last-child, +.col-9 > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-7 > :last-child > :last-child, +.col-6 > :last-child > :last-child, +.col-5 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +.col-3 > :last-child > :last-child, +.col-2 > :last-child > :last-child, +.col-1 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col > :last-child > :last-child > :last-child, +.col-11 > :last-child > :last-child > :last-child, +.col-10 > :last-child > :last-child > :last-child, +.col-9 > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-7 > :last-child > :last-child > :last-child, +.col-6 > :last-child > :last-child > :last-child, +.col-5 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child, +.col-3 > :last-child > :last-child > :last-child, +.col-2 > :last-child > :last-child > :last-child, +.col-1 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: -ms-flexbox; + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-1 { + width: 8.3333333333%; +} + +.offset-1 { + margin-left: 8.3333333333%; +} + +.col-2 { + width: 16.6666666667%; +} + +.offset-2 { + margin-left: 16.6666666667%; +} + +.col-3 { + width: 25%; +} + +.offset-3 { + margin-left: 25%; +} + +.col-4 { + width: 33.3333333333%; +} + +.offset-4 { + margin-left: 33.3333333333%; +} + +.col-5 { + width: 41.6666666667%; +} + +.offset-5 { + margin-left: 41.6666666667%; +} + +.col-6 { + width: 50%; +} + +.offset-6 { + margin-left: 50%; +} + +.col-7 { + width: 58.3333333333%; +} + +.offset-7 { + margin-left: 58.3333333333%; +} + +.col-8 { + width: 66.6666666667%; +} + +.offset-8 { + margin-left: 66.6666666667%; +} + +.col-9 { + width: 75%; +} + +.offset-9 { + margin-left: 75%; +} + +.col-10 { + width: 83.3333333333%; +} + +.offset-10 { + margin-left: 83.3333333333%; +} + +.col-11 { + width: 91.6666666667%; +} + +.offset-11 { + margin-left: 91.6666666667%; +} + +.tsd-kind-icon { + display: block; + position: relative; + padding-left: 20px; + text-indent: -20px; +} +.tsd-kind-icon:before { + content: ""; + display: inline-block; + vertical-align: middle; + width: 17px; + height: 17px; + margin: 0 3px 2px 0; + background-image: url(../images/icons.png); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-kind-icon:before { + background-image: url(../images/icons@2x.png); + background-size: 238px 204px; + } +} + +.tsd-signature.tsd-kind-icon:before { + background-position: 0 -153px; +} + +.tsd-kind-object-literal > .tsd-kind-icon:before { + background-position: 0px -17px; +} +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -17px; +} +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -17px; +} + +.tsd-kind-class > .tsd-kind-icon:before { + background-position: 0px -34px; +} +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -34px; +} +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -34px; +} + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -51px; +} + +.tsd-kind-interface > .tsd-kind-icon:before { + background-position: 0px -68px; +} +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -68px; +} +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -68px; +} + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -85px; +} + +.tsd-kind-namespace > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-module > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-enum > .tsd-kind-icon:before { + background-position: 0px -119px; +} +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -119px; +} +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -119px; +} + +.tsd-kind-enum-member > .tsd-kind-icon:before { + background-position: 0px -136px; +} +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -136px; +} +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -136px; +} + +.tsd-kind-signature > .tsd-kind-icon:before { + background-position: 0px -153px; +} +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -153px; +} +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -153px; +} + +.tsd-kind-type-alias > .tsd-kind-icon:before { + background-position: 0px -170px; +} +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -170px; +} +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -170px; +} + +.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -187px; +} + +.tsd-kind-variable > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-property > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-get-signature > .tsd-kind-icon:before { + background-position: -136px -17px; +} +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -17px; +} +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -17px; +} + +.tsd-kind-set-signature > .tsd-kind-icon:before { + background-position: -136px -34px; +} +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -34px; +} +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -34px; +} + +.tsd-kind-accessor > .tsd-kind-icon:before { + background-position: -136px -51px; +} +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -51px; +} +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -51px; +} + +.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-constructor > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-index-signature > .tsd-kind-icon:before { + background-position: -136px -119px; +} +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -119px; +} +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -119px; +} + +.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -136px; +} +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -136px; +} +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -136px; +} + +.tsd-is-static > .tsd-kind-icon:before { + background-position: -136px -153px; +} +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -153px; +} +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -153px; +} +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -153px; +} + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -187px; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: #fdfdfd; + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: #222; +} + +a { + color: #4da6ff; + text-decoration: none; +} +a:hover { + text-decoration: underline; +} + +code, pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; + background-color: rgba(0, 0, 0, 0.04); +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; + background-color: transparent; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, .tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, .tsd-typography ul, .tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html.default .col-content { + width: 72%; + } + html.default .col-menu { + width: 28%; + } + html.default .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html.default .col-content { + float: none; + width: 100%; + } + html.default .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: #fff; + transform: translate(100%, 0); + } + html.default .col-menu > *:last-child { + padding-bottom: 20px; + } + html.default .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + html.default.to-has-menu .overlay { + animation: fade-in 0.4s; + } + html.default.to-has-menu header, +html.default.to-has-menu footer, +html.default.to-has-menu .col-content { + animation: shift-to-left 0.4s; + } + html.default.to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + html.default.from-has-menu .overlay { + animation: fade-out 0.4s; + } + html.default.from-has-menu header, +html.default.from-has-menu footer, +html.default.from-has-menu .col-content { + animation: unshift-to-left 0.4s; + } + html.default.from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + html.default.has-menu body { + overflow: hidden; + } + html.default.has-menu .overlay { + visibility: visible; + } + html.default.has-menu header, +html.default.has-menu footer, +html.default.has-menu .col-content { + transform: translate(-25%, 0); + } + html.default.has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: #fff; + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: #808080; +} +.tsd-breadcrumb a { + color: #808080; + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +html.minimal .container { + margin: 0; +} +html.minimal .container-main { + padding-top: 50px; + padding-bottom: 0; +} +html.minimal .content-wrap { + padding-left: 300px; +} +html.minimal .tsd-navigation { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + box-sizing: border-box; + z-index: 1; + left: 0; + top: 40px; + bottom: 0; + width: 300px; + padding: 20px; + margin: 0; +} +html.minimal .tsd-member .tsd-member { + margin-left: 0; +} +html.minimal .tsd-page-toolbar { + position: fixed; + z-index: 2; +} +html.minimal #tsd-filter .tsd-filter-group { + right: 0; + transform: none; +} +html.minimal footer { + background-color: transparent; +} +html.minimal footer .container { + padding: 0; +} +html.minimal .tsd-generator { + padding: 0; +} +@media (max-width: 900px) { + html.minimal .tsd-navigation { + display: none; + } + html.minimal .content-wrap { + padding-left: 0; + } +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid #808080; + color: #808080; + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-only-exported .tsd-is-not-exported { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: #fff; + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, +#tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid #eee; + background-color: #fff; +} +footer.with-border-bottom { + border-bottom: 1px solid #eee; +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid #eee; +} +.tsd-index-panel ul.tsd-index-list { + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: #9600ff; +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: #7da01f; +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: #cc9900; +} +.tsd-index-panel .tsd-parent-kind-class a { + color: #4da6ff; +} +.tsd-index-panel .tsd-kind-module a { + color: #9600ff; +} +.tsd-index-panel .tsd-kind-interface a { + color: #7da01f; +} +.tsd-index-panel .tsd-kind-enum a { + color: #cc9900; +} +.tsd-index-panel .tsd-kind-class a { + color: #4da6ff; +} +.tsd-index-panel .tsd-is-private a { + color: #808080; +} + +.tsd-flag { + display: inline-block; + padding: 1px 5px; + border-radius: 4px; + color: #fff; + background-color: #808080; + text-indent: 0; + font-size: 14px; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: #222; + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid #eee; +} +.tsd-navigation.primary li { + border-top: 1px solid #eee; +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: #808080; +} +.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: -webkit-sticky; + position: sticky; + top: calc(.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: #eee; +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: #000; +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: #eee; +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: #fff; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid #eee; +} +.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, .tsd-panel table td { + padding: 6px 13px; + border: 1px solid #ddd; +} +.tsd-panel table tr { + background-color: #fff; + border-top: 1px solid #ccc; +} +.tsd-panel table tr:nth-child(2n) { + background-color: #f8f8f8; +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: #222; +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: #fdfdfd; +} +#tsd-search .results li:nth-child(even) { + background-color: #fff; +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: #eee; +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: #808080; + font-weight: normal; +} +#tsd-search.has-focus { + background-color: #eee; +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid #eee; + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: #808080; + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid #eee; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: #eee; +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: #808080; + margin: 0 0 1em 0; +} +.tsd-sources a { + color: #808080; + text-decoration: underline; +} +.tsd-sources ul, .tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: #333; + background: #fff; + border-bottom: 1px solid #eee; + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: #333; + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(../images/widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { + background-image: url(../images/widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.6; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.8; +} +.tsd-widget.active { + opacity: 1; + background-color: #eee; +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, .tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, .tsd-widget.menu { + display: inline-block; + } +} +input[type=checkbox] + .tsd-widget:before { + background-position: -120px 0; +} +input[type=checkbox]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: #fdfdfd; +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: #fff; +} +.tsd-select .tsd-select-list li:hover { + background-color: #eee; +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} + +/* JOPLINCHANGES */ + +.tsd-kind-constructor { + display: none; +} + +span.platform-desktop::after { + content: "-only"; +} + +span.platform-desktop { + border-radius: 4px; + border: 1px solid #a5afc3; + background-color: #d8e5ff; + font-size: 0.8em; + padding: 2px 4px; +} + +/* By default, TypeDoc wraps the first line of a class documentation in a "lead" class +and gives it a different styling, but that looks broken so disable it. */ +.tsd-panel.tsd-comment .lead { + font-size: inherit; + line-height: inherit; + margin-bottom: 0; +} + +/* /JOPLINCHANGES */ \ No newline at end of file diff --git a/docs/api/references/plugin_api/assets/images/icons.png b/docs/api/references/plugin_api/assets/images/icons.png new file mode 100644 index 0000000000..3836d5fe46 Binary files /dev/null and b/docs/api/references/plugin_api/assets/images/icons.png differ diff --git a/docs/api/references/plugin_api/assets/images/icons@2x.png b/docs/api/references/plugin_api/assets/images/icons@2x.png new file mode 100644 index 0000000000..5a209e2f6d Binary files /dev/null and b/docs/api/references/plugin_api/assets/images/icons@2x.png differ diff --git a/docs/api/references/plugin_api/assets/images/widgets.png b/docs/api/references/plugin_api/assets/images/widgets.png new file mode 100644 index 0000000000..c7380532ac Binary files /dev/null and b/docs/api/references/plugin_api/assets/images/widgets.png differ diff --git a/docs/api/references/plugin_api/assets/images/widgets@2x.png b/docs/api/references/plugin_api/assets/images/widgets@2x.png new file mode 100644 index 0000000000..4bbbd57272 Binary files /dev/null and b/docs/api/references/plugin_api/assets/images/widgets@2x.png differ diff --git a/docs/api/references/plugin_api/assets/js/main.js b/docs/api/references/plugin_api/assets/js/main.js new file mode 100644 index 0000000000..39a806694a --- /dev/null +++ b/docs/api/references/plugin_api/assets/js/main.js @@ -0,0 +1 @@ +!function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version="2.3.7",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return null==e?"":e.toString()},e.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),r=Object.keys(e),i=0;i=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){for(var t,r;47<(r=(t=this.next()).charCodeAt(0))&&r<58;);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos=this.scrollTop||0===this.scrollTop,isShown!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.secondaryNav.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop},Viewport}(typedoc.EventTarget);typedoc.Viewport=Viewport,typedoc.registerService(Viewport,"viewport")}(typedoc||(typedoc={})),function(typedoc){function Component(options){this.el=options.el}typedoc.Component=Component}(typedoc||(typedoc={})),function(typedoc){typedoc.pointerDown="mousedown",typedoc.pointerMove="mousemove",typedoc.pointerUp="mouseup",typedoc.pointerDownPosition={x:0,y:0},typedoc.preventNextClick=!1,typedoc.isPointerDown=!1,typedoc.isPointerTouch=!1,typedoc.hasPointerMoved=!1,typedoc.isMobile=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent),document.documentElement.classList.add(typedoc.isMobile?"is-mobile":"not-mobile"),typedoc.isMobile&&"ontouchstart"in document.documentElement&&(typedoc.isPointerTouch=!0,typedoc.pointerDown="touchstart",typedoc.pointerMove="touchmove",typedoc.pointerUp="touchend"),document.addEventListener(typedoc.pointerDown,function(e){typedoc.isPointerDown=!0,typedoc.hasPointerMoved=!1;var t="touchstart"==typedoc.pointerDown?e.targetTouches[0]:e;typedoc.pointerDownPosition.y=t.pageY||0,typedoc.pointerDownPosition.x=t.pageX||0}),document.addEventListener(typedoc.pointerMove,function(e){if(typedoc.isPointerDown&&!typedoc.hasPointerMoved){var t="touchstart"==typedoc.pointerDown?e.targetTouches[0]:e,x=typedoc.pointerDownPosition.x-(t.pageX||0),y=typedoc.pointerDownPosition.y-(t.pageY||0);typedoc.hasPointerMoved=10scrollTop;)index-=1;for(;index"+match+""}),parent=row.parent||"";(parent=parent.replace(new RegExp(this.query,"i"),function(match){return""+match+""}))&&(name=''+parent+"."+name);var item=document.createElement("li");item.classList.value=row.classes,item.innerHTML='\n '+name+"\n ",this.results.appendChild(item)}}},Search.prototype.setLoadingState=function(value){this.loadingState!=value&&(this.el.classList.remove(SearchLoadingState[this.loadingState].toLowerCase()),this.loadingState=value,this.el.classList.add(SearchLoadingState[this.loadingState].toLowerCase()),this.updateResults())},Search.prototype.setHasFocus=function(value){this.hasFocus!=value&&(this.hasFocus=value,this.el.classList.toggle("has-focus"),value?(this.setQuery(""),this.field.value=""):this.field.value=this.query)},Search.prototype.setQuery=function(value){this.query=value.trim(),this.updateResults()},Search.prototype.setCurrentResult=function(dir){var current=this.results.querySelector(".current");if(current){var rel=1==dir?current.nextElementSibling:current.previousElementSibling;rel&&(current.classList.remove("current"),rel.classList.add("current"))}else(current=this.results.querySelector(1==dir?"li:first-child":"li:last-child"))&¤t.classList.add("current")},Search.prototype.gotoCurrentResult=function(){var current=this.results.querySelector(".current");if(current||(current=this.results.querySelector("li:first-child")),current){var link=current.querySelector("a");link&&(window.location.href=link.href),this.field.blur()}},Search.prototype.bindEvents=function(){var _this=this;this.results.addEventListener("mousedown",function(){_this.resultClicked=!0}),this.results.addEventListener("mouseup",function(){_this.resultClicked=!1,_this.setHasFocus(!1)}),this.field.addEventListener("focusin",function(){_this.setHasFocus(!0),_this.loadIndex()}),this.field.addEventListener("focusout",function(){_this.resultClicked?_this.resultClicked=!1:setTimeout(function(){return _this.setHasFocus(!1)},100)}),this.field.addEventListener("input",function(){_this.setQuery(_this.field.value)}),this.field.addEventListener("keydown",function(e){13==e.keyCode||27==e.keyCode||38==e.keyCode||40==e.keyCode?(_this.preventPress=!0,e.preventDefault(),13==e.keyCode?_this.gotoCurrentResult():27==e.keyCode?_this.field.blur():38==e.keyCode?_this.setCurrentResult(-1):40==e.keyCode&&_this.setCurrentResult(1)):_this.preventPress=!1}),this.field.addEventListener("keypress",function(e){_this.preventPress&&e.preventDefault()}),document.body.addEventListener("keydown",function(e){e.altKey||e.ctrlKey||e.metaKey||!_this.hasFocus&&47this.groups.length-1&&(index=this.groups.length-1),this.index!=index){var to=this.groups[index];if(-1 + + + + + joplin | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin

+
+
+
+
+
+
+
+
+
+

This is the main entry point to the Joplin API. You can access various services using the provided accessors.

+
+

This is a beta API

+

Please note that the plugin API is relatively new and should be considered Beta state. Besides possible bugs, what it means is that there might be necessary breaking changes from one version to the next. Whenever such change is needed, best effort will be done to:

+
    +
  • Maintain backward compatibility;
  • +
  • When possible, deprecate features instead of removing them;
  • +
  • Document breaking changes in the changelog;
  • +
+

So if you are developing a plugin, please keep an eye on the changelog as everything will be in there with information about how to update your code. There won't be any major API rewrite or architecture changes, but possibly small tweaks like function signature change, type change, etc.

+

Eventually, the plugin API will be versioned to make this process smoother.

+
+
+ +
+

Index

+
+
+
+
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+
+
+

Accessors

+
+ +

clipboard

+ +
    +
  • + + +
  • +
+
+
+ +

commands

+ +
    +
  • + + +
  • +
+
+
+ +

contentScripts

+ +
    +
  • + + +
  • +
+
+
+ +

data

+ +
    +
  • + + +
  • +
+
+
+ +

interop

+ +
    +
  • + + +
  • +
+
+
+ +

plugins

+ +
    +
  • + + +
  • +
+
+
+ +

settings

+ +
    +
  • + + +
  • +
+
+
+ +

views

+ +
    +
  • + + +
  • +
+
+
+ +

workspace

+ +
    +
  • + + +
  • +
+
+
+
+

Methods

+
+ +

require

+
    +
  • require(_path: string): any
  • +
+
    +
  • + +
    +
    +

    It is not possible to bundle native packages with a plugin, because they + need to work cross-platforms. Instead access to certain useful native + packages is provided using this function.

    +
    +

    Currently these packages are available:

    + +

    View the demo plugin

    +
    +

    Parameters

    +
      +
    • +
      _path: string
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplinclipboard.html b/docs/api/references/plugin_api/classes/joplinclipboard.html new file mode 100644 index 0000000000..67c59e87e2 --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplinclipboard.html @@ -0,0 +1,340 @@ + + + + + + joplin.clipboard | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.clipboard

+
+
+
+
+
+
+ +
+

Index

+
+
+
+
+
+

Methods

+ +
+
+
+
+
+
+
+

Methods

+
+ +

availableFormats

+
    +
  • availableFormats(): Promise<string[]>
  • +
+
    +
  • + +
    +
    +

    Returns the list available formats (mime types).

    +
    +

    For example [ 'text/plain', 'text/html' ]

    +
    + +
  • +
+
+
+ +

readHtml

+
    +
  • readHtml(): Promise<string>
  • +
+
    +
  • + + +
  • +
+
+
+ +

readImage

+
    +
  • readImage(): Promise<string>
  • +
+
    +
  • + +
    +
    +

    Returns the image in data URL format.

    +
    +
    + +
  • +
+
+
+ +

readText

+
    +
  • readText(): Promise<string>
  • +
+
    +
  • + + +
  • +
+
+
+ +

writeHtml

+
    +
  • writeHtml(html: string): Promise<void>
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      html: string
      +
    • +
    + +
  • +
+
+
+ +

writeImage

+
    +
  • writeImage(dataUrl: string): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Takes an image in data URL format.

    +
    +
    +

    Parameters

    +
      +
    • +
      dataUrl: string
      +
    • +
    + +
  • +
+
+
+ +

writeText

+
    +
  • writeText(text: string): Promise<void>
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      text: string
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplincommands.html b/docs/api/references/plugin_api/classes/joplincommands.html new file mode 100644 index 0000000000..8d02d9f73b --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplincommands.html @@ -0,0 +1,282 @@ + + + + + + joplin.commands | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.commands

+
+
+
+
+
+
+
+
+
+

This class allows executing or registering new Joplin commands. Commands + can be executed or associated with + toolbar buttons or + menu items.

+
+

View the demo plugin

+ +

Executing Joplin's internal commands

+
+

It is also possible to execute internal Joplin's commands which, as of + now, are not well documented. You can find the list directly on GitHub + though at the following locations:

+ +

To view what arguments are supported, you can open any of these files + and look at the execute() command.

+ +

Executing editor commands

+
+

There might be a situation where you want to invoke editor commands + without using a contentScript. For this + reason Joplin provides the built in editor.execCommand command.

+

editor.execCommand should work with any core command in both the + CodeMirror and + TinyMCE editors, + as well as most functions calls directly on a CodeMirror editor object (extensions).

+ +

editor.execCommand supports adding arguments for the commands.

+
await joplin.commands.execute('editor.execCommand', {
+    name: 'madeUpCommand', // CodeMirror and TinyMCE
+    args: [], // CodeMirror and TinyMCE
+    ui: false, // TinyMCE only
+    value: '', // TinyMCE only
+});
+

View the example using the CodeMirror editor

+
+
+ +
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

execute

+
    +
  • execute(commandName: string, ...args: any[]): Promise<any | void>
  • +
+
    +
  • + +
    +
    +

    desktop Executes the given + command.

    +
    +

    The command can take any number of arguments, and the supported + arguments will vary based on the command. For custom commands, this + is the args passed to the execute() function. For built-in + commands, you can find the supported arguments by checking the links + above.

    +
    // Create a new note in the current notebook:
    +await joplin.commands.execute('newNote');
    +
    +// Create a new sub-notebook under the provided notebook
    +// Note: internally, notebooks are called "folders".
    +await joplin.commands.execute('newFolder', "SOME_FOLDER_ID");
    +
    +

    Parameters

    +
      +
    • +
      commandName: string
      +
    • +
    • +
      Rest ...args: any[]
      +
    • +
    + +
  • +
+
+
+ +

register

+
    +
  • register(command: Command): Promise<void>
  • +
+
    +
  • + +
    +
    +

    desktop Registers a new command.

    +
    +
    // Register a new commmand called "testCommand1"
    +
    +await joplin.commands.register({
    +    name: 'testCommand1',
    +    label: 'My Test Command 1',
    +    iconName: 'fas fa-music',
    +    execute: () => {
    +        alert('Testing plugin command 1');
    +    },
    +});
    +
    +

    Parameters

    + + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplincontentscripts.html b/docs/api/references/plugin_api/classes/joplincontentscripts.html new file mode 100644 index 0000000000..0d23db4ebb --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplincontentscripts.html @@ -0,0 +1,256 @@ + + + + + + joplin.contentScripts | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.contentScripts

+
+
+
+
+
+
+ +
+

Index

+
+
+
+
+
+

Methods

+ +
+
+
+
+
+
+
+

Methods

+
+ +

onMessage

+
    +
  • onMessage(contentScriptId: string, callback: any): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Listens to a messages sent from the content script using postMessage(). + See ContentScriptType for more information as well as the + postMessage + demo

    +
    +
    +

    Parameters

    +
      +
    • +
      contentScriptId: string
      +
    • +
    • +
      callback: any
      +
    • +
    + +
  • +
+
+
+ +

register

+
    +
  • register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Registers a new content script. Unlike regular plugin code, which runs in + a separate process, content scripts run within the main process code and + thus allow improved performances and more customisations in specific + cases. It can be used for example to load a Markdown or editor plugin.

    +
    +

    Note that registering a content script in itself will do nothing - it + will only be loaded in specific cases by the relevant app modules (eg. + the Markdown renderer or the code editor). So it is not a way to inject + and run arbitrary code in the app, which for safety and performance + reasons is not supported.

    +

    The plugin generator provides a way to build any content script you might + want to package as well as its dependencies. See the Plugin Generator + doc + for more information.

    + +

    See also the postMessage demo

    +
    +

    Parameters

    +
      +
    • +
      type: ContentScriptType
      +
      +

      Defines how the script will be used. See the type definition for more information about each supported type.

      +
      +
    • +
    • +
      id: string
      +
      +

      A unique ID for the content script.

      +
      +
    • +
    • +
      scriptPath: string
      +
      +

      Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set scriptPath to "./content_script.js.

      +
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplindata.html b/docs/api/references/plugin_api/classes/joplindata.html new file mode 100644 index 0000000000..5344d86e55 --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplindata.html @@ -0,0 +1,314 @@ + + + + + + joplin.data | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.data

+
+
+
+
+
+
+
+
+
+

This module provides access to the Joplin data API: https://joplinapp.org/api/references/rest_api/ + This is the main way to retrieve data, such as notes, notebooks, tags, etc. + or to update them or delete them.

+
+

This is also what you would use to search notes, via the search endpoint.

+

View the demo plugin

+

In general you would use the methods in this class as if you were using a REST API. There are four methods that map to GET, POST, PUT and DELETE calls. + And each method takes these parameters:

+
    +
  • path: This is an array that represents the path to the resource in the form ["resouceName", "resourceId", "resourceLink"] (eg. ["tags", ":id", "notes"]). The "resources" segment is the name of the resources you want to access (eg. "notes", "folders", etc.). If not followed by anything, it will refer to all the resources in that collection. The optional "resourceId" points to a particular resources within the collection. Finally, an optional "link" can be present, which links the resource to a collection of resources. This can be used in the API for example to retrieve all the notes associated with a tag.
  • +
  • query: (Optional) The query parameters. In a URL, this is the part after the question mark "?". In this case, it should be an object with key/value pairs.
  • +
  • data: (Optional) Applies to PUT and POST calls only. The request body contains the data you want to create or modify, for example the content of a note or folder.
  • +
  • files: (Optional) Used to create new resources and associate them with files.
  • +
+

Please refer to the Joplin API documentation for complete details about each call. As the plugin runs within the Joplin application you do not need an authorisation token to use this API.

+

For example:

+
// Get a note ID, title and body
+const noteId = 'some_note_id';
+const note = await joplin.data.get(['notes', noteId], { fields: ['id', 'title', 'body'] });
+
+// Get all folders
+const folders = await joplin.data.get(['folders']);
+
+// Set the note body
+await joplin.data.put(['notes', noteId], null, { body: "New note body" });
+
+// Create a new note under one of the folders
+await joplin.data.post(['notes'], null, { body: "my new note", title: "some title", parent_id: folders[0].id });
+
+
+ +
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

delete

+
    +
  • delete(path: Path, query?: any): Promise<any>
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      path: Path
      +
    • +
    • +
      Default value query: any = null
      +
    • +
    + +
  • +
+
+
+ +

get

+
    +
  • get(path: Path, query?: any): Promise<any>
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      path: Path
      +
    • +
    • +
      Default value query: any = null
      +
    • +
    + +
  • +
+
+
+ +

post

+
    +
  • post(path: Path, query?: any, body?: any, files?: any[]): Promise<any>
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      path: Path
      +
    • +
    • +
      Default value query: any = null
      +
    • +
    • +
      Default value body: any = null
      +
    • +
    • +
      Default value files: any[] = null
      +
    • +
    + +
  • +
+
+
+ +

put

+
    +
  • put(path: Path, query?: any, body?: any, files?: any[]): Promise<any>
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      path: Path
      +
    • +
    • +
      Default value query: any = null
      +
    • +
    • +
      Default value body: any = null
      +
    • +
    • +
      Default value files: any[] = null
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplininterop.html b/docs/api/references/plugin_api/classes/joplininterop.html new file mode 100644 index 0000000000..a4be405558 --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplininterop.html @@ -0,0 +1,213 @@ + + + + + + joplin.interop | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.interop

+
+
+
+
+
+
+
+
+
+

Provides a way to create modules to import external data into Joplin or to export notes into any arbitrary format.

+
+

View the demo plugin

+

To implement an import or export module, you would simply define an object with various event handlers that are called + by the application during the import/export process.

+

See the documentation of the ExportModule and ImportModule for more information.

+

You may also want to refer to the Joplin API documentation to see the list of properties for each item (note, notebook, etc.) - https://joplinapp.org/api/references/rest_api/

+
+
+ +
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

registerExportModule

+
    +
  • registerExportModule(module: ExportModule): Promise<void>
  • +
+ +
+
+ +

registerImportModule

+
    +
  • registerImportModule(module: ImportModule): Promise<void>
  • +
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplinplugins.html b/docs/api/references/plugin_api/classes/joplinplugins.html new file mode 100644 index 0000000000..633ea2678e --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplinplugins.html @@ -0,0 +1,333 @@ + + + + + + joplin.plugins | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.plugins

+
+
+
+
+
+
+
+
+
+

This class provides access to plugin-related features.

+
+
+
+ +
+

Index

+
+
+
+
+
+

Methods

+ +
+
+
+
+
+
+
+

Methods

+
+ +

dataDir

+
    +
  • dataDir(): Promise<string>
  • +
+
    +
  • + +
    +
    +

    Gets the plugin own data directory path. Use this to store any + plugin-related data. Unlike installationDir, any data stored here + will be persisted.

    +
    +
    + +
  • +
+
+
+ +

installationDir

+
    +
  • installationDir(): Promise<string>
  • +
+
    +
  • + +
    +
    +

    Gets the plugin installation directory. This can be used to access any + asset that was packaged with the plugin. This directory should be + considered read-only because any data you store here might be deleted or + re-created at any time. To store new persistent data, use dataDir.

    +
    +
    + +
  • +
+
+
+ +

register

+
    +
  • register(script: Script): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Registers a new plugin. This is the entry point when creating a plugin. You should pass a simple object with an onStart method to it. + That onStart method will be executed as soon as the plugin is loaded.

    +
    +
    joplin.plugins.register({
    +    onStart: async function() {
    +        // Run your plugin code here
    +    }
    +});
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

registerContentScript

+
    +
  • registerContentScript(type: ContentScriptType, id: string, scriptPath: string): Promise<void>
  • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Use joplin.contentScripts.register()

    +
    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

require

+
    +
  • require(_path: string): any
  • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Use joplin.require()

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      _path: string
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplinsettings.html b/docs/api/references/plugin_api/classes/joplinsettings.html new file mode 100644 index 0000000000..3563e4a41a --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplinsettings.html @@ -0,0 +1,415 @@ + + + + + + joplin.settings | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.settings

+
+
+
+
+
+
+
+
+
+

This API allows registering new settings and setting sections, as well as getting and setting settings. Once a setting has been registered it will appear in the config screen and be editable by the user.

+
+

Settings are essentially key/value pairs.

+

Note: Currently this API does not provide access to Joplin's built-in settings. This is by design as plugins that modify user settings could give unexpected results

+

View the demo plugin

+
+
+ +
+

Index

+
+ +
+
+
+
+
+

Methods

+
+ +

globalValue

+
    +
  • globalValue(key: string): Promise<any>
  • +
+ +
+
+ +

onChange

+ +
    +
  • + +
    +
    +

    Called when one or multiple settings of your plugin have been changed.

    +
      +
    • For performance reasons, this event is triggered with a delay.
    • +
    • You will only get events for your own plugin settings.
    • +
    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

registerSection

+
    +
  • registerSection(name: string, section: SettingSection): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Registers a new setting section. Like for registerSetting, it is dynamic and needs to be done every time the plugin starts.

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

registerSetting

+
    +
  • registerSetting(key: string, settingItem: SettingItem): Promise<void>
  • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Use joplin.settings.registerSettings()

    +

    Registers a new setting.

    +
    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

registerSettings

+
    +
  • registerSettings(settings: Record<string, SettingItem>): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Registers new settings. + Note that registering a setting item is dynamic and will be gone next time Joplin starts. + What it means is that you need to register the setting every time the plugin starts (for example in the onStart event). + The setting value however will be preserved from one launch to the next so there is no risk that it will be lost even if for some + reason the plugin fails to start at some point.

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

setValue

+
    +
  • setValue(key: string, value: any): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Sets a setting value (only applies to setting you registered from your plugin)

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +
    • +
    • +
      value: any
      +
    • +
    + +
  • +
+
+
+ +

value

+
    +
  • value(key: string): Promise<any>
  • +
+
    +
  • + +
    +
    +

    Gets a setting value (only applies to setting you registered from your plugin)

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplinviews.html b/docs/api/references/plugin_api/classes/joplinviews.html new file mode 100644 index 0000000000..5b4d25cbad --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplinviews.html @@ -0,0 +1,271 @@ + + + + + + joplin.views | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.views

+
+
+
+
+
+
+
+
+
+

This namespace provides access to view-related services.

+
+

All view services provide a create() method which you would use to create the view object, whether it's a dialog, a toolbar button or a menu item. + In some cases, the create() method will return a ViewHandle, which you would use to act on the view, for example to set certain properties or call some methods.

+
+
+ +
+

Index

+
+
+
+
+
+

Accessors

+ +
+
+
+
+
+
+
+

Accessors

+
+ +

dialogs

+ +
    +
  • + + +
  • +
+
+
+ +

menuItems

+ +
    +
  • + + +
  • +
+
+
+ +

menus

+ +
    +
  • + + +
  • +
+
+
+ +

panels

+ +
    +
  • + + +
  • +
+
+
+ +

toolbarButtons

+ +
    +
  • + + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplinviewsdialogs.html b/docs/api/references/plugin_api/classes/joplinviewsdialogs.html new file mode 100644 index 0000000000..09e1a91632 --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplinviewsdialogs.html @@ -0,0 +1,391 @@ + + + + + + joplin.views.dialogs | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.views.dialogs

+
+
+
+
+
+
+
+
+
+

Allows creating and managing dialogs. A dialog is modal window that + contains a webview and a row of buttons. You can update the + webview using the setHtml method. Dialogs are hidden by default and + you need to call open() to open them. Once the user clicks on a + button, the open call will return an object indicating what button was + clicked on.

+
+ +

Retrieving form values

+
+

If your HTML content included one or more forms, a formData object + will also be included with the key/value for each form.

+ +

Special button IDs

+
+

The following buttons IDs have a special meaning:

+
    +
  • ok, yes, submit, confirm: They are considered "submit" buttons
  • +
  • cancel, no, reject: They are considered "dismiss" buttons
  • +
+

This information is used by the application to determine what action + should be done when the user presses "Enter" or "Escape" within the + dialog. If they press "Enter", the first "submit" button will be + automatically clicked. If they press "Escape" the first "dismiss" button + will be automatically clicked.

+

View the demo + plugin

+
+
+ +
+

Index

+
+
+
+
+
+

Methods

+ +
+
+
+
+
+
+
+

Methods

+
+ +

addScript

+
    +
  • addScript(handle: ViewHandle, scriptPath: string): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Adds and loads a new JS or CSS files into the dialog.

    +
    +
    +

    Parameters

    +
      +
    • +
      handle: ViewHandle
      +
    • +
    • +
      scriptPath: string
      +
    • +
    + +
  • +
+
+
+ +

create

+ +
    +
  • + +
    +
    +

    Creates a new dialog

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +
    • +
    + +
  • +
+
+
+ +

open

+ +
    +
  • + +
    +
    +

    Opens the dialog

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

setButtons

+ +
    +
  • + +
    +
    +

    Sets the dialog buttons.

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

setHtml

+
    +
  • setHtml(handle: ViewHandle, html: string): Promise<string>
  • +
+
    +
  • + +
    +
    +

    Sets the dialog HTML content

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

showMessageBox

+
    +
  • showMessageBox(message: string): Promise<number>
  • +
+
    +
  • + +
    +
    +

    Displays a message box with OK/Cancel buttons. Returns the button index that was clicked - "0" for OK and "1" for "Cancel"

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplinviewsmenuitems.html b/docs/api/references/plugin_api/classes/joplinviewsmenuitems.html new file mode 100644 index 0000000000..ae205324d7 --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplinviewsmenuitems.html @@ -0,0 +1,202 @@ + + + + + + joplin.views.menuItems | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.views.menuItems

+
+
+
+
+
+
+
+
+
+

Allows creating and managing menu items.

+
+

View the demo plugin

+
+
+ +
+

Index

+
+
+
+
+
+

Methods

+ +
+
+
+
+
+
+
+

Methods

+
+ +

create

+ +
    +
  • + +
    +
    +

    Creates a new menu item and associate it with the given command. You can specify under which menu the item should appear using the location parameter.

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplinviewsmenus.html b/docs/api/references/plugin_api/classes/joplinviewsmenus.html new file mode 100644 index 0000000000..637db6a7fb --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplinviewsmenus.html @@ -0,0 +1,203 @@ + + + + + + joplin.views.menus | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.views.menus

+
+
+
+
+
+
+
+
+
+

Allows creating menus.

+
+

View the demo plugin

+
+
+ +
+

Index

+
+
+
+
+
+

Methods

+ +
+
+
+
+
+
+
+

Methods

+
+ +

create

+ +
    +
  • + +
    +
    +

    Creates a new menu from the provided menu items and place it at the given location. As of now, it is only possible to place the + menu as a sub-menu of the application build-in menus.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +
    • +
    • +
      label: string
      +
    • +
    • +
      menuItems: MenuItem[]
      +
    • +
    • +
      Default value location: MenuItemLocation = MenuItemLocation.Tools
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplinviewspanels.html b/docs/api/references/plugin_api/classes/joplinviewspanels.html new file mode 100644 index 0000000000..003be35ca2 --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplinviewspanels.html @@ -0,0 +1,417 @@ + + + + + + joplin.views.panels | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.views.panels

+
+
+
+
+
+
+
+
+
+

Allows creating and managing view panels. View panels currently are + displayed at the right of the sidebar and allows displaying any HTML + content (within a webview) and update it in real-time. For example it + could be used to display a table of content for the active note, or + display various metadata or graph.

+
+

View the demo plugin

+
+
+ +
+

Index

+
+
+
+
+
+

Methods

+ +
+
+
+
+
+
+
+

Methods

+
+ +

addScript

+
    +
  • addScript(handle: ViewHandle, scriptPath: string): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Adds and loads a new JS or CSS files into the panel.

    +
    +
    +

    Parameters

    +
      +
    • +
      handle: ViewHandle
      +
    • +
    • +
      scriptPath: string
      +
    • +
    + +
  • +
+
+
+ +

create

+ +
    +
  • + +
    +
    +

    Creates a new panel

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +
    • +
    + +
  • +
+
+
+ +

hide

+ +
    +
  • + +
    +
    +

    Hides the panel

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

onMessage

+
    +
  • onMessage(handle: ViewHandle, callback: Function): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Called when a message is sent from the webview (using postMessage).

    +
    +

    To post a message from the webview to the plugin use:

    +
    const response = await webviewApi.postMessage(message);
    +
      +
    • message can be any JavaScript object, string or number
    • +
    • response is whatever was returned by the onMessage handler
    • +
    +

    Using this mechanism, you can have two-way communication between the + plugin and webview.

    +

    See the postMessage + demo for more details.

    +
    +

    Parameters

    +
      +
    • +
      handle: ViewHandle
      +
    • +
    • +
      callback: Function
      +
    • +
    + +
  • +
+
+
+ +

setHtml

+
    +
  • setHtml(handle: ViewHandle, html: string): Promise<string>
  • +
+
    +
  • + +
    +
    +

    Sets the panel webview HTML

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

show

+
    +
  • show(handle: ViewHandle, show?: boolean): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Shows the panel

    +
    +
    +

    Parameters

    +
      +
    • +
      handle: ViewHandle
      +
    • +
    • +
      Default value show: boolean = true
      +
    • +
    + +
  • +
+
+
+ +

visible

+
    +
  • visible(handle: ViewHandle): Promise<boolean>
  • +
+
    +
  • + +
    +
    +

    Tells whether the panel is visible or not

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplinviewstoolbarbuttons.html b/docs/api/references/plugin_api/classes/joplinviewstoolbarbuttons.html new file mode 100644 index 0000000000..3c8a334a33 --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplinviewstoolbarbuttons.html @@ -0,0 +1,199 @@ + + + + + + joplin.views.toolbarButtons | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.views.toolbarButtons

+
+
+
+
+
+
+
+
+
+

Allows creating and managing toolbar buttons.

+
+

View the demo plugin

+
+
+ +
+

Index

+
+
+
+
+
+

Methods

+ +
+
+
+
+
+
+
+

Methods

+
+ +

create

+ +
    +
  • + +
    +
    +

    Creates a new toolbar button and associate it with the given command.

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/classes/joplinworkspace.html b/docs/api/references/plugin_api/classes/joplinworkspace.html new file mode 100644 index 0000000000..08e43ad873 --- /dev/null +++ b/docs/api/references/plugin_api/classes/joplinworkspace.html @@ -0,0 +1,450 @@ + + + + + + joplin.workspace | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

joplin.workspace

+
+
+
+
+
+
+
+
+
+

The workspace service provides access to all the parts of Joplin that + are being worked on - i.e. the currently selected notes or notebooks as + well as various related events, such as when a new note is selected, or + when the note content changes.

+
+

View the demo plugin

+
+
+ +
+

Index

+
+ +
+
+
+
+
+

Methods

+
+ +

onNoteAlarmTrigger

+
    +
  • onNoteAlarmTrigger(handler: Function): Promise<Disposable>
  • +
+
    +
  • + +
    +
    +

    Called when an alarm associated with a to-do is triggered.

    +
    +
    +

    Parameters

    +
      +
    • +
      handler: Function
      +
    • +
    + +
  • +
+
+
+ +

onNoteChange

+ +
    +
  • + +
    +
    +

    Called when the content of the current note changes.

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

onNoteContentChange

+
    +
  • onNoteContentChange(callback: Function): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Called when the content of a note changes.

    +
    +
    +
    deprecated
    +

    Use onNoteChange() instead, which is reliably triggered whenever the note content, or any note property changes.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      callback: Function
      +
    • +
    + +
  • +
+
+
+ +

onNoteSelectionChange

+
    +
  • onNoteSelectionChange(callback: Function): Promise<Disposable>
  • +
+
    +
  • + +
    +
    +

    Called when a new note or notes are selected.

    +
    +
    +

    Parameters

    +
      +
    • +
      callback: Function
      +
    • +
    + +
  • +
+
+
+ +

onSyncComplete

+
    +
  • onSyncComplete(callback: Function): Promise<Disposable>
  • +
+
    +
  • + +
    +
    +

    Called when the synchronisation process has finished.

    +
    +
    +

    Parameters

    +
      +
    • +
      callback: Function
      +
    • +
    + +
  • +
+
+
+ +

onSyncStart

+ +
    +
  • + +
    +
    +

    Called when the synchronisation process is starting.

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

selectedFolder

+
    +
  • selectedFolder(): Promise<FolderEntity>
  • +
+
    +
  • + +
    +
    +

    Gets the currently selected folder. In some cases, for example during + search or when viewing a tag, no folder is actually selected in the user + interface. In that case, that function would return the last selected + folder.

    +
    +
    + +
  • +
+
+
+ +

selectedNote

+
    +
  • selectedNote(): Promise<any>
  • +
+
    +
  • + +
    +
    +

    Gets the currently selected note

    +
    +
    + +
  • +
+
+
+ +

selectedNoteIds

+
    +
  • selectedNoteIds(): Promise<string[]>
  • +
+
    +
  • + +
    +
    +

    Gets the IDs of the selected notes (can be zero, one, or many). Use the data API to retrieve information about these notes.

    +
    +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/enums/apptype.html b/docs/api/references/plugin_api/enums/apptype.html new file mode 100644 index 0000000000..4f7f7b9d6a --- /dev/null +++ b/docs/api/references/plugin_api/enums/apptype.html @@ -0,0 +1,166 @@ + + + + + + AppType | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

AppType

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

Cli

+
Cli: = "cli"
+ +
+
+ +

Desktop

+
Desktop: = "desktop"
+ +
+
+ +

Mobile

+
Mobile: = "mobile"
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/enums/contentscripttype.html b/docs/api/references/plugin_api/enums/contentscripttype.html new file mode 100644 index 0000000000..ccd03d3cc3 --- /dev/null +++ b/docs/api/references/plugin_api/enums/contentscripttype.html @@ -0,0 +1,305 @@ + + + + + + ContentScriptType | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ContentScriptType

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

CodeMirrorPlugin

+
CodeMirrorPlugin: = "codeMirrorPlugin"
+ +
+
+

Registers a new CodeMirror plugin, which should follow the template + below.

+
+
module.exports = {
+    default: function(context) {
+        return {
+            plugin: function(CodeMirror) {
+                // ...
+            },
+            codeMirrorResources: [],
+            codeMirrorOptions: {
+                                 // ...
+                      },
+            assets: {
+                // ...
+            },
+        }
+    }
+}
+
    +
  • The context argument is currently unused but could be used later on + to provide access to your own plugin so that the content script and + plugin can communicate.

    +
  • +
  • The plugin key is your CodeMirror plugin. This is where you can + register new commands with CodeMirror or interact with the CodeMirror + instance as needed.

    +
  • +
  • The codeMirrorResources key is an array of CodeMirror resources that + will be loaded and attached to the CodeMirror module. These are made up + of addons, keymaps, and modes. For example, for a plugin that want's to + enable clojure highlighting in code blocks. codeMirrorResources would + be set to ['mode/clojure/clojure'].

    +
  • +
  • The codeMirrorOptions key contains all the + CodeMirror options + that will be set or changed by this plugin. New options can alse be + declared via + CodeMirror.defineOption, + and then have their value set here. For example, a plugin that enables + line numbers would set codeMirrorOptions to {'lineNumbers': true}.

    +
  • +
  • Using the optional assets key you may specify only CSS assets + that should be loaded in the rendered HTML document. Check for example + the Joplin [Mermaid + plugin](https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts) + to see how the data should be structured.

    +
  • +
+

One of the plugin, codeMirrorResources, or codeMirrorOptions keys + must be provided for the plugin to be valid. Having multiple or all + provided is also okay.

+

See also the demo + plugin + for an example of all these keys being used in one plugin.

+ +

Posting messages from the content script to your plugin

+
+

In order to post messages to the plugin, you can use the postMessage + function passed to the context.

+
const response = await context.postMessage('messageFromCodeMirrorContentScript');
+

When you post a message, the plugin can send back a response thus + allowing two-way communication:

+
await joplin.contentScripts.onMessage(contentScriptId, (message) => {
+    // Process message
+    return response; // Can be any object, string or number
+});
+

See JoplinContentScripts.onMessage for more details, as well as + the postMessage + demo.

+
+
+
+ +

MarkdownItPlugin

+
MarkdownItPlugin: = "markdownItPlugin"
+ +
+
+

Registers a new Markdown-It plugin, which should follow the template + below.

+
+
module.exports = {
+    default: function(context) {
+        return {
+            plugin: function(markdownIt, options) {
+                // ...
+            },
+            assets: {
+                // ...
+            },
+        }
+    }
+}
+

See the + demo + for a simple Markdown-it plugin example.

+ +

Exported members

+
+
    +
  • The context argument is currently unused but could be used later on + to provide access to your own plugin so that the content script and + plugin can communicate.

    +
  • +
  • The required plugin key is the actual Markdown-It plugin - check + the official doc for more + information. The options parameter is of type + RuleOptions, + which contains a number of options, mostly useful for Joplin's internal + code.

    +
  • +
  • Using the optional assets key you may specify assets such as JS + or CSS that should be loaded in the rendered HTML document. Check for + example the Joplin [Mermaid + plugin](https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts) + to see how the data should be structured.

    +
  • +
+ +

Posting messages from the content script to your plugin

+
+

The application provides the following function to allow executing + commands from the rendered HTML code:

+
const response = await webviewApi.postMessage(contentScriptId, message);
+
    +
  • contentScriptId is the ID you've defined when you registered the + content script. You can retrieve it from the + context.
  • +
  • message can be any basic JavaScript type (number, string, plain + object), but it cannot be a function or class instance.
  • +
+

When you post a message, the plugin can send back a response thus + allowing two-way communication:

+
await joplin.contentScripts.onMessage(contentScriptId, (message) => {
+    // Process message
+    return response; // Can be any object, string or number
+});
+

See JoplinContentScripts.onMessage for more details, as well as + the postMessage + demo.

+ +

Registering an existing Markdown-it plugin

+
+

To include a regular Markdown-It plugin, that doesn't make use of any + Joplin-specific features, you would simply create a file such as this:

+
module.exports = {
+    default: function(context) {
+        return {
+            plugin: require('markdown-it-toc-done-right');
+        }
+    }
+}
+
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/enums/filesystemitem.html b/docs/api/references/plugin_api/enums/filesystemitem.html new file mode 100644 index 0000000000..3e50ac8216 --- /dev/null +++ b/docs/api/references/plugin_api/enums/filesystemitem.html @@ -0,0 +1,155 @@ + + + + + + FileSystemItem | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

FileSystemItem

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

Directory

+
Directory: = "directory"
+ +
+
+ +

File

+
File: = "file"
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/enums/importmoduleoutputformat.html b/docs/api/references/plugin_api/enums/importmoduleoutputformat.html new file mode 100644 index 0000000000..3ff3b40f3a --- /dev/null +++ b/docs/api/references/plugin_api/enums/importmoduleoutputformat.html @@ -0,0 +1,155 @@ + + + + + + ImportModuleOutputFormat | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ImportModuleOutputFormat

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

Html

+
Html: = "html"
+ +
+
+ +

Markdown

+
Markdown: = "md"
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/enums/itemchangeeventtype.html b/docs/api/references/plugin_api/enums/itemchangeeventtype.html new file mode 100644 index 0000000000..9888a90b69 --- /dev/null +++ b/docs/api/references/plugin_api/enums/itemchangeeventtype.html @@ -0,0 +1,166 @@ + + + + + + ItemChangeEventType | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ItemChangeEventType

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

Create

+
Create: = 1
+ +
+
+ +

Delete

+
Delete: = 3
+ +
+
+ +

Update

+
Update: = 2
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/enums/menuitemlocation.html b/docs/api/references/plugin_api/enums/menuitemlocation.html new file mode 100644 index 0000000000..a6f8ce0294 --- /dev/null +++ b/docs/api/references/plugin_api/enums/menuitemlocation.html @@ -0,0 +1,288 @@ + + + + + + MenuItemLocation | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

MenuItemLocation

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

Context

+
Context: = "context"
+ +
+
+
deprecated
+

Do not use - same as NoteListContextMenu

+
+
+
+
+
+ +

Edit

+
Edit: = "edit"
+ +
+
+ +

EditorContextMenu

+
EditorContextMenu: = "editorContextMenu"
+ +
+
+ +

File

+
File: = "file"
+ +
+
+ +

FolderContextMenu

+
FolderContextMenu: = "folderContextMenu"
+ +
+
+

When a command is called from a folder context menu, the + command will receive the following arguments:

+
+
    +
  • folderId:string: ID of the folder that was right-clicked on
  • +
+
+
+
+ +

Help

+
Help: = "help"
+ +
+
+ +

Note

+
Note: = "note"
+ +
+
+ +

NoteListContextMenu

+
NoteListContextMenu: = "noteListContextMenu"
+ +
+
+

When a command is called from the note list context menu, the + command will receive the following arguments:

+
+
    +
  • noteIds:string[]: IDs of the notes that were right-clicked on.
  • +
+
+
+
+ +

TagContextMenu

+
TagContextMenu: = "tagContextMenu"
+ +
+
+

When a command is called from a tag context menu, the + command will receive the following arguments:

+
+
    +
  • tagId:string: ID of the tag that was right-clicked on
  • +
+
+
+
+ +

Tools

+
Tools: = "tools"
+ +
+
+ +

View

+
View: = "view"
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/enums/settingitemtype.html b/docs/api/references/plugin_api/enums/settingitemtype.html new file mode 100644 index 0000000000..022b162d9f --- /dev/null +++ b/docs/api/references/plugin_api/enums/settingitemtype.html @@ -0,0 +1,199 @@ + + + + + + SettingItemType | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

SettingItemType

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

Array

+
Array: = 4
+ +
+
+ +

Bool

+
Bool: = 3
+ +
+
+ +

Button

+
Button: = 6
+ +
+
+ +

Int

+
Int: = 1
+ +
+
+ +

Object

+
Object: = 5
+ +
+
+ +

String

+
String: = 2
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/enums/settingstorage.html b/docs/api/references/plugin_api/enums/settingstorage.html new file mode 100644 index 0000000000..78744c097b --- /dev/null +++ b/docs/api/references/plugin_api/enums/settingstorage.html @@ -0,0 +1,155 @@ + + + + + + SettingStorage | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

SettingStorage

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

Database

+
Database: = 1
+ +
+
+ +

File

+
File: = 2
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/enums/toolbarbuttonlocation.html b/docs/api/references/plugin_api/enums/toolbarbuttonlocation.html new file mode 100644 index 0000000000..334da0a1d7 --- /dev/null +++ b/docs/api/references/plugin_api/enums/toolbarbuttonlocation.html @@ -0,0 +1,165 @@ + + + + + + ToolbarButtonLocation | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ToolbarButtonLocation

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

EditorToolbar

+
EditorToolbar: = "editorToolbar"
+ +
+
+

This toolbar is right above the text editor. It applies to the note body only.

+
+
+
+
+ +

NoteToolbar

+
NoteToolbar: = "noteToolbar"
+ +
+
+

This toolbar in the top right corner of the application. It applies to the note as a whole, including its metadata.

+
+
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/globals.html b/docs/api/references/plugin_api/globals.html new file mode 100644 index 0000000000..8a8191560e --- /dev/null +++ b/docs/api/references/plugin_api/globals.html @@ -0,0 +1,550 @@ + + + + + + Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+
    + +
+

Joplin Plugin API Documentation

+
+
+
+
+
+
+
+

Index

+
+ +
+
+
+

Type aliases

+
+ +

ButtonId

+
ButtonId: string
+ +
+
+ +

ChangeHandler

+
ChangeHandler: (event: ChangeEvent) => void
+ +
+

Type declaration

+ +
+
+
+ +

ItemChangeHandler

+
ItemChangeHandler: (event: ItemChangeEvent) => void
+ +
+

Type declaration

+ +
+
+
+ +

Path

+
Path: string[]
+ +
+
+

An array of at least one element and at most three elements.

+
+
    +
  • [0]: Resource name (eg. "notes", "folders", "tags", etc.)
  • +
  • [1]: (Optional) Resource ID.
  • +
  • [2]: (Optional) Resource link.
  • +
+
+
+
+ +

PostMessageHandler

+
PostMessageHandler: (id: string, message: any) => Promise<any>
+ +
+

Type declaration

+
    +
  • +
      +
    • (id: string, message: any): Promise<any>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        id: string
        +
      • +
      • +
        message: any
        +
      • +
      + +
    • +
    +
  • +
+
+
+
+ +

SyncStartHandler

+
SyncStartHandler: (event: SyncStartEvent) => void
+ +
+

Type declaration

+ +
+
+
+ +

ViewHandle

+
ViewHandle: string
+ +
+
+
+

Variables

+
+ +

Const logger

+
logger: LoggerWrapper = Logger.create('joplin.plugins')
+ +
+
+
+

Functions

+
+ +

isContextMenuItemLocation

+ + +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/index.html b/docs/api/references/plugin_api/index.html new file mode 100644 index 0000000000..7b6352ad2a --- /dev/null +++ b/docs/api/references/plugin_api/index.html @@ -0,0 +1,265 @@ + + + + + + Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+
    + +
+

Joplin Plugin API Documentation

+
+
+
+ + +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/buttonspec.html b/docs/api/references/plugin_api/interfaces/buttonspec.html new file mode 100644 index 0000000000..01c6b61ac2 --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/buttonspec.html @@ -0,0 +1,197 @@ + + + + + + ButtonSpec | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ButtonSpec

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

id

+ + +
+
+ +

Optional title

+
title: string
+ +
+
+
+

Methods

+
+ +

Optional onClick

+
    +
  • onClick(): void
  • +
+
    +
  • + + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/changeevent.html b/docs/api/references/plugin_api/interfaces/changeevent.html new file mode 100644 index 0000000000..8382f4122d --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/changeevent.html @@ -0,0 +1,161 @@ + + + + + + ChangeEvent | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ChangeEvent

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

keys

+
keys: string[]
+ +
+
+

Setting keys that have been changed

+
+
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/command.html b/docs/api/references/plugin_api/interfaces/command.html new file mode 100644 index 0000000000..1c9f4a29ac --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/command.html @@ -0,0 +1,296 @@ + + + + + + Command | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

Command

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

Optional enabledCondition

+
enabledCondition: string
+ +
+
+

Defines whether the command should be enabled or disabled, which in turns + affects the enabled state of any associated button or menu item.

+
+

The condition should be expressed as a "when-clause" (as in Visual Studio + Code). It's a simple boolean expression that evaluates to true or + false. It supports the following operators:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OperatorSymbolExample
Equality=="editorType == markdown"
Inequality!="currentScreen != config"
Or||"noteIsTodo || noteTodoCompleted"
And&&"oneNoteSelected && !inConflictFolder"
+

Joplin, unlike VSCode, also supports parenthesis, which allows creating + more complex expressions such as cond1 || (cond2 && cond3). Only one + level of parenthesis is possible (nested ones aren't supported).

+

Currently the supported context variables aren't documented, but you can + find the list below:

+ +

Note: Commands are enabled by default unless you use this property.

+
+
+
+ +

Optional iconName

+
iconName: string
+ +
+
+

Icon to be used on toolbar buttons for example

+
+
+
+
+ +

Optional label

+
label: string
+ +
+
+

Label to be displayed on menu items or keyboard shortcut editor for example. + If it is missing, it's assumed it's a private command, to be called programmatically only. + In that case the command will not appear in the shortcut editor or command panel, and logically + should not be used as a menu item.

+
+
+
+
+ +

name

+
name: string
+ +
+
+

Name of command - must be globally unique

+
+
+
+
+
+

Methods

+
+ +

execute

+
    +
  • execute(...args: any[]): Promise<any | void>
  • +
+
    +
  • + +
    +
    +

    Code to be ran when the command is executed. It may return a result.

    +
    +
    +

    Parameters

    +
      +
    • +
      Rest ...args: any[]
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/contentscriptcontext.html b/docs/api/references/plugin_api/interfaces/contentscriptcontext.html new file mode 100644 index 0000000000..d934b9960a --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/contentscriptcontext.html @@ -0,0 +1,200 @@ + + + + + + ContentScriptContext | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ContentScriptContext

+
+
+
+
+
+
+
+
+
+

When a content script is initialised, it receives a context object.

+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

contentScriptId

+
contentScriptId: string
+ +
+
+

The content script ID, which may be necessary to post messages

+
+
+
+
+ +

pluginId

+
pluginId: string
+ +
+
+

The plugin ID that registered this content script

+
+
+
+
+ +

postMessage

+
postMessage: PostMessageHandler
+ +
+
+

Can be used by CodeMirror content scripts to post a message to the plugin

+
+
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/createmenuitemoptions.html b/docs/api/references/plugin_api/interfaces/createmenuitemoptions.html new file mode 100644 index 0000000000..27206acbea --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/createmenuitemoptions.html @@ -0,0 +1,156 @@ + + + + + + CreateMenuItemOptions | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

CreateMenuItemOptions

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

accelerator

+
accelerator: string
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/dialogresult.html b/docs/api/references/plugin_api/interfaces/dialogresult.html new file mode 100644 index 0000000000..e84b9f192c --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/dialogresult.html @@ -0,0 +1,167 @@ + + + + + + DialogResult | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

DialogResult

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional formData

+
formData: any
+ +
+
+ +

id

+ + +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/disposable.html b/docs/api/references/plugin_api/interfaces/disposable.html new file mode 100644 index 0000000000..f6bee1b009 --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/disposable.html @@ -0,0 +1,128 @@ + + + + + + Disposable | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

Disposable

+
+
+
+
+
+
+ +
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/editorcommand.html b/docs/api/references/plugin_api/interfaces/editorcommand.html new file mode 100644 index 0000000000..581e1731e5 --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/editorcommand.html @@ -0,0 +1,167 @@ + + + + + + EditorCommand | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

EditorCommand

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+ +

Optional value

+
value: any
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/exportcontext.html b/docs/api/references/plugin_api/interfaces/exportcontext.html new file mode 100644 index 0000000000..76faf0c89d --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/exportcontext.html @@ -0,0 +1,183 @@ + + + + + + ExportContext | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ExportContext

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

destPath

+
destPath: string
+ +
+
+ +

options

+
options: ExportOptions
+ +
+
+ +

Optional userData

+
userData: any
+ +
+
+

You can attach your own custom data using this propery - it will then be passed to each event handler, allowing you to keep state from one event to the next.

+
+
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/exportmodule.html b/docs/api/references/plugin_api/interfaces/exportmodule.html new file mode 100644 index 0000000000..c58da7aa6e --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/exportmodule.html @@ -0,0 +1,388 @@ + + + + + + ExportModule | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ExportModule

+
+
+
+
+
+
+
+
+
+

Used to implement a module to export data from Joplin. View the demo plugin for an example.

+
+

In general, all the event handlers you'll need to implement take a context object as a first argument. This object will contain the export or import path as well as various optional properties, such as which notes or notebooks need to be exported.

+

To get a better sense of what it will contain it can be useful to print it using console.info(context).

+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+

The description that will appear in the UI, for example in the menu item.

+
+
+
+
+ +

Optional fileExtensions

+
fileExtensions: string[]
+ +
+
+

The extensions of the files exported by your module. For example, it is ["htm", "html"] for the HTML module, and just ["jex"] for the JEX module.

+
+
+
+
+ +

format

+
format: string
+ +
+
+

The format to be exported, eg "enex", "jex", "json", etc.

+
+
+
+
+ +

isNoteArchive

+
isNoteArchive: boolean
+ +
+
+

Only applies to single file exporters or importers + It tells whether the format can package multiple notes into one file. + For example JEX or ENEX can, but HTML cannot.

+
+
+
+
+ +

target

+ + +
+
+

Whether the module will export a single file or multiple files in a directory. It affects the open dialog that will be presented to the user when using your exporter.

+
+
+
+
+
+

Methods

+
+ +

onClose

+ +
    +
  • + +
    +
    +

    Called when the export process is done.

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

onInit

+ +
    +
  • + +
    +
    +

    Called when the export process starts.

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+ +

onProcessItem

+
    +
  • onProcessItem(context: ExportContext, itemType: number, item: any): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Called when an item needs to be processed. An "item" can be any Joplin object, such as a note, a folder, a notebook, etc.

    +
    +
    +

    Parameters

    +
      +
    • +
      context: ExportContext
      +
    • +
    • +
      itemType: number
      +
    • +
    • +
      item: any
      +
    • +
    + +
  • +
+
+
+ +

onProcessResource

+
    +
  • onProcessResource(context: ExportContext, resource: any, filePath: string): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Called when a resource file needs to be exported.

    +
    +
    +

    Parameters

    +
      +
    • +
      context: ExportContext
      +
    • +
    • +
      resource: any
      +
    • +
    • +
      filePath: string
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/exportoptions.html b/docs/api/references/plugin_api/interfaces/exportoptions.html new file mode 100644 index 0000000000..49689a4a2f --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/exportoptions.html @@ -0,0 +1,200 @@ + + + + + + ExportOptions | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ExportOptions

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional format

+
format: string
+ +
+
+ +

Optional path

+
path: string
+ +
+
+ +

Optional sourceFolderIds

+
sourceFolderIds: string[]
+ +
+
+ +

Optional sourceNoteIds

+
sourceNoteIds: string[]
+ +
+
+ +

Optional target

+ + +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/importcontext.html b/docs/api/references/plugin_api/interfaces/importcontext.html new file mode 100644 index 0000000000..06bc664056 --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/importcontext.html @@ -0,0 +1,178 @@ + + + + + + ImportContext | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ImportContext

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

options

+
options: any
+ +
+
+ +

sourcePath

+
sourcePath: string
+ +
+
+ +

warnings

+
warnings: string[]
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/importmodule.html b/docs/api/references/plugin_api/interfaces/importmodule.html new file mode 100644 index 0000000000..587e5ce8cd --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/importmodule.html @@ -0,0 +1,284 @@ + + + + + + ImportModule | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ImportModule

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+

The description that will appear in the UI, for example in the menu item.

+
+
+
+
+ +

Optional fileExtensions

+
fileExtensions: string[]
+ +
+
+

Tells the file extensions of the exported files.

+
+
+
+
+ +

format

+
format: string
+ +
+
+

The format to be exported, eg "enex", "jex", "json", etc.

+
+
+
+
+ +

isNoteArchive

+
isNoteArchive: boolean
+ +
+
+

Only applies to single file exporters or importers + It tells whether the format can package multiple notes into one file. + For example JEX or ENEX can, but HTML cannot.

+
+
+
+
+ +

Optional outputFormat

+ + +
+
+

Tells the type of notes that will be generated, either HTML or Markdown (default).

+
+
+
+
+ +

sources

+
sources: FileSystemItem[]
+ +
+
+

The type of sources that are supported by the module. Tells whether the module can import files or directories or both.

+
+
+
+
+
+

Methods

+
+ +

onExec

+ +
    +
  • + +
    +
    +

    Called when the import process starts. There is only one event handler within which you should import the complete data.

    +
    +
    +

    Parameters

    + + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/itemchangeevent.html b/docs/api/references/plugin_api/interfaces/itemchangeevent.html new file mode 100644 index 0000000000..1deb91b5c0 --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/itemchangeevent.html @@ -0,0 +1,167 @@ + + + + + + ItemChangeEvent | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

ItemChangeEvent

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

event

+ + +
+
+ +

id

+
id: string
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/menuitem.html b/docs/api/references/plugin_api/interfaces/menuitem.html new file mode 100644 index 0000000000..7571b7cec3 --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/menuitem.html @@ -0,0 +1,210 @@ + + + + + + MenuItem | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

MenuItem

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional accelerator

+
accelerator: string
+ +
+
+

Accelerator associated with the menu item

+
+
+
+
+ +

Optional commandName

+
commandName: string
+ +
+
+

Command that should be associated with the menu item. All menu item should + have a command associated with them unless they are a sub-menu.

+
+
+
+
+ +

Optional label

+
label: string
+ +
+
+

Menu item label. If not specified, the command label will be used instead.

+
+
+
+
+ +

Optional submenu

+
submenu: MenuItem[]
+ +
+
+

Menu items that should appear below this menu item. Allows creating a menu tree.

+
+
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/script.html b/docs/api/references/plugin_api/interfaces/script.html new file mode 100644 index 0000000000..7c469faa0d --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/script.html @@ -0,0 +1,173 @@ + + + + + + Script | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

Script

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Methods

+ +
+
+
+
+
+

Methods

+
+ +

Optional onStart

+
    +
  • onStart(event: any): Promise<void>
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      event: any
      +
    • +
    + +
  • +
+
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/settingitem.html b/docs/api/references/plugin_api/interfaces/settingitem.html new file mode 100644 index 0000000000..7841a7348d --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/settingitem.html @@ -0,0 +1,364 @@ + + + + + + SettingItem | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

SettingItem

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional advanced

+
advanced: boolean
+ +
+
+

An advanced setting will be moved under the "Advanced" button in the + config screen.

+
+
+
+
+ +

Optional appTypes

+
appTypes: AppType[]
+ +
+
+

Reserved property. Not used at the moment.

+
+
+
+
+ +

Optional description

+
description: string
+ +
+
+ +

Optional isEnum

+
isEnum: boolean
+ +
+
+

To create a setting with multiple options, set this property to true. + That setting will render as a dropdown list in the configuration screen.

+
+
+
+
+ +

label

+
label: string
+ +
+
+ +

Optional maximum

+
maximum: number
+ +
+
+ +

Optional minimum

+
minimum: number
+ +
+
+

Set the min, max and step values if you want to restrict an int setting + to a particular range.

+
+
+
+
+ +

Optional options

+
options: Record<any, any>
+ +
+
+

This property is required when isEnum is true. In which case, it + should contain a map of value => label.

+
+
+
+
+ +

public

+
public: boolean
+ +
+
+

A public setting will appear in the Configuration screen and will be + modifiable by the user. A private setting however will not appear there, + and can only be changed programmatically. You may use this to store some + values that you do not want to directly expose.

+
+
+
+
+ +

Optional section

+
section: string
+ +
+
+

You would usually set this to a section you would have created + specifically for the plugin.

+
+
+
+
+ +

Optional secure

+
secure: boolean
+ +
+
+

Set this to true to store secure data, such as passwords. Any such + setting will be stored in the system keychain if one is available.

+
+
+
+
+ +

Optional step

+
step: number
+ +
+
+ +

Optional storage

+ + +
+
+

Either store the setting in the database or in settings.json. Defaults to database.

+
+
+
+
+ +

type

+ + +
+
+ +

value

+
value: any
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/settingsection.html b/docs/api/references/plugin_api/interfaces/settingsection.html new file mode 100644 index 0000000000..0a0213bd88 --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/settingsection.html @@ -0,0 +1,189 @@ + + + + + + SettingSection | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

SettingSection

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional description

+
description: string
+ +
+
+ +

Optional iconName

+
iconName: string
+ +
+
+ +

label

+
label: string
+ +
+
+ +

Optional name

+
name: string
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/api/references/plugin_api/interfaces/syncstartevent.html b/docs/api/references/plugin_api/interfaces/syncstartevent.html new file mode 100644 index 0000000000..cc27d4cc9c --- /dev/null +++ b/docs/api/references/plugin_api/interfaces/syncstartevent.html @@ -0,0 +1,156 @@ + + + + + + SyncStartEvent | Joplin Plugin API Documentation + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + +
+
+ Menu +
+
+
+
+
+
+ +

SyncStartEvent

+
+
+
+
+
+
+ +
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

withErrors

+
withErrors: boolean
+ +
+
+
+ +
+
+ +
+ + + \ No newline at end of file diff --git a/docs/schema/settings.json b/docs/schema/settings.json new file mode 100644 index 0000000000..feda0f64b0 --- /dev/null +++ b/docs/schema/settings.json @@ -0,0 +1,891 @@ +{ + "title": "JSON schema for Joplin setting files", + "$id": "https://joplinapp.org/schema/settings.json", + "$schema": "https://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "clientId": { + "type": "string", + "default": "", + "$comment": "private" + }, + "editor.codeView": { + "type": "boolean", + "default": true, + "$comment": "private" + }, + "sync.target": { + "type": "integer", + "default": 7, + "description": "Synchronisation target", + "enum": [ + 2, + 3, + 5, + 6, + 7, + 8, + 9, + 10 + ] + }, + "sync.upgradeState": { + "type": "integer", + "default": 0, + "$comment": "private" + }, + "sync.startupOperation": { + "type": "integer", + "default": 0, + "$comment": "private" + }, + "sync.2.path": { + "type": "string", + "default": "", + "description": "Directory to synchronise with (absolute path). Attention: If you change this location, make sure you copy all your content to it before syncing, otherwise all files will be removed! See the FAQ for more details: https://joplinapp.org/faq/" + }, + "sync.5.path": { + "type": "string", + "default": "", + "description": "Nextcloud WebDAV URL. Attention: If you change this location, make sure you copy all your content to it before syncing, otherwise all files will be removed! See the FAQ for more details: https://joplinapp.org/faq/" + }, + "sync.5.username": { + "type": "string", + "default": "", + "description": "Nextcloud username" + }, + "sync.5.password": { + "type": "string", + "default": "", + "description": "Nextcloud password", + "$comment": "private" + }, + "sync.6.path": { + "type": "string", + "default": "", + "description": "WebDAV URL. Attention: If you change this location, make sure you copy all your content to it before syncing, otherwise all files will be removed! See the FAQ for more details: https://joplinapp.org/faq/" + }, + "sync.6.username": { + "type": "string", + "default": "", + "description": "WebDAV username" + }, + "sync.6.password": { + "type": "string", + "default": "", + "description": "WebDAV password", + "$comment": "private" + }, + "sync.8.path": { + "type": "string", + "default": "", + "description": "AWS S3 bucket. Attention: If you change this location, make sure you copy all your content to it before syncing, otherwise all files will be removed! See the FAQ for more details: https://joplinapp.org/faq/" + }, + "sync.8.url": { + "type": "string", + "default": "https://s3.amazonaws.com/", + "description": "AWS S3 URL" + }, + "sync.8.username": { + "type": "string", + "default": "", + "description": "AWS key" + }, + "sync.8.password": { + "type": "string", + "default": "", + "description": "AWS secret", + "$comment": "private" + }, + "sync.9.path": { + "type": "string", + "default": "", + "description": "Joplin Server URL. Attention: If you change this location, make sure you copy all your content to it before syncing, otherwise all files will be removed! See the FAQ for more details: https://joplinapp.org/faq/" + }, + "sync.9.userContentPath": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.9.username": { + "type": "string", + "default": "", + "description": "Joplin Server email" + }, + "sync.9.password": { + "type": "string", + "default": "", + "description": "Joplin Server password", + "$comment": "private" + }, + "sync.10.path": { + "type": "string", + "default": "https://api.joplincloud.com", + "$comment": "private" + }, + "sync.10.userContentPath": { + "type": "string", + "default": "https://joplinusercontent.com", + "$comment": "private" + }, + "sync.10.username": { + "type": "string", + "default": "", + "description": "Joplin Cloud email" + }, + "sync.10.password": { + "type": "string", + "default": "", + "description": "Joplin Cloud password", + "$comment": "private" + }, + "sync.5.syncTargets": { + "type": "object", + "default": {}, + "$comment": "private" + }, + "sync.resourceDownloadMode": { + "type": "string", + "default": "always", + "description": "Attachment download behaviour. In \"Manual\" mode, attachments are downloaded only when you click on them. In \"Auto\", they are downloaded when you open the note. In \"Always\", all the attachments are downloaded whether you open the note or not.", + "enum": [ + "always", + "manual", + "auto" + ] + }, + "sync.3.auth": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.4.auth": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.7.auth": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.9.auth": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.10.auth": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.1.context": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.2.context": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.3.context": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.4.context": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.5.context": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.6.context": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.7.context": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.8.context": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.9.context": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.10.context": { + "type": "string", + "default": "", + "$comment": "private" + }, + "sync.maxConcurrentConnections": { + "type": "integer", + "default": 5, + "description": "Max concurrent connections", + "minimum": 1, + "maximum": 20 + }, + "activeFolderId": { + "type": "string", + "default": "", + "$comment": "private" + }, + "richTextBannerDismissed": { + "type": "boolean", + "default": false, + "$comment": "private" + }, + "firstStart": { + "type": "boolean", + "default": true, + "$comment": "private" + }, + "locale": { + "type": "string", + "default": "en_GB", + "description": "Language", + "enum": [ + "ar", + "eu", + "bs_BA", + "bg_BG", + "ca", + "hr_HR", + "cs_CZ", + "da_DK", + "de_DE", + "et_EE", + "en_GB", + "en_US", + "es_ES", + "eo", + "fi_FI", + "fr_FR", + "gl_ES", + "id_ID", + "it_IT", + "hu_HU", + "nl_BE", + "nl_NL", + "nb_NO", + "fa", + "pl_PL", + "pt_BR", + "pt_PT", + "ro", + "sl_SI", + "sv", + "th_TH", + "vi", + "tr_TR", + "uk_UA", + "el_GR", + "ru_RU", + "sr_RS", + "zh_CN", + "zh_TW", + "ja_JP", + "ko" + ] + }, + "dateFormat": { + "type": "string", + "default": "DD/MM/YYYY", + "description": "Date format", + "enum": [ + "DD/MM/YYYY", + "DD/MM/YY", + "MM/DD/YYYY", + "MM/DD/YY", + "YYYY-MM-DD", + "DD.MM.YYYY", + "YYYY.MM.DD", + "YYMMDD" + ] + }, + "timeFormat": { + "type": "string", + "default": "HH:mm", + "description": "Time format", + "enum": [ + "HH:mm", + "h:mm A" + ] + }, + "theme": { + "type": "integer", + "default": 1, + "description": "Theme", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 22 + ] + }, + "themeAutoDetect": { + "type": "boolean", + "default": false, + "description": "Automatically switch theme to match system theme" + }, + "preferredLightTheme": { + "type": "integer", + "default": 1, + "description": "Preferred light theme", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 22 + ] + }, + "preferredDarkTheme": { + "type": "integer", + "default": 2, + "description": "Preferred dark theme", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 22 + ] + }, + "notificationPermission": { + "type": "string", + "default": "", + "$comment": "private" + }, + "showNoteCounts": { + "type": "boolean", + "default": true, + "description": "Show note counts", + "$comment": "private" + }, + "layoutButtonSequence": { + "type": "integer", + "default": 0, + "enum": [ + 0, + 1, + 2, + 3 + ], + "$comment": "private" + }, + "uncompletedTodosOnTop": { + "type": "boolean", + "default": true, + "description": "Uncompleted to-dos on top" + }, + "showCompletedTodos": { + "type": "boolean", + "default": true, + "description": "Show completed to-dos" + }, + "notes.sortOrder.field": { + "type": "string", + "default": "user_updated_time", + "description": "Sort notes by", + "enum": [ + "user_updated_time", + "user_created_time", + "title", + "order" + ] + }, + "editor.autoMatchingBraces": { + "type": "boolean", + "default": true, + "description": "Auto-pair braces, parenthesis, quotations, etc." + }, + "notes.sortOrder.reverse": { + "type": "boolean", + "default": true, + "description": "Reverse sort order" + }, + "folders.sortOrder.field": { + "type": "string", + "default": "title", + "description": "Sort notebooks by", + "enum": [ + "title", + "last_note_user_updated_time" + ] + }, + "folders.sortOrder.reverse": { + "type": "boolean", + "default": false, + "description": "Reverse sort order" + }, + "trackLocation": { + "type": "boolean", + "default": true, + "description": "Save geo-location with notes" + }, + "editor.beta": { + "type": "boolean", + "default": false, + "description": "Opt-in to the editor beta. This beta adds list continuation, Markdown preview, and Markdown shortcuts. If you find bugs, please report them in the Discourse forum.", + "$comment": "private" + }, + "newTodoFocus": { + "type": "string", + "default": "title", + "description": "When creating a new to-do:", + "enum": [ + "title", + "body" + ] + }, + "newNoteFocus": { + "type": "string", + "default": "body", + "description": "When creating a new note:", + "enum": [ + "title", + "body" + ] + }, + "plugins.states": { + "type": "object", + "default": "", + "$comment": "private" + }, + "plugins.devPluginPaths": { + "type": "string", + "default": "", + "description": "Development plugins. You may add multiple plugin paths, each separated by a comma. You will need to restart the application for the changes to take effect." + }, + "markdown.softbreaks": { + "type": "boolean", + "default": false, + "$comment": "private" + }, + "markdown.typographer": { + "type": "boolean", + "default": false, + "$comment": "private" + }, + "markdown.plugin.softbreaks": { + "type": "boolean", + "default": false, + "description": "Enable soft breaks" + }, + "markdown.plugin.typographer": { + "type": "boolean", + "default": false, + "description": "Enable typographer support" + }, + "markdown.plugin.linkify": { + "type": "boolean", + "default": true, + "description": "Enable Linkify" + }, + "markdown.plugin.katex": { + "type": "boolean", + "default": true, + "description": "Enable math expressions" + }, + "markdown.plugin.fountain": { + "type": "boolean", + "default": false, + "description": "Enable Fountain syntax support" + }, + "markdown.plugin.mermaid": { + "type": "boolean", + "default": true, + "description": "Enable Mermaid diagrams support" + }, + "markdown.plugin.audioPlayer": { + "type": "boolean", + "default": true, + "description": "Enable audio player" + }, + "markdown.plugin.videoPlayer": { + "type": "boolean", + "default": true, + "description": "Enable video player" + }, + "markdown.plugin.pdfViewer": { + "type": "boolean", + "default": true, + "description": "Enable PDF viewer" + }, + "markdown.plugin.mark": { + "type": "boolean", + "default": true, + "description": "Enable ==mark== syntax" + }, + "markdown.plugin.footnote": { + "type": "boolean", + "default": true, + "description": "Enable footnotes" + }, + "markdown.plugin.toc": { + "type": "boolean", + "default": true, + "description": "Enable table of contents extension" + }, + "markdown.plugin.sub": { + "type": "boolean", + "default": false, + "description": "Enable ~sub~ syntax" + }, + "markdown.plugin.sup": { + "type": "boolean", + "default": false, + "description": "Enable ^sup^ syntax" + }, + "markdown.plugin.deflist": { + "type": "boolean", + "default": false, + "description": "Enable deflist syntax" + }, + "markdown.plugin.abbr": { + "type": "boolean", + "default": false, + "description": "Enable abbreviation syntax" + }, + "markdown.plugin.emoji": { + "type": "boolean", + "default": false, + "description": "Enable markdown emoji" + }, + "markdown.plugin.insert": { + "type": "boolean", + "default": false, + "description": "Enable ++insert++ syntax" + }, + "markdown.plugin.multitable": { + "type": "boolean", + "default": false, + "description": "Enable multimarkdown table extension" + }, + "showTrayIcon": { + "type": "boolean", + "default": true, + "description": "Show tray icon. This will allow Joplin to run in the background. It is recommended to enable this setting so that your notes are constantly being synchronised, thus reducing the number of conflicts." + }, + "startMinimized": { + "type": "boolean", + "default": false, + "description": "Start application minimised in the tray icon" + }, + "collapsedFolderIds": { + "type": "array", + "default": [], + "$comment": "private" + }, + "keychain.supported": { + "type": "integer", + "default": -1, + "$comment": "private" + }, + "db.ftsEnabled": { + "type": "integer", + "default": -1, + "$comment": "private" + }, + "db.fuzzySearchEnabled": { + "type": "integer", + "default": -1, + "$comment": "private" + }, + "encryption.enabled": { + "type": "boolean", + "default": false, + "$comment": "private" + }, + "encryption.activeMasterKeyId": { + "type": "string", + "default": "", + "$comment": "private" + }, + "encryption.passwordCache": { + "type": "object", + "default": {}, + "$comment": "private" + }, + "encryption.shouldReencrypt": { + "type": "integer", + "default": -1, + "$comment": "private" + }, + "sync.userId": { + "type": "string", + "default": "", + "$comment": "private" + }, + "style.zoom": { + "type": "integer", + "default": 100, + "minimum": 50, + "maximum": 500, + "$comment": "private" + }, + "style.editor.fontSize": { + "type": "integer", + "default": 13, + "description": "Editor font size", + "minimum": 4, + "maximum": 50 + }, + "style.editor.fontFamily": { + "type": "string", + "default": "", + "description": "Editor font family. Used for most text in the markdown editor. If not found, a generic proportional (variable width) font is used." + }, + "style.editor.monospaceFontFamily": { + "type": "string", + "default": "", + "description": "Editor monospace font family. Used where a fixed width font is needed to lay out text legibly (e.g. tables, checkboxes, code). If not found, a generic monospace (fixed width) font is used." + }, + "ui.layout": { + "type": "object", + "default": {}, + "$comment": "private" + }, + "autoUpdateEnabled": { + "type": "boolean", + "default": true, + "description": "Automatically update the application" + }, + "autoUpdate.includePreReleases": { + "type": "boolean", + "default": false, + "description": "Get pre-releases when checking for updates. See the pre-release page for more details: https://joplinapp.org/prereleases" + }, + "clipperServer.autoStart": { + "type": "boolean", + "default": false, + "$comment": "private" + }, + "sync.interval": { + "type": "integer", + "default": 300, + "description": "Synchronisation interval", + "enum": [ + 0, + 300, + 600, + 1800, + 3600, + 43200, + 86400 + ] + }, + "sync.mobileWifiOnly": { + "type": "boolean", + "default": false, + "description": "Synchronise only over WiFi connection" + }, + "noteVisiblePanes": { + "type": "array", + "default": [ + "editor", + "viewer" + ], + "$comment": "private" + }, + "tagHeaderIsExpanded": { + "type": "boolean", + "default": true, + "$comment": "private" + }, + "folderHeaderIsExpanded": { + "type": "boolean", + "default": true, + "$comment": "private" + }, + "editor": { + "type": "string", + "default": "", + "description": "Text editor command. The editor command (may include arguments) that will be used to open a note. If none is provided it will try to auto-detect the default editor." + }, + "export.pdfPageSize": { + "type": "string", + "default": "A4", + "description": "Page size for PDF export", + "enum": [ + "A4", + "Letter", + "A3", + "A5", + "Tabloid", + "Legal" + ] + }, + "export.pdfPageOrientation": { + "type": "string", + "default": "portrait", + "description": "Page orientation for PDF export", + "enum": [ + "portrait", + "landscape" + ] + }, + "editor.keyboardMode": { + "type": "string", + "default": "", + "description": "Keyboard Mode", + "enum": [ + "", + "emacs", + "vim" + ] + }, + "editor.spellcheckBeta": { + "type": "boolean", + "default": false, + "description": "Enable spell checking in Markdown editor? (WARNING BETA feature). Spell checker in the Markdown editor was previously unstable (cursor location was not stable, sometimes edits would not be saved or reflected in the viewer, etc.) however it appears to be more reliable now. If you notice any issue, please report it on GitHub or the Joplin Forum (Help -> Joplin Forum)", + "$comment": "private" + }, + "net.customCertificates": { + "type": "string", + "default": "", + "description": "Custom TLS certificates. Comma-separated list of paths to directories to load the certificates from, or path to individual cert files. For example: /my/cert_dir, /other/custom.pem. Note that if you make changes to the TLS settings, you must save your changes before clicking on \"Check synchronisation configuration\"." + }, + "net.ignoreTlsErrors": { + "type": "boolean", + "default": false, + "description": "Ignore TLS certificate errors" + }, + "sync.wipeOutFailSafe": { + "type": "boolean", + "default": true, + "description": "Fail-safe. Fail-safe: Do not wipe out local data when sync target is empty (often the result of a misconfiguration or bug)" + }, + "api.token": { + "type": "string", + "default": null, + "$comment": "private" + }, + "api.port": { + "type": "integer", + "default": null, + "description": "Specify the port that should be used by the API server. If not set, a default will be used." + }, + "resourceService.lastProcessedChangeId": { + "type": "integer", + "default": 0, + "$comment": "private" + }, + "searchEngine.lastProcessedChangeId": { + "type": "integer", + "default": 0, + "$comment": "private" + }, + "revisionService.lastProcessedChangeId": { + "type": "integer", + "default": 0, + "$comment": "private" + }, + "searchEngine.initialIndexingDone": { + "type": "boolean", + "default": false, + "$comment": "private" + }, + "revisionService.enabled": { + "type": "boolean", + "default": true, + "description": "Enable note history" + }, + "revisionService.ttlDays": { + "type": "integer", + "default": 90, + "description": "Keep note history for", + "minimum": 1, + "maximum": 730 + }, + "revisionService.intervalBetweenRevisions": { + "type": "integer", + "default": 600000, + "$comment": "private" + }, + "revisionService.oldNoteInterval": { + "type": "integer", + "default": 604800000, + "$comment": "private" + }, + "welcome.wasBuilt": { + "type": "boolean", + "default": false, + "$comment": "private" + }, + "welcome.enabled": { + "type": "boolean", + "default": true, + "$comment": "private" + }, + "camera.type": { + "type": "integer", + "default": 0, + "$comment": "private" + }, + "camera.ratio": { + "type": "string", + "default": "4:3", + "$comment": "private" + }, + "spellChecker.enabled": { + "type": "boolean", + "default": true, + "$comment": "private" + }, + "spellChecker.language": { + "type": "string", + "default": "", + "$comment": "private" + }, + "windowContentZoomFactor": { + "type": "integer", + "default": 100, + "minimum": 30, + "maximum": 300, + "$comment": "private" + }, + "layout.folderList.factor": { + "type": "integer", + "default": 1, + "description": "Notebook list growth factor. The factor property sets how the item will grow or shrink to fit the available space in its container with respect to the other items. Thus an item with a factor of 2 will take twice as much space as an item with a factor of 1.Restart app to see changes." + }, + "layout.noteList.factor": { + "type": "integer", + "default": 1, + "description": "Note list growth factor. The factor property sets how the item will grow or shrink to fit the available space in its container with respect to the other items. Thus an item with a factor of 2 will take twice as much space as an item with a factor of 1.Restart app to see changes." + }, + "layout.note.factor": { + "type": "integer", + "default": 2, + "description": "Note area growth factor. The factor property sets how the item will grow or shrink to fit the available space in its container with respect to the other items. Thus an item with a factor of 2 will take twice as much space as an item with a factor of 1.Restart app to see changes." + }, + "isSafeMode": { + "type": "boolean", + "default": false, + "$comment": "private" + } + } +} \ No newline at end of file diff --git a/docs/stats/index.html b/docs/stats/index.html index b55f5670b3..5b44bd1d55 100644 --- a/docs/stats/index.html +++ b/docs/stats/index.html @@ -307,15 +307,15 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md Total Windows downloads -1,499,952 +1,502,694 Total macOs downloads -583,536 +584,828 Total Linux downloads -494,658 +495,460 Windows % @@ -347,66 +347,66 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v2.1.8 2021-07-03T08:25:16Z -1,931 -873 -424 -3,228 +4,574 +2,148 +1,217 +7,939 v2.1.7 2021-06-26T19:48:55Z -13,093 -6,289 -3,547 -22,929 +13,119 +6,301 +3,552 +22,972 v2.1.5 (p) 2021-06-23T15:08:52Z -883 +884 213 159 -1,255 +1,256 v2.1.3 (p) 2021-06-19T16:32:51Z -1,039 -274 +1,040 +275 179 -1,492 +1,494 v2.0.11 2021-06-16T17:55:49Z -22,261 -9,174 +22,270 +9,175 9,694 -41,129 +41,139 v2.0.10 2021-06-16T07:58:29Z -1,921 +1,922 896 333 -3,150 +3,151 v2.0.9 (p) 2021-06-12T09:30:30Z -992 +993 273 854 -2,119 +2,120 v2.0.8 (p) 2021-06-10T16:15:08Z -644 +645 207 543 -1,394 +1,395 v2.0.4 (p) @@ -419,10 +419,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v2.0.2 (p) 2021-05-21T18:07:48Z -2,123 +2,124 473 1,643 -4,239 +4,240 v2.0.1 (p) @@ -435,58 +435,58 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.8.5 2021-05-10T11:58:14Z -36,898 -16,176 +36,901 +16,177 19,312 -72,386 +72,390 v1.8.4 (p) 2021-05-09T18:05:05Z -697 +698 122 435 -1,254 +1,255 v1.8.3 (p) 2021-05-04T10:38:16Z -1,366 +1,367 295 914 -2,575 +2,576 v1.8.2 (p) 2021-04-25T10:50:51Z -1,542 +1,544 422 1,264 -3,228 +3,230 v1.8.1 (p) 2021-03-29T10:46:41Z -3,071 +3,072 807 2,423 -6,301 +6,302 v1.7.11 2021-02-03T12:50:01Z -114,194 -42,594 +114,201 +42,595 64,116 -220,904 +220,912 v1.7.10 2021-01-30T13:25:29Z -13,843 +13,845 4,834 4,433 -23,110 +23,112 v1.7.9 (p) @@ -523,10 +523,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.6.8 2021-01-20T18:11:34Z -18,264 +18,270 7,671 7,582 -33,517 +33,523 v1.7.3 (p) @@ -539,10 +539,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.6.7 2021-01-11T23:20:33Z -10,496 +10,498 4,619 4,534 -19,649 +19,651 v1.6.6 @@ -555,10 +555,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.6.5 (p) 2021-01-09T01:24:32Z -642 +644 58 301 -1,001 +1,003 v1.6.4 (p) @@ -579,10 +579,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.5.14 2020-12-30T01:48:46Z -10,967 +10,969 5,194 5,513 -21,674 +21,676 v1.6.1 (p) @@ -659,10 +659,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.4.19 2020-12-01T11:11:16Z -25,614 +25,618 13,380 11,622 -50,616 +50,620 v1.4.18 @@ -699,10 +699,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.4.11 (p) 2020-11-19T23:06:51Z -1,042 +1,044 148 575 -1,765 +1,767 v1.4.10 (p) @@ -731,10 +731,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.3.18 2020-11-06T12:07:02Z -30,814 +30,816 11,320 10,498 -52,632 +52,634 v1.3.17 (p) @@ -835,10 +835,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.2.6 2020-10-09T13:56:59Z -44,357 +44,359 17,716 14,027 -76,100 +76,102 v1.2.4 (p) @@ -867,10 +867,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.1.4 2020-09-21T11:20:09Z -27,655 +27,657 13,490 7,740 -48,885 +48,887 v1.1.3 (p) @@ -915,10 +915,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.0.241 2020-09-04T18:06:00Z -23,756 +23,759 5,757 4,996 -34,509 +34,512 v1.0.239 (p) @@ -963,10 +963,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.0.233 2020-08-01T14:51:15Z -43,294 +43,300 18,189 12,358 -73,841 +73,847 v1.0.232 (p) @@ -979,10 +979,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.0.227 2020-07-07T20:44:54Z -40,490 +40,494 15,275 9,630 -65,395 +65,399 v1.0.226 (p) @@ -1043,10 +1043,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.0.216 2020-05-24T14:21:01Z -37,403 +37,405 14,276 10,180 -61,859 +61,861 v1.0.214 (p) @@ -1091,10 +1091,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.0.201 2020-04-15T22:55:13Z -53,441 +53,442 20,043 18,180 -91,664 +91,665 v1.0.200 @@ -1117,8 +1117,8 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md 2020-03-30T17:21:22Z 22,305 9,545 -5,745 -37,595 +5,746 +37,596 v1.0.195 @@ -1180,9 +1180,9 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.0.179 2020-01-24T22:42:41Z 71,092 -28,558 +28,559 22,537 -122,187 +122,188 v1.0.178 @@ -1211,10 +1211,10 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md v1.0.175 2019-12-08T11:48:47Z -72,558 +72,559 16,908 16,509 -105,975 +105,976 v1.0.174 @@ -1301,8 +1301,8 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md 2019-06-08T00:00:19Z 5,194 2,178 -1,113 -8,485 +1,114 +8,486 v1.0.158 @@ -1389,8 +1389,8 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md 2019-03-10T20:59:58Z 13,629 4,171 -3,229 -21,029 +3,230 +21,030 v1.0.139 (p) @@ -1965,8 +1965,8 @@ https://github.com/laurent22/joplin/blob/dev/readme/stats.md 2017-11-24T14:27:49Z 150 696 -6,466 -7,312 +6,467 +7,313 v0.10.23 diff --git a/readme/stats.md b/readme/stats.md index 7f8886fdc7..2b6b93c4ef 100644 --- a/readme/stats.md +++ b/readme/stats.md @@ -2,9 +2,9 @@ | Name | Value | | ----- | ----- | -| Total Windows downloads | 1,499,952 | -| Total macOs downloads | 583,536 | -| Total Linux downloads | 494,658 | +| Total Windows downloads | 1,502,694 | +| Total macOs downloads | 584,828 | +| Total Linux downloads | 495,460 | | Windows % | 58% | | macOS % | 23% | | Linux % | 19% | @@ -17,36 +17,36 @@ | Version | Date | Windows | macOS | Linux | Total | | ----- | ----- | ----- | ----- | ----- | ----- | -| [v2.1.8](https://github.com/laurent22/joplin/releases/tag/v2.1.8) | 2021-07-03T08:25:16Z | 1,931 | 873 | 424 | 3,228 | -| [v2.1.7](https://github.com/laurent22/joplin/releases/tag/v2.1.7) | 2021-06-26T19:48:55Z | 13,093 | 6,289 | 3,547 | 22,929 | -| [v2.1.5](https://github.com/laurent22/joplin/releases/tag/v2.1.5) (p) | 2021-06-23T15:08:52Z | 883 | 213 | 159 | 1,255 | -| [v2.1.3](https://github.com/laurent22/joplin/releases/tag/v2.1.3) (p) | 2021-06-19T16:32:51Z | 1,039 | 274 | 179 | 1,492 | -| [v2.0.11](https://github.com/laurent22/joplin/releases/tag/v2.0.11) | 2021-06-16T17:55:49Z | 22,261 | 9,174 | 9,694 | 41,129 | -| [v2.0.10](https://github.com/laurent22/joplin/releases/tag/v2.0.10) | 2021-06-16T07:58:29Z | 1,921 | 896 | 333 | 3,150 | -| [v2.0.9](https://github.com/laurent22/joplin/releases/tag/v2.0.9) (p) | 2021-06-12T09:30:30Z | 992 | 273 | 854 | 2,119 | -| [v2.0.8](https://github.com/laurent22/joplin/releases/tag/v2.0.8) (p) | 2021-06-10T16:15:08Z | 644 | 207 | 543 | 1,394 | +| [v2.1.8](https://github.com/laurent22/joplin/releases/tag/v2.1.8) | 2021-07-03T08:25:16Z | 4,574 | 2,148 | 1,217 | 7,939 | +| [v2.1.7](https://github.com/laurent22/joplin/releases/tag/v2.1.7) | 2021-06-26T19:48:55Z | 13,119 | 6,301 | 3,552 | 22,972 | +| [v2.1.5](https://github.com/laurent22/joplin/releases/tag/v2.1.5) (p) | 2021-06-23T15:08:52Z | 884 | 213 | 159 | 1,256 | +| [v2.1.3](https://github.com/laurent22/joplin/releases/tag/v2.1.3) (p) | 2021-06-19T16:32:51Z | 1,040 | 275 | 179 | 1,494 | +| [v2.0.11](https://github.com/laurent22/joplin/releases/tag/v2.0.11) | 2021-06-16T17:55:49Z | 22,270 | 9,175 | 9,694 | 41,139 | +| [v2.0.10](https://github.com/laurent22/joplin/releases/tag/v2.0.10) | 2021-06-16T07:58:29Z | 1,922 | 896 | 333 | 3,151 | +| [v2.0.9](https://github.com/laurent22/joplin/releases/tag/v2.0.9) (p) | 2021-06-12T09:30:30Z | 993 | 273 | 854 | 2,120 | +| [v2.0.8](https://github.com/laurent22/joplin/releases/tag/v2.0.8) (p) | 2021-06-10T16:15:08Z | 645 | 207 | 543 | 1,395 | | [v2.0.4](https://github.com/laurent22/joplin/releases/tag/v2.0.4) (p) | 2021-06-02T12:54:17Z | 1,289 | 376 | 356 | 2,021 | -| [v2.0.2](https://github.com/laurent22/joplin/releases/tag/v2.0.2) (p) | 2021-05-21T18:07:48Z | 2,123 | 473 | 1,643 | 4,239 | +| [v2.0.2](https://github.com/laurent22/joplin/releases/tag/v2.0.2) (p) | 2021-05-21T18:07:48Z | 2,124 | 473 | 1,643 | 4,240 | | [v2.0.1](https://github.com/laurent22/joplin/releases/tag/v2.0.1) (p) | 2021-05-15T13:22:58Z | 792 | 248 | 998 | 2,038 | -| [v1.8.5](https://github.com/laurent22/joplin/releases/tag/v1.8.5) | 2021-05-10T11:58:14Z | 36,898 | 16,176 | 19,312 | 72,386 | -| [v1.8.4](https://github.com/laurent22/joplin/releases/tag/v1.8.4) (p) | 2021-05-09T18:05:05Z | 697 | 122 | 435 | 1,254 | -| [v1.8.3](https://github.com/laurent22/joplin/releases/tag/v1.8.3) (p) | 2021-05-04T10:38:16Z | 1,366 | 295 | 914 | 2,575 | -| [v1.8.2](https://github.com/laurent22/joplin/releases/tag/v1.8.2) (p) | 2021-04-25T10:50:51Z | 1,542 | 422 | 1,264 | 3,228 | -| [v1.8.1](https://github.com/laurent22/joplin/releases/tag/v1.8.1) (p) | 2021-03-29T10:46:41Z | 3,071 | 807 | 2,423 | 6,301 | -| [v1.7.11](https://github.com/laurent22/joplin/releases/tag/v1.7.11) | 2021-02-03T12:50:01Z | 114,194 | 42,594 | 64,116 | 220,904 | -| [v1.7.10](https://github.com/laurent22/joplin/releases/tag/v1.7.10) | 2021-01-30T13:25:29Z | 13,843 | 4,834 | 4,433 | 23,110 | +| [v1.8.5](https://github.com/laurent22/joplin/releases/tag/v1.8.5) | 2021-05-10T11:58:14Z | 36,901 | 16,177 | 19,312 | 72,390 | +| [v1.8.4](https://github.com/laurent22/joplin/releases/tag/v1.8.4) (p) | 2021-05-09T18:05:05Z | 698 | 122 | 435 | 1,255 | +| [v1.8.3](https://github.com/laurent22/joplin/releases/tag/v1.8.3) (p) | 2021-05-04T10:38:16Z | 1,367 | 295 | 914 | 2,576 | +| [v1.8.2](https://github.com/laurent22/joplin/releases/tag/v1.8.2) (p) | 2021-04-25T10:50:51Z | 1,544 | 422 | 1,264 | 3,230 | +| [v1.8.1](https://github.com/laurent22/joplin/releases/tag/v1.8.1) (p) | 2021-03-29T10:46:41Z | 3,072 | 807 | 2,423 | 6,302 | +| [v1.7.11](https://github.com/laurent22/joplin/releases/tag/v1.7.11) | 2021-02-03T12:50:01Z | 114,201 | 42,595 | 64,116 | 220,912 | +| [v1.7.10](https://github.com/laurent22/joplin/releases/tag/v1.7.10) | 2021-01-30T13:25:29Z | 13,845 | 4,834 | 4,433 | 23,112 | | [v1.7.9](https://github.com/laurent22/joplin/releases/tag/v1.7.9) (p) | 2021-01-28T09:50:21Z | 481 | 124 | 484 | 1,089 | | [v1.7.6](https://github.com/laurent22/joplin/releases/tag/v1.7.6) (p) | 2021-01-27T10:36:05Z | 284 | 83 | 278 | 645 | | [v1.7.5](https://github.com/laurent22/joplin/releases/tag/v1.7.5) (p) | 2021-01-26T09:53:05Z | 364 | 196 | 445 | 1,005 | | [v1.7.4](https://github.com/laurent22/joplin/releases/tag/v1.7.4) (p) | 2021-01-22T17:58:38Z | 673 | 196 | 614 | 1,483 | -| [v1.6.8](https://github.com/laurent22/joplin/releases/tag/v1.6.8) | 2021-01-20T18:11:34Z | 18,264 | 7,671 | 7,582 | 33,517 | +| [v1.6.8](https://github.com/laurent22/joplin/releases/tag/v1.6.8) | 2021-01-20T18:11:34Z | 18,270 | 7,671 | 7,582 | 33,523 | | [v1.7.3](https://github.com/laurent22/joplin/releases/tag/v1.7.3) (p) | 2021-01-20T11:23:50Z | 334 | 69 | 437 | 840 | -| [v1.6.7](https://github.com/laurent22/joplin/releases/tag/v1.6.7) | 2021-01-11T23:20:33Z | 10,496 | 4,619 | 4,534 | 19,649 | +| [v1.6.7](https://github.com/laurent22/joplin/releases/tag/v1.6.7) | 2021-01-11T23:20:33Z | 10,498 | 4,619 | 4,534 | 19,651 | | [v1.6.6](https://github.com/laurent22/joplin/releases/tag/v1.6.6) | 2021-01-09T16:15:31Z | 12,367 | 3,407 | 4,778 | 20,552 | -| [v1.6.5](https://github.com/laurent22/joplin/releases/tag/v1.6.5) (p) | 2021-01-09T01:24:32Z | 642 | 58 | 301 | 1,001 | +| [v1.6.5](https://github.com/laurent22/joplin/releases/tag/v1.6.5) (p) | 2021-01-09T01:24:32Z | 644 | 58 | 301 | 1,003 | | [v1.6.4](https://github.com/laurent22/joplin/releases/tag/v1.6.4) (p) | 2021-01-07T19:11:32Z | 381 | 73 | 198 | 652 | | [v1.6.2](https://github.com/laurent22/joplin/releases/tag/v1.6.2) (p) | 2021-01-04T22:34:55Z | 665 | 222 | 585 | 1,472 | -| [v1.5.14](https://github.com/laurent22/joplin/releases/tag/v1.5.14) | 2020-12-30T01:48:46Z | 10,967 | 5,194 | 5,513 | 21,674 | +| [v1.5.14](https://github.com/laurent22/joplin/releases/tag/v1.5.14) | 2020-12-30T01:48:46Z | 10,969 | 5,194 | 5,513 | 21,676 | | [v1.6.1](https://github.com/laurent22/joplin/releases/tag/v1.6.1) (p) | 2020-12-29T19:37:45Z | 162 | 33 | 157 | 352 | | [v1.5.13](https://github.com/laurent22/joplin/releases/tag/v1.5.13) | 2020-12-29T18:29:15Z | 609 | 213 | 191 | 1,013 | | [v1.5.12](https://github.com/laurent22/joplin/releases/tag/v1.5.12) | 2020-12-28T15:14:08Z | 2,389 | 1,763 | 912 | 5,064 | @@ -56,16 +56,16 @@ | [v1.5.8](https://github.com/laurent22/joplin/releases/tag/v1.5.8) (p) | 2020-12-20T09:45:19Z | 559 | 159 | 632 | 1,350 | | [v1.5.7](https://github.com/laurent22/joplin/releases/tag/v1.5.7) (p) | 2020-12-10T12:58:33Z | 880 | 249 | 983 | 2,112 | | [v1.5.4](https://github.com/laurent22/joplin/releases/tag/v1.5.4) (p) | 2020-12-05T12:07:49Z | 686 | 162 | 624 | 1,472 | -| [v1.4.19](https://github.com/laurent22/joplin/releases/tag/v1.4.19) | 2020-12-01T11:11:16Z | 25,614 | 13,380 | 11,622 | 50,616 | +| [v1.4.19](https://github.com/laurent22/joplin/releases/tag/v1.4.19) | 2020-12-01T11:11:16Z | 25,618 | 13,380 | 11,622 | 50,620 | | [v1.4.18](https://github.com/laurent22/joplin/releases/tag/v1.4.18) | 2020-11-28T12:21:41Z | 11,103 | 3,872 | 3,085 | 18,060 | | [v1.4.16](https://github.com/laurent22/joplin/releases/tag/v1.4.16) | 2020-11-27T19:40:16Z | 1,463 | 823 | 585 | 2,871 | | [v1.4.15](https://github.com/laurent22/joplin/releases/tag/v1.4.15) | 2020-11-27T13:25:43Z | 878 | 483 | 263 | 1,624 | | [v1.4.12](https://github.com/laurent22/joplin/releases/tag/v1.4.12) | 2020-11-23T18:58:07Z | 3,000 | 1,317 | 1,290 | 5,607 | -| [v1.4.11](https://github.com/laurent22/joplin/releases/tag/v1.4.11) (p) | 2020-11-19T23:06:51Z | 1,042 | 148 | 575 | 1,765 | +| [v1.4.11](https://github.com/laurent22/joplin/releases/tag/v1.4.11) (p) | 2020-11-19T23:06:51Z | 1,044 | 148 | 575 | 1,767 | | [v1.4.10](https://github.com/laurent22/joplin/releases/tag/v1.4.10) (p) | 2020-11-14T09:53:15Z | 614 | 187 | 677 | 1,478 | | [v1.4.9](https://github.com/laurent22/joplin/releases/tag/v1.4.9) (p) | 2020-11-11T14:23:17Z | 517 | 134 | 394 | 1,045 | | [v1.4.7](https://github.com/laurent22/joplin/releases/tag/v1.4.7) (p) | 2020-11-07T18:23:29Z | 511 | 167 | 507 | 1,185 | -| [v1.3.18](https://github.com/laurent22/joplin/releases/tag/v1.3.18) | 2020-11-06T12:07:02Z | 30,814 | 11,320 | 10,498 | 52,632 | +| [v1.3.18](https://github.com/laurent22/joplin/releases/tag/v1.3.18) | 2020-11-06T12:07:02Z | 30,816 | 11,320 | 10,498 | 52,634 | | [v1.3.17](https://github.com/laurent22/joplin/releases/tag/v1.3.17) (p) | 2020-11-06T11:35:15Z | 44 | 17 | 16 | 77 | | [v1.4.6](https://github.com/laurent22/joplin/releases/tag/v1.4.6) (p) | 2020-11-05T22:44:12Z | 356 | 87 | 46 | 489 | | [v1.3.15](https://github.com/laurent22/joplin/releases/tag/v1.3.15) | 2020-11-04T12:22:50Z | 2,239 | 1,291 | 837 | 4,367 | @@ -78,25 +78,25 @@ | [v1.3.3](https://github.com/laurent22/joplin/releases/tag/v1.3.3) (p) | 2020-10-17T10:56:57Z | 113 | 39 | 26 | 178 | | [v1.3.2](https://github.com/laurent22/joplin/releases/tag/v1.3.2) (p) | 2020-10-11T20:39:49Z | 659 | 174 | 557 | 1,390 | | [v1.3.1](https://github.com/laurent22/joplin/releases/tag/v1.3.1) (p) | 2020-10-11T15:10:18Z | 77 | 46 | 36 | 159 | -| [v1.2.6](https://github.com/laurent22/joplin/releases/tag/v1.2.6) | 2020-10-09T13:56:59Z | 44,357 | 17,716 | 14,027 | 76,100 | +| [v1.2.6](https://github.com/laurent22/joplin/releases/tag/v1.2.6) | 2020-10-09T13:56:59Z | 44,359 | 17,716 | 14,027 | 76,102 | | [v1.2.4](https://github.com/laurent22/joplin/releases/tag/v1.2.4) (p) | 2020-09-30T07:34:29Z | 808 | 240 | 791 | 1,839 | | [v1.2.3](https://github.com/laurent22/joplin/releases/tag/v1.2.3) (p) | 2020-09-29T15:13:02Z | 212 | 61 | 72 | 345 | | [v1.2.2](https://github.com/laurent22/joplin/releases/tag/v1.2.2) (p) | 2020-09-22T20:31:55Z | 794 | 199 | 631 | 1,624 | -| [v1.1.4](https://github.com/laurent22/joplin/releases/tag/v1.1.4) | 2020-09-21T11:20:09Z | 27,655 | 13,490 | 7,740 | 48,885 | +| [v1.1.4](https://github.com/laurent22/joplin/releases/tag/v1.1.4) | 2020-09-21T11:20:09Z | 27,657 | 13,490 | 7,740 | 48,887 | | [v1.1.3](https://github.com/laurent22/joplin/releases/tag/v1.1.3) (p) | 2020-09-17T10:30:37Z | 557 | 147 | 457 | 1,161 | | [v1.1.2](https://github.com/laurent22/joplin/releases/tag/v1.1.2) (p) | 2020-09-15T12:58:38Z | 372 | 112 | 244 | 728 | | [v1.1.1](https://github.com/laurent22/joplin/releases/tag/v1.1.1) (p) | 2020-09-11T23:32:47Z | 521 | 195 | 342 | 1,058 | | [v1.0.245](https://github.com/laurent22/joplin/releases/tag/v1.0.245) | 2020-09-09T12:56:10Z | 21,251 | 9,999 | 5,634 | 36,884 | | [v1.0.242](https://github.com/laurent22/joplin/releases/tag/v1.0.242) | 2020-09-04T22:00:34Z | 12,479 | 6,418 | 3,015 | 21,912 | -| [v1.0.241](https://github.com/laurent22/joplin/releases/tag/v1.0.241) | 2020-09-04T18:06:00Z | 23,756 | 5,757 | 4,996 | 34,509 | +| [v1.0.241](https://github.com/laurent22/joplin/releases/tag/v1.0.241) | 2020-09-04T18:06:00Z | 23,759 | 5,757 | 4,996 | 34,512 | | [v1.0.239](https://github.com/laurent22/joplin/releases/tag/v1.0.239) (p) | 2020-09-01T21:56:36Z | 617 | 226 | 400 | 1,243 | | [v1.0.237](https://github.com/laurent22/joplin/releases/tag/v1.0.237) (p) | 2020-08-29T15:38:04Z | 588 | 923 | 338 | 1,849 | | [v1.0.236](https://github.com/laurent22/joplin/releases/tag/v1.0.236) (p) | 2020-08-28T09:16:54Z | 315 | 110 | 104 | 529 | | [v1.0.235](https://github.com/laurent22/joplin/releases/tag/v1.0.235) (p) | 2020-08-18T22:08:01Z | 1,689 | 489 | 920 | 3,098 | | [v1.0.234](https://github.com/laurent22/joplin/releases/tag/v1.0.234) (p) | 2020-08-17T23:13:02Z | 538 | 125 | 100 | 763 | -| [v1.0.233](https://github.com/laurent22/joplin/releases/tag/v1.0.233) | 2020-08-01T14:51:15Z | 43,294 | 18,189 | 12,358 | 73,841 | +| [v1.0.233](https://github.com/laurent22/joplin/releases/tag/v1.0.233) | 2020-08-01T14:51:15Z | 43,300 | 18,189 | 12,358 | 73,847 | | [v1.0.232](https://github.com/laurent22/joplin/releases/tag/v1.0.232) (p) | 2020-07-28T22:34:40Z | 653 | 222 | 178 | 1,053 | -| [v1.0.227](https://github.com/laurent22/joplin/releases/tag/v1.0.227) | 2020-07-07T20:44:54Z | 40,490 | 15,275 | 9,630 | 65,395 | +| [v1.0.227](https://github.com/laurent22/joplin/releases/tag/v1.0.227) | 2020-07-07T20:44:54Z | 40,494 | 15,275 | 9,630 | 65,399 | | [v1.0.226](https://github.com/laurent22/joplin/releases/tag/v1.0.226) (p) | 2020-07-04T10:21:26Z | 4,905 | 2,252 | 688 | 7,845 | | [v1.0.224](https://github.com/laurent22/joplin/releases/tag/v1.0.224) | 2020-06-20T22:26:08Z | 24,788 | 11,005 | 6,006 | 41,799 | | [v1.0.223](https://github.com/laurent22/joplin/releases/tag/v1.0.223) (p) | 2020-06-20T11:51:27Z | 186 | 112 | 78 | 376 | @@ -104,16 +104,16 @@ | [v1.0.220](https://github.com/laurent22/joplin/releases/tag/v1.0.220) | 2020-06-13T18:26:22Z | 31,808 | 9,916 | 6,411 | 48,135 | | [v1.0.218](https://github.com/laurent22/joplin/releases/tag/v1.0.218) | 2020-06-07T10:43:34Z | 14,536 | 6,968 | 2,954 | 24,458 | | [v1.0.217](https://github.com/laurent22/joplin/releases/tag/v1.0.217) (p) | 2020-06-06T15:17:27Z | 226 | 93 | 54 | 373 | -| [v1.0.216](https://github.com/laurent22/joplin/releases/tag/v1.0.216) | 2020-05-24T14:21:01Z | 37,403 | 14,276 | 10,180 | 61,859 | +| [v1.0.216](https://github.com/laurent22/joplin/releases/tag/v1.0.216) | 2020-05-24T14:21:01Z | 37,405 | 14,276 | 10,180 | 61,861 | | [v1.0.214](https://github.com/laurent22/joplin/releases/tag/v1.0.214) (p) | 2020-05-21T17:15:15Z | 6,550 | 3,468 | 762 | 10,780 | | [v1.0.212](https://github.com/laurent22/joplin/releases/tag/v1.0.212) (p) | 2020-05-21T07:48:39Z | 212 | 67 | 47 | 326 | | [v1.0.211](https://github.com/laurent22/joplin/releases/tag/v1.0.211) (p) | 2020-05-20T08:59:16Z | 300 | 132 | 87 | 519 | | [v1.0.209](https://github.com/laurent22/joplin/releases/tag/v1.0.209) (p) | 2020-05-17T18:32:51Z | 1,393 | 851 | 147 | 2,391 | | [v1.0.207](https://github.com/laurent22/joplin/releases/tag/v1.0.207) (p) | 2020-05-10T16:37:35Z | 1,188 | 263 | 1,016 | 2,467 | -| [v1.0.201](https://github.com/laurent22/joplin/releases/tag/v1.0.201) | 2020-04-15T22:55:13Z | 53,441 | 20,043 | 18,180 | 91,664 | +| [v1.0.201](https://github.com/laurent22/joplin/releases/tag/v1.0.201) | 2020-04-15T22:55:13Z | 53,442 | 20,043 | 18,180 | 91,665 | | [v1.0.200](https://github.com/laurent22/joplin/releases/tag/v1.0.200) | 2020-04-12T12:17:46Z | 9,552 | 4,892 | 1,903 | 16,347 | | [v1.0.199](https://github.com/laurent22/joplin/releases/tag/v1.0.199) | 2020-04-10T18:41:58Z | 19,366 | 5,884 | 3,788 | 29,038 | -| [v1.0.197](https://github.com/laurent22/joplin/releases/tag/v1.0.197) | 2020-03-30T17:21:22Z | 22,305 | 9,545 | 5,745 | 37,595 | +| [v1.0.197](https://github.com/laurent22/joplin/releases/tag/v1.0.197) | 2020-03-30T17:21:22Z | 22,305 | 9,545 | 5,746 | 37,596 | | [v1.0.195](https://github.com/laurent22/joplin/releases/tag/v1.0.195) | 2020-03-22T19:56:12Z | 18,916 | 7,949 | 4,506 | 31,371 | | [v1.0.194](https://github.com/laurent22/joplin/releases/tag/v1.0.194) (p) | 2020-03-14T00:00:32Z | 1,285 | 1,377 | 513 | 3,175 | | [v1.0.193](https://github.com/laurent22/joplin/releases/tag/v1.0.193) | 2020-03-08T08:58:53Z | 28,644 | 10,907 | 7,395 | 46,946 | @@ -121,11 +121,11 @@ | [v1.0.190](https://github.com/laurent22/joplin/releases/tag/v1.0.190) (p) | 2020-03-06T01:22:22Z | 374 | 90 | 85 | 549 | | [v1.0.189](https://github.com/laurent22/joplin/releases/tag/v1.0.189) (p) | 2020-03-04T17:27:15Z | 343 | 96 | 90 | 529 | | [v1.0.187](https://github.com/laurent22/joplin/releases/tag/v1.0.187) (p) | 2020-03-01T12:31:06Z | 920 | 230 | 263 | 1,413 | -| [v1.0.179](https://github.com/laurent22/joplin/releases/tag/v1.0.179) | 2020-01-24T22:42:41Z | 71,092 | 28,558 | 22,537 | 122,187 | +| [v1.0.179](https://github.com/laurent22/joplin/releases/tag/v1.0.179) | 2020-01-24T22:42:41Z | 71,092 | 28,559 | 22,537 | 122,188 | | [v1.0.178](https://github.com/laurent22/joplin/releases/tag/v1.0.178) | 2020-01-20T19:06:45Z | 17,557 | 5,962 | 2,585 | 26,104 | | [v1.0.177](https://github.com/laurent22/joplin/releases/tag/v1.0.177) (p) | 2019-12-30T14:40:40Z | 1,944 | 438 | 682 | 3,064 | | [v1.0.176](https://github.com/laurent22/joplin/releases/tag/v1.0.176) (p) | 2019-12-14T10:36:44Z | 3,124 | 2,534 | 467 | 6,125 | -| [v1.0.175](https://github.com/laurent22/joplin/releases/tag/v1.0.175) | 2019-12-08T11:48:47Z | 72,558 | 16,908 | 16,509 | 105,975 | +| [v1.0.175](https://github.com/laurent22/joplin/releases/tag/v1.0.175) | 2019-12-08T11:48:47Z | 72,559 | 16,908 | 16,509 | 105,976 | | [v1.0.174](https://github.com/laurent22/joplin/releases/tag/v1.0.174) | 2019-11-12T18:20:58Z | 30,414 | 11,725 | 8,221 | 50,360 | | [v1.0.173](https://github.com/laurent22/joplin/releases/tag/v1.0.173) | 2019-11-11T08:33:35Z | 5,077 | 2,079 | 746 | 7,902 | | [v1.0.170](https://github.com/laurent22/joplin/releases/tag/v1.0.170) | 2019-10-13T22:13:04Z | 27,454 | 8,754 | 7,675 | 43,883 | @@ -136,7 +136,7 @@ | [v1.0.165](https://github.com/laurent22/joplin/releases/tag/v1.0.165) | 2019-08-14T21:46:29Z | 18,912 | 6,972 | 5,462 | 31,346 | | [v1.0.161](https://github.com/laurent22/joplin/releases/tag/v1.0.161) | 2019-07-13T18:30:00Z | 19,287 | 6,352 | 4,136 | 29,775 | | [v1.0.160](https://github.com/laurent22/joplin/releases/tag/v1.0.160) | 2019-06-15T00:21:40Z | 30,545 | 7,746 | 8,101 | 46,392 | -| [v1.0.159](https://github.com/laurent22/joplin/releases/tag/v1.0.159) | 2019-06-08T00:00:19Z | 5,194 | 2,178 | 1,113 | 8,485 | +| [v1.0.159](https://github.com/laurent22/joplin/releases/tag/v1.0.159) | 2019-06-08T00:00:19Z | 5,194 | 2,178 | 1,114 | 8,486 | | [v1.0.158](https://github.com/laurent22/joplin/releases/tag/v1.0.158) | 2019-05-27T19:01:18Z | 9,815 | 3,538 | 1,936 | 15,289 | | [v1.0.157](https://github.com/laurent22/joplin/releases/tag/v1.0.157) | 2019-05-26T17:55:53Z | 2,179 | 844 | 291 | 3,314 | | [v1.0.153](https://github.com/laurent22/joplin/releases/tag/v1.0.153) (p) | 2019-05-15T06:27:29Z | 850 | 102 | 106 | 1,058 | @@ -147,7 +147,7 @@ | [v1.0.145](https://github.com/laurent22/joplin/releases/tag/v1.0.145) | 2019-05-03T09:16:53Z | 7,008 | 2,861 | 1,437 | 11,306 | | [v1.0.143](https://github.com/laurent22/joplin/releases/tag/v1.0.143) | 2019-04-22T10:51:38Z | 11,918 | 3,550 | 2,779 | 18,247 | | [v1.0.142](https://github.com/laurent22/joplin/releases/tag/v1.0.142) | 2019-04-02T16:44:51Z | 14,665 | 4,565 | 4,727 | 23,957 | -| [v1.0.140](https://github.com/laurent22/joplin/releases/tag/v1.0.140) | 2019-03-10T20:59:58Z | 13,629 | 4,171 | 3,229 | 21,029 | +| [v1.0.140](https://github.com/laurent22/joplin/releases/tag/v1.0.140) | 2019-03-10T20:59:58Z | 13,629 | 4,171 | 3,230 | 21,030 | | [v1.0.139](https://github.com/laurent22/joplin/releases/tag/v1.0.139) (p) | 2019-03-09T10:06:48Z | 123 | 63 | 46 | 232 | | [v1.0.138](https://github.com/laurent22/joplin/releases/tag/v1.0.138) (p) | 2019-03-03T17:23:00Z | 150 | 87 | 84 | 321 | | [v1.0.137](https://github.com/laurent22/joplin/releases/tag/v1.0.137) (p) | 2019-03-03T01:12:51Z | 591 | 58 | 83 | 732 | @@ -219,7 +219,7 @@ | [v0.10.30](https://github.com/laurent22/joplin/releases/tag/v0.10.30) | 2017-11-30T20:28:16Z | 724 | 1,369 | 420 | 2,513 | | [v0.10.28](https://github.com/laurent22/joplin/releases/tag/v0.10.28) | 2017-11-30T01:07:46Z | 1,342 | 1,701 | 874 | 3,917 | | [v0.10.26](https://github.com/laurent22/joplin/releases/tag/v0.10.26) | 2017-11-29T16:02:17Z | 188 | 701 | 261 | 1,150 | -| [v0.10.25](https://github.com/laurent22/joplin/releases/tag/v0.10.25) | 2017-11-24T14:27:49Z | 150 | 696 | 6,466 | 7,312 | +| [v0.10.25](https://github.com/laurent22/joplin/releases/tag/v0.10.25) | 2017-11-24T14:27:49Z | 150 | 696 | 6,467 | 7,313 | | [v0.10.23](https://github.com/laurent22/joplin/releases/tag/v0.10.23) | 2017-11-21T19:38:41Z | 134 | 647 | 28 | 809 | | [v0.10.22](https://github.com/laurent22/joplin/releases/tag/v0.10.22) | 2017-11-20T21:45:57Z | 86 | 645 | 19 | 750 | | [v0.10.21](https://github.com/laurent22/joplin/releases/tag/v0.10.21) | 2017-11-18T00:53:15Z | 53 | 638 | 13 | 704 |