feat(superdoc): expose built-in loading UI toggle as ui.loading (IT-1365) - #3881
Open
caio-pizzol wants to merge 1 commit into
Open
Conversation
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require reviewTo customize comments, go to the Qodo configuration screen, or learn more in the docs. Previous review resultsReview updated until commit 19ead3a Results up to commit 081f67a
|
Integrators had no supported way to turn off SuperDoc's built-in loading UI. `editorOptions()` is an explicit allow-list, so the internal `showLoadingOverlay` option was unreachable from `Config`. Add a `ui` namespace for SuperDoc's own built-in UI, starting with `ui.loading` (default true), and forward it to the editor. It is presentation-only: it does not change document initialization, collaboration synchronization or load time, editing stays blocked until the editor is ready, and host-provided loading UI is unaffected. `ui` is deliberately separate from `modules`, which is for feature modules and is an explicit full-rebuild trigger in the React wrapper, and from the `superdoc/ui` controller entry point, which is for building a custom UI rather than configuring the built-in one. Documents the option on the vanilla and React configuration pages, including how it relates to React's `renderLoading`. Refs IT-1365 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
caio-pizzol
force-pushed
the
caio/it-1365-public-show-loading-overlay
branch
from
August 7, 2026 23:05
081f67a to
19ead3a
Compare
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
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.
Stack 2/2 — depends on #3880. Review/merge #3880 first.
Problem
Keyora (IT-1365) has no supported way to turn off SuperDoc's built-in loading UI.
editorOptions()inSuperDoc.vue:840is an explicit allow-list with no spread, so the internal option was unreachable fromConfig.This was the only remaining V1→V2 migration blocker Soumi identified.
Change
Presentation-only: it does not change document initialization, collaboration synchronization or load time. Editing stays blocked until the editor is ready (see #3880), and host-provided loading UI such as React's
renderLoadingis unaffected.Why a
uinamespacemodules, which is for feature modules and is an explicit full-rebuild trigger in the React wrapper.superdoc/uicontroller entry point: that is for building a custom UI, this configures the built-in one. A config property and a module specifier do not collide.Configboolean.Reaches
@superdoc-dev/reactautomatically and typed viaSuperDocEditorProps extends Omit<SuperDocConfig, ...>, ridingrestProps, which is excluded from the rebuild deps.Docs
Documented on both manually maintained config pages, including how
ui.loadingrelates to React'srenderLoading. Additive only (26 lines);.mdxis outside the repo's prettier glob, so no reformatting churn.Verification
SuperDoc.test.js: 101/101, incl. 3 new (omittedui;uiwithoutloading;ui.loading: false)pnpm check:public:superdoc: PASS, 14/14 stages@superdoc-dev/reacttsc --noEmit: cleancheck:imports,check:icons,test:examples(295): passTwo pre-existing repo conditions, not caused by this stack
packages/reactvitest fails 15/31 locally (Cannot find module .../superdoc/dist/superdoc.es.js). Reproduced identically on unmodifiedmainin a separate clean checkout, after a package rebuild and afterensure-superdoc-build.js.docs-check-em-dashesfails repo-wide (128 pre-existing onmain; 0 in these changes), so it blocks any docs commit. Skipped viaLEFTHOOK_EXCLUDEfor this commit only; every other hook ran and passed.Scope note
Loading lifecycle events are deliberately deferred. Soumi said exposing the variable is sufficient, and today's readiness signals do not describe a coherent loading lifecycle:
editorReadyflips immediately after async init starts without collaboration,lifecycleStateemits no change event, andreplaceFile()does not transition throughdocumentLoading. That needs its own state model.Refs IT-1365
🤖 Generated with Claude Code