diff options
Diffstat (limited to 'api/JoplinViewsNoteList.d.ts')
-rw-r--r-- | api/JoplinViewsNoteList.d.ts | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/api/JoplinViewsNoteList.d.ts b/api/JoplinViewsNoteList.d.ts new file mode 100644 index 0000000..6edf9b5 --- /dev/null +++ b/api/JoplinViewsNoteList.d.ts @@ -0,0 +1,42 @@ +import { Store } from 'redux'; +import Plugin from '../Plugin'; +import { ListRenderer } from './noteListType'; +/** + * This API allows you to customise how each note in the note list is rendered. + * The renderer you implement follows a unidirectional data flow. + * + * The app provides the required dependencies whenever a note is updated - you + * process these dependencies, and return some props, which are then passed to + * your template and rendered. See [[ListRenderer]] for a detailed description + * of each property of the renderer. + * + * ## Reference + * + * * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/note_list_renderer) + * + * * [Default simple renderer](https://github.com/laurent22/joplin/tree/dev/packages/lib/services/noteList/defaultListRenderer.ts) + * + * * [Default detailed renderer](https://github.com/laurent22/joplin/tree/dev/packages/lib/services/noteList/defaultMultiColumnsRenderer.ts) + * + * ## Screenshots: + * + * ### Top to bottom with title, date and body + * + * <img width="250px" src="https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/note_list/TopToBottom.png"/> + * + * ### Left to right with thumbnails + * + * <img width="250px" src="https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/note_list/LeftToRight_Thumbnails.png"/> + * + * ### Top to bottom with editable title + * + * <img width="250px" src="https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/note_list/TopToBottom_Editable.png"/> + * + * <span class="platform-desktop">desktop</span> + */ +export default class JoplinViewsNoteList { + private plugin_; + private store_; + constructor(plugin: Plugin, store: Store); + registerRenderer(renderer: ListRenderer): Promise<void>; +} |