Add docs for {base_,}style Decorators #92
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
dzhou121
reviewed
Aug 20, 2023
| /// # use floem::{peniko::Color, view::View, views::{Decorators, label, stack}}; | ||
| /// fn view() -> impl View { | ||
| /// label(|| "Hello".to_string()) | ||
| /// .style(|| Style::default().font_size(20.0).color(Color::RED)) |
There was a problem hiding this comment.
should be base_style here?
There was a problem hiding this comment.
That's intended to show how style behaves if you use it on a view that's returned, to give an illustration of what goes wrong.
(Though I could see that as potentially being confusing, so perhaps it should just be the note?)
There was a problem hiding this comment.
Ah got you.
Yeah maybe move "If you are returning from a function that produces a view, you may want to use base_style for the returned [View] instead. " under the code example.
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.
I kept putting this off due to wanting to write more documentation past them, but I decided to just PR these rather than wait until I got around to that.
This just adds some basic example documentation to
style/base_style