feat(tree): adds a changed event on TreeBranchEvents#22977
Conversation
| * @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"}
| "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.
| 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 <78610362+noencke@users.noreply.github.com>
Co-authored-by: Noah Encke <78610362+noencke@users.noreply.github.com>
…work into changed-event
|
|
||
| // @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
left a comment
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 |
adds a new `changed` event to `TreeBranchEvents` that fires for both local and remote changes --------- Co-authored-by: Noah Encke <78610362+noencke@users.noreply.github.com>
adds a new
changedevent toTreeBranchEventsthat fires for both local and remote changes