-
Notifications
You must be signed in to change notification settings - Fork 7
feat: implement standalone fromContext #51
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
4 changes: 4 additions & 0 deletions
4
example/src/modules/x/contextChildDetached/contextChildDetached.html
This file contains hidden or 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,4 @@ | ||
<template> | ||
<h3>Child</h3> | ||
<p class='child-content-detached'>nameProvidedByParent: {nameProvidedByParent}</p> | ||
</template> |
12 changes: 12 additions & 0 deletions
12
example/src/modules/x/contextChildDetached/contextChildDetached.js
This file contains hidden or 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,12 @@ | ||
import { ContextfulLightningElement } from '@lwc/state/context'; | ||
import { fromContext } from '@lwc/state'; | ||
import childStateFactory from 'x/childState'; | ||
import parentStateFactory from 'x/parentState'; | ||
|
||
export default class ContextChild extends ContextfulLightningElement { | ||
parentState = fromContext(parentStateFactory); | ||
|
||
get nameProvidedByParent() { | ||
return this.parentState.value?.name ?? 'not available'; | ||
} | ||
} |
3 changes: 3 additions & 0 deletions
3
example/src/modules/x/contextParentDetached/contextParentDetached.html
This file contains hidden or 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,3 @@ | ||
<template> | ||
<x-context-child-detached></x-context-child-detached> | ||
</template> |
8 changes: 8 additions & 0 deletions
8
example/src/modules/x/contextParentDetached/contextParentDetached.js
This file contains hidden or 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,8 @@ | ||
import { api } from 'lwc'; | ||
import { ContextfulLightningElement } from '@lwc/state/context'; | ||
import parentStateFactory from 'x/parentState'; | ||
|
||
export default class ContextParent extends ContextfulLightningElement { | ||
@api | ||
parentState = parentStateFactory('parentFoo'); | ||
} |
This file contains hidden or 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 hidden or 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 |
---|---|---|
@@ -1,4 +1,5 @@ | ||
<template> | ||
<x-context-parent></x-context-parent> | ||
<x-context-lonely-child></x-context-lonely-child> | ||
<x-context-parent-detached></x-context-parent-detached> | ||
</template> |
This file contains hidden or 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 hidden or 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,56 @@ | ||
import { connectContext } from './shared.js'; | ||
import { SignalBaseClass, type Signal } from '@lwc/signals'; | ||
import type { ExposedUpdater } from './types.js'; | ||
import type { ContextRuntimeAdapter } from './runtime-interface.js'; | ||
import type { ContextManager } from './index.js'; | ||
|
||
type ValidStateShape = Record<string, Signal<unknown> | ExposedUpdater>; | ||
type ValidStateDef<StateShape extends ValidStateShape> = () => Signal<StateShape>; | ||
|
||
class ConsumedContextSignal<StateShape extends ValidStateShape> | ||
extends SignalBaseClass<ValidStateShape> | ||
implements ContextManager | ||
{ | ||
private desiredStateDef: ValidStateDef<StateShape>; | ||
private _value: StateShape | null = null; | ||
// Currently unused. Should be called once `disconnectContext` is implemented. | ||
private unsubscribe: () => void = () => {}; | ||
|
||
constructor(stateDef: ValidStateDef<StateShape>) { | ||
super(); | ||
this.desiredStateDef = stateDef; | ||
} | ||
|
||
get value(): StateShape | null { | ||
return this._value; | ||
} | ||
|
||
[connectContext](runtimeAdapter: ContextRuntimeAdapter<object>) { | ||
if (!runtimeAdapter) { | ||
throw new Error( | ||
'Implementation error: runtimeAdapter must be present at the time of connect.', | ||
); | ||
} | ||
|
||
runtimeAdapter.consumeContext( | ||
this.desiredStateDef, | ||
(providedContextSignal: Signal<StateShape>) => { | ||
this._value = providedContextSignal.value; | ||
this.notify(); | ||
this.unsubscribe = providedContextSignal.subscribe(() => { | ||
this._value = providedContextSignal.value; | ||
this.notify(); | ||
}); | ||
}, | ||
); | ||
} | ||
} | ||
|
||
export const fromContext = < | ||
StateShape extends ValidStateShape, | ||
StateDef extends ValidStateDef<StateShape>, | ||
>( | ||
stateDef: StateDef, | ||
) => { | ||
return new ConsumedContextSignal<StateShape>(stateDef); | ||
}; |
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.
Uh oh!
There was an error while loading. Please reload this page.