feat: Add TextElementComponent #2694
Merged
Conversation
This file contains 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
luanpotter
force-pushed
the
luan.element-component
branch
4 times, most recently
from
97f0583
to
2839775
Compare
spydon
approved these changes
Aug 31, 2023
renancaraujo
approved these changes
Aug 31, 2023
6 tasks
luanpotter
added a commit
that referenced
this pull request
Sep 2, 2023
…docs (#2700) This occurred to me after a discussion on the [new FCS component PR](#2694 (comment)). As per usual, @spydon has opened my eyes to the ultimate truth: We should rename loads of files, and it shall affect almost no one. The idea is to (1) add a "Text" prefix to all text-rendering-related classes and (2) rename the existing `Text*` to `InlineText*` (which is what they are). This PR is a bit big, but the changes should hopefully be simple to review, and can be broken down into: * Add a proper base class for the node inheritance chain, call it TextNode (while working on Flame Markdown I realized the value this will have to me) * Rename the old TextNode to InlineTextNode * Rename DocumentNode to DocumentRoot because it is not a node * Rename Element to TextElement * Rename the old TextElement to InlineTextElement * Rename Style to FlameTextStyle (note: we could consider dropping the Flame here) * Rename the old FlameTextStyle to InlineTextStyle * Update the docs accordingly * Add some more diagrams and explanations to the docs, following the new nomenclature * I also updated our "internal" imports to use the text module to make life so much easier (this could arguably be done in a separate PR, but I honestly think it's easier to review together, please lmk if you prefer me to split). These are all breaking changes but likely won't actually affect most users (see below). While this is breaking, it should hopefully not affect most users, because these are all infrastructure classes that most people aren't using directly. If you are using the FCS components, or the renderers `TextPaint` or `SpriteFontRenderer` directly, this should have zero effect to you. If you are using the Nodes, Stlyes or Elements directly, or have a custom TextRenderer, see below. Migrating should be a simple matter of renaming your type references: * from TextNode to InlineTextNode * from TextElement to InlineTextElement * from Element to TextElement * from FlameTextStyle to InlineTextStyle * from Style to FlameTextStyle Make sure to do it in the appropriate order not to cause any double-replace issues. If you are importing via the module `package:flame/text.dart`, which we highly encourage, you should not have to change any import statements whatsoever.
luanpotter
changed the title
luanpotter
force-pushed
the
luan.element-component
branch
from
f36a9d8
to
64a01cb
Compare
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.
Description
Add
TextElementComponentExample:
Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?