-
Notifications
You must be signed in to change notification settings - Fork 0
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
fix(tool-nuxt): add composables and fix types #78
Merged
eunjae-lee
merged 3 commits into
SHAPE-6288-starter-for-tool-plugin
from
fix/tool-plugin
Jul 31, 2024
Merged
Changes from 2 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
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,3 @@ | ||
import { useAppBridge } from '../composables/useAppBridge'; | ||
|
||
export type AppBridge = ReturnType<typeof useAppBridge>; |
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,7 @@ | ||
declare module '#app' { | ||
interface NuxtApp { | ||
$appBridge: AppBridge; | ||
} | ||
} | ||
|
||
export {}; |
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 |
---|---|---|
@@ -1,14 +1,10 @@ | ||
<script setup lang="ts"> | ||
const config = useAppConfig(); | ||
const { completed, appBridgeAuth, oauth } = useAppBridge(); | ||
const appBridge = useAppBridge(); | ||
const nuxtApp = useNuxtApp(); | ||
nuxtApp.provide('appBridge', { | ||
completed, | ||
appBridgeAuth, | ||
oauth, | ||
}); | ||
nuxtApp.provide('appBridge', appBridge); | ||
</script> | ||
|
||
<template> | ||
<slot v-if="!config.appBridge.enabled || completed" /> | ||
<slot v-if="!config.appBridge.enabled || appBridge.completed.value" /> | ||
</template> |
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this part is already moved to nuxt-base |
This file was deleted.
Oops, something went wrong.
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
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. copied & modified from tool-plugins/nextjs-starter |
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,33 @@ | ||
export function useAutoHeight() { | ||
const nuxtApp = useNuxtApp(); | ||
let observer: MutationObserver | undefined; | ||
|
||
onMounted(() => { | ||
const observer = new MutationObserver(() => { | ||
const slug = nuxtApp.$appBridge.getSlug(); | ||
const parentHost = nuxtApp.$appBridge.getParentHost(); | ||
window.parent.postMessage( | ||
{ | ||
action: 'tool-changed', | ||
tool: slug, | ||
event: 'heightChange', | ||
height: document.body.scrollHeight, | ||
}, | ||
parentHost, | ||
); | ||
}); | ||
|
||
observer.observe(document.body, { | ||
attributes: true, | ||
childList: true, | ||
subtree: true, | ||
}); | ||
}); | ||
|
||
onUnmounted(() => { | ||
if (observer) { | ||
observer.disconnect(); | ||
observer = undefined; | ||
} | ||
}); | ||
} |
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,38 @@ | ||
export const useStoryContext = () => { | ||
const nuxtApp = useNuxtApp(); | ||
const data = ref<StoryContext>(); | ||
const status = ref<'idle' | 'pending' | 'success'>('idle'); | ||
|
||
const listener = (event: MessageEvent<StoryContextWithAction>) => { | ||
const { action, ...rest } = event.data; | ||
if (action === 'get-context') { | ||
data.value = rest; | ||
status.value = 'success'; | ||
} | ||
}; | ||
|
||
const refresh = () => { | ||
const slug = nuxtApp.$appBridge.getSlug(); | ||
const parentHost = nuxtApp.$appBridge.getParentHost(); | ||
status.value = 'pending'; | ||
window.parent.postMessage( | ||
{ | ||
action: 'tool-changed', | ||
tool: slug, | ||
event: 'getContext', | ||
}, | ||
parentHost, | ||
); | ||
}; | ||
|
||
onMounted(() => { | ||
window.addEventListener('message', listener); | ||
refresh(); | ||
}); | ||
|
||
onUnmounted(() => { | ||
window.removeEventListener('message', listener); | ||
}); | ||
|
||
return { status, data, refresh }; | ||
}; |
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,7 @@ | ||
declare module '#app' { | ||
interface NuxtApp { | ||
$appBridge: AppBridge; | ||
} | ||
} | ||
|
||
export {}; |
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 |
---|---|---|
@@ -1,14 +1,12 @@ | ||
<script setup lang="ts"> | ||
const config = useAppConfig(); | ||
const { completed, appBridgeAuth, oauth } = useAppBridge(); | ||
const appBridge = useAppBridge(); | ||
const nuxtApp = useNuxtApp(); | ||
nuxtApp.provide('appBridge', { | ||
completed, | ||
appBridgeAuth, | ||
oauth, | ||
}); | ||
nuxtApp.provide('appBridge', appBridge); | ||
|
||
useAutoHeight(); | ||
</script> | ||
|
||
<template> | ||
<slot v-if="!config.appBridge.enabled || completed" /> | ||
<slot v-if="!config.appBridge.enabled || appBridge.completed.value" /> | ||
</template> |
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.
As there's a possibility to add more to the return of useAppBridge, I provide the whole appBridge instead of spreading and passing everything.
Because of that change, I had to put
appBridge.completed.value
in the v-if.(Not
appBridge.completed
, becauseappBridge.completed
is still a ref object there. Let me know if you don't understand why it's still not a ref object there)