Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor!: Make TextElement more usable on its own #2679

Merged
merged 3 commits into from
Aug 26, 2023
Merged

Conversation

luanpotter
Copy link
Member

@luanpotter luanpotter commented Aug 25, 2023

Description

This is part of my ongoing effort to simplify the text rendering pipeline.
My ultimate goal is to:

As a first step to break down that huge PR, this makes a small change to TextElements to make them more useful

This PR will:

rename render -> draw

draw becomes the "internal", underlying impl, raw method, that just draws the element w/ any custom options

add a new render method that takes in more options

this does not need to be extended by every impl.
this is for end users and accepts parameters like position and anchor to be more in line with the renderer interface

Checklist

  • I have followed the Contributor Guide when preparing my PR.
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • I have updated/added relevant examples in examples or docs.

Breaking Change?

  • Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

Migration instructions

This is technically a breaking change but should have no effect for users, unless you are creating your own custom TextElements. In that case, to migrate:

  • rename your render method to draw

@luanpotter luanpotter marked this pull request as ready for review August 25, 2023 16:13
Copy link
Member

@spydon spydon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm!

@luanpotter luanpotter merged commit 1a64443 into main Aug 26, 2023
@luanpotter luanpotter deleted the luan.text-2 branch August 26, 2023 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants