feat(tree): adds a changed event on TreeBranchEvents
#22977
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
github-actions
bot
added
area: dds
noencke
reviewed
Nov 5, 2024
| @@ -631,6 +643,9 @@ export interface TreeBranchEvents { | |||
| * @param data - information about the commit that was applied | |||
| * @param getRevertible - a function provided that allows users to get a revertible for the commit that was applied. If not provided, | |||
| * this commit is not revertible. | |||
| * | |||
| * @deprecated use the "changed" event instead which behaves the same way but also gets fired for more scenarios, see its doc comment | |||
There was a problem hiding this comment.
You can probably link here with {@link TreeBranchEvents.changed | "changed"}
noencke
reviewed
Nov 5, 2024
jzaffiro
reviewed
Nov 5, 2024
.changeset/stinky-cars-fart.md
Outdated
| "section": tree | ||
| --- | ||
|
|
||
| Added a new `changed` event to the (currently alpha) `TreeBranchEvents` that is meant to replace the `commitApplied` event on `TreeViewEvents`. |
There was a problem hiding this comment.
Suggested change
| Added a new `changed` event to the (currently alpha) `TreeBranchEvents` that is meant to replace the `commitApplied` event on `TreeViewEvents`. | |
| Adds a new `changed` event to the (currently alpha) `TreeBranchEvents` that replaces the `commitApplied` event on `TreeViewEvents`. |
| --- | ||
| "section": tree | ||
| --- | ||
|
|
There was a problem hiding this comment.
Can you add a concise description of the change? Examples can be found in #22965
Co-authored-by: Noah Encke <[email protected]>
Co-authored-by: Noah Encke <[email protected]>
noencke
approved these changes
Nov 5, 2024
| @@ -580,6 +580,7 @@ export class TreeViewConfiguration<const TSchema extends ImplicitFieldSchema = I | |||
|
|
|||
| // @public @sealed | |||
| export interface TreeViewEvents { | |||
| // @deprecated | |||
There was a problem hiding this comment.
Let's hold off on deprecating this for now. I'm not sure if we should deprecate something in the public API when the only alternative is an alpha API. Some users might not want to participate in alpha APIs, and we would be forcing them to choose between two evils.
If we change our mind, we can easily deprecate later, no harm done, and we will at the very latest deprecate when the other event becomes public.
msfluid-bot
reviewed
Nov 5, 2024
There was a problem hiding this comment.
Code Coverage Summary
↓ packages.dds.tree.src.core.rebase:
Line Coverage Change: No change Branch Coverage Change: -0.03%
| Metric Name | Baseline coverage | PR coverage | Coverage Diff |
|---|---|---|---|
| Branch Coverage | 96.99% | 96.96% | ↓ -0.03% |
| Line Coverage | 99.46% | 99.46% | → No change |
↑ packages.dds.tree.src.simple-tree.api:
Line Coverage Change: 0.04% Branch Coverage Change: 0.03%
| Metric Name | Baseline coverage | PR coverage | Coverage Diff |
|---|---|---|---|
| Branch Coverage | 87.85% | 87.88% | ↑ 0.03% |
| Line Coverage | 82.19% | 82.23% | ↑ 0.04% |
↑ packages.dds.tree.src.shared-tree:
Line Coverage Change: No change Branch Coverage Change: 0.08%
| Metric Name | Baseline coverage | PR coverage | Coverage Diff |
|---|---|---|---|
| Branch Coverage | 90.77% | 90.85% | ↑ 0.08% |
| Line Coverage | 97.23% | 97.23% | → No change |
Baseline commit: d7658b5
Baseline build: 304262
Happy Coding!!
Code coverage comparison check passed!!
⯅ @fluid-example/bundle-size-tests: +425 Bytes
Baseline commit: a475dc4 |
This was referenced Nov 5, 2024
Josmithr
pushed a commit
that referenced
this pull request
Nov 5, 2024
adds a new `changed` event to `TreeBranchEvents` that fires for both local and remote changes --------- Co-authored-by: Noah Encke <[email protected]>
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.
adds a new
changedevent toTreeBranchEventsthat fires for both local and remote changes