docs: add a tutorial and fix what the reference got wrong - #67
Merged
Merged
Conversation
A short tutorial builds a handler end to end: the view, the registration, the build entry, the PHP listener, and opening a file from your own code. The reference now lists every ViewerOptions entry with its real signature, the two optional props, the LoadViewer migration and the getters that have no equivalent, drops the section that repeated step 3, says when registerDefaultHandlers() is needed on older servers, and no longer calls the viewer an app. Assisted-by: ClaudeCode:claude-opus-5-5 Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
skjnldsv
added
status: review
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #67 +/- ##
=======================================
Coverage 88.78% 88.78%
=======================================
Files 39 39
Lines 2765 2765
Branches 569 569
=======================================
Hits 2455 2455
Misses 303 303
Partials 7 7 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A docs pass on the README, plus a small tutorial for people porting their first handler.
The tutorial builds a notes viewer end to end: the view, the registration, the Vite entry, the
BeforeTemplateRenderedEventlistener, and opening a file from your own code with a node fetched from WebDAV (the permissions lesson from nextcloud/assistant#670).Fixes in the reference, found while going through it against the code:
ViewerOptionslisted 6 of its 11 options, andonPrev/onNextwithout the file they getlocalSourceandturnswere missing from the propsOCA.Viewer.enableSidebartoisSidebarShown, which is the sidebar's state, not the option, and said nothing aboutonPrev,onNext,onClose,canLooporLoadViewerregisterDefaultHandlers()is also needed by apps that still run on 35It documents
mainas it is, #64 included, and nothing from #62, #65 or #66 yet. Not rendered on GitHub before opening, only the anchors are checked.👾 This pull request was assisted by Claude Code, commits carry an
Assisted-bytrailer.