-
Notifications
You must be signed in to change notification settings - Fork 425
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
Fire callbacks when targets are added or removed #367
Closed
Closed
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
11649d7
Fire callbacks when targets are added or removed
seanpdoyle 78c094b
attempt to fix CI
seanpdoyle 86720fc
Rename Added to Connected and Removed to Disconnected
seanpdoyle c182b82
ADd documentation to the Lifecycle Callbacks page
seanpdoyle 770b2fd
Incorporate code review feedback
seanpdoyle 21f2ca2
Touch up documentation
seanpdoyle e6e1d12
Add `Node.isConnected` to polyfills
seanpdoyle 1b6e95e
Attempt to address CI failure
seanpdoyle ef175d5
Be consistent in documentation
seanpdoyle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
import { Multimap } from "@stimulus/multimap" | ||
import { Token, TokenListObserver, TokenListObserverDelegate } from "@stimulus/mutation-observers" | ||
import { Context } from "./context" | ||
|
||
export interface TargetObserverDelegate { | ||
targetConnected(element: Element, name: string): void | ||
targetDisconnected(element: Element, name: string): void | ||
} | ||
|
||
export class TargetObserver implements TokenListObserverDelegate { | ||
readonly context: Context | ||
readonly delegate: TargetObserverDelegate | ||
readonly targetsByName: Multimap<string, Element> | ||
private tokenListObserver?: TokenListObserver | ||
|
||
constructor(context: Context, delegate: TargetObserverDelegate) { | ||
this.context = context | ||
this.delegate = delegate | ||
this.targetsByName = new Multimap | ||
} | ||
|
||
start() { | ||
if (!this.tokenListObserver) { | ||
this.tokenListObserver = new TokenListObserver(this.element, this.attributeName, this) | ||
this.tokenListObserver.start() | ||
} | ||
} | ||
|
||
stop() { | ||
if (this.tokenListObserver) { | ||
this.disconnectAllTargets() | ||
this.tokenListObserver.stop() | ||
delete this.tokenListObserver | ||
} | ||
} | ||
|
||
// Token list observer delegate | ||
|
||
tokenMatched({ element, content: name }: Token) { | ||
if (this.scope.containsElement(element)) { | ||
this.connectTarget(element, name) | ||
} | ||
} | ||
|
||
tokenUnmatched({ element, content: name }: Token) { | ||
this.disconnectTarget(element, name) | ||
} | ||
|
||
// Target management | ||
|
||
connectTarget(element: Element, name: string) { | ||
if (!this.targetsByName.has(name, element)) { | ||
this.targetsByName.add(name, element) | ||
this.delegate.targetConnected(element, name) | ||
} | ||
} | ||
|
||
disconnectTarget(element: Element, name: string) { | ||
if (this.targetsByName.has(name, element)) { | ||
this.targetsByName.delete(name, element) | ||
this.delegate.targetDisconnected(element, name) | ||
} | ||
} | ||
|
||
disconnectAllTargets() { | ||
for (const name of this.targetsByName.keys) { | ||
for (const element of this.targetsByName.getValuesForKey(name)) { | ||
this.disconnectTarget(element, name) | ||
} | ||
} | ||
} | ||
|
||
// Private | ||
|
||
private get attributeName() { | ||
return `data-${this.context.identifier}-target` | ||
} | ||
|
||
private get element() { | ||
return this.context.element | ||
} | ||
|
||
private get scope() { | ||
return this.context.scope | ||
} | ||
} |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sstephenson I now realize that the element will already be out of the DOM, so this contrived example doesn't really illustrate the point.
One use case I had in mind was sorting, would that be a better example? Can you think of a use case where having access to the
Element
instance that was removed would be helpful?