@appsoftwareltd/etherpk-extension-api 0.18.4 → 0.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/dist/menus.d.ts +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -340,7 +340,8 @@ context.commands.register('hello.taskWords', (target) => {
|
|
|
340
340
|
|
|
341
341
|
`context.commandBar.register({ id, title, icon, command, pinned })` adds a button to the row of
|
|
342
342
|
buttons across the bottom of a phone's screen: after the editing buttons that scroll, or with
|
|
343
|
-
`pinned`, at the bar's right end, where it never scrolls away.
|
|
343
|
+
`pinned`, at the bar's right end, where it never scrolls away. With `documentOnly`, it is greyed
|
|
344
|
+
while a tab that shows a file, such as a PDF, is in front.
|
|
344
345
|
|
|
345
346
|
### Key chords
|
|
346
347
|
|
|
@@ -411,7 +412,7 @@ thumbnail.addEventListener('click', () => void context.assets.viewImages({ refs:
|
|
|
411
412
|
### Icons
|
|
412
413
|
|
|
413
414
|
`context.icons.svg(name)` draws one of the extension's own icons or one of the Client's, as markup the
|
|
414
|
-
Client trusts. The Client's icons, which every `icon` field may name too, are `alias`, `archive`, `backlinks`, `bold`, `bookmark`, `bullet`, `calendar`, `check`, `clock`, `close`, `code`, `copy`, `download`, `fit`, `flag`, `fold`, `frontmatter`, `globe`, `graph`, `grip`, `headless-client`, `highlight`, `image`, `import`, `indent`, `italic`, `list`, `lock`, `lock-open`, `more`, `move`, `move-down`, `move-up`, `new-page`, `open-external`, `outdent`, `page`, `pageless`, `pane-below`, `pane-right`, `pin`, `redo`, `rename`, `reset`, `search`, `slash`, `spell-check`, `table`, `table-add-column`, `table-add-row`, `table-format`, `table-remove-column`, `table-remove-row`, `task`, `task-reference`, `template`, `text-lines`, `today`, `todays-journal`, `tomorrow`, `trash`, `undo`, `view-larger`, `wikilink-close`, `wikilink-open`, `yesterday`, `zoom-in`, `zoom-out`. An
|
|
415
|
+
Client trusts. The Client's icons, which every `icon` field may name too, are `alias`, `archive`, `backlinks`, `bold`, `bookmark`, `bullet`, `calendar`, `check`, `clock`, `close`, `code`, `copy`, `download`, `fit`, `flag`, `fold`, `frontmatter`, `globe`, `graph`, `grip`, `headless-client`, `highlight`, `image`, `import`, `indent`, `italic`, `list`, `lock`, `lock-open`, `more`, `move`, `move-down`, `move-up`, `new-page`, `open-external`, `outdent`, `page`, `pdf`, `pdf-eraser`, `pdf-highlighter`, `pdf-note`, `pdf-page-next`, `pdf-page-previous`, `pdf-pen`, `pdf-print`, `pdf-signature`, `pageless`, `pane-below`, `pane-right`, `pin`, `redo`, `rename`, `reset`, `search`, `slash`, `spell-check`, `table`, `table-add-column`, `table-add-row`, `table-format`, `table-remove-column`, `table-remove-row`, `task`, `task-reference`, `template`, `text-lines`, `today`, `todays-journal`, `tomorrow`, `trash`, `undo`, `view-larger`, `wikilink-close`, `wikilink-open`, `yesterday`, `zoom-in`, `zoom-out`. An
|
|
415
416
|
icon may be added in a later release, never taken away. An unknown name draws a small dot.
|
|
416
417
|
|
|
417
418
|
### Settings sections
|
package/dist/menus.d.ts
CHANGED
|
@@ -187,6 +187,8 @@ export interface CommandBarButton {
|
|
|
187
187
|
* editing buttons that scroll. For an action a person reaches for often.
|
|
188
188
|
*/
|
|
189
189
|
pinned?: boolean;
|
|
190
|
+
/** Greyed while a tab that shows a file, such as a PDF, is in front, for a button that works on a document. */
|
|
191
|
+
documentOnly?: boolean;
|
|
190
192
|
/** The Command the button runs. */
|
|
191
193
|
command: string;
|
|
192
194
|
/** What the Command is given. */
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@appsoftwareltd/etherpk-extension-api",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.19.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "The API an EtherPK extension is written against: the context it is started with, its manifest, and the contract its Views follow.",
|
|
6
6
|
"type": "module",
|