docs(ui): fix floating default shown for UIBaseElement/UISpriteElement#1252
Merged
obiot merged 1 commit intomelonjs:masterfrom Mar 10, 2026
Merged
Conversation
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
2 participants
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.
Summary
Fixes docs mismatch where
UIBaseElement.floatingandUISpriteElement.floatingwere shown as inheriting Renderable's default (false) even though both UI classes set it totrueat runtime.This change declares
floating = trueas class fields (with JSDoc), so TypeDoc renders class-specific defaults instead of inherited defaults.Closes #1237
Validation
pnpm -F melonjs docfloating = trueon both pages:docs/classes/UIBaseElement.htmldocs/classes/UISpriteElement.html