Skip to content

ベータ

これらの App Bridge コンポーネントは新しく、まだ実際の Shopify 管理画面ではテストされていません。ベータ期間中は、マイナーリリースで API が変わる可能性があります。うまく動かない場合は issue を作成してください。

useAppBridge() ​

始める前にインストールを参照してください。

useAppBridge() は shopify グローバルを返します。型は ShopifyGlobal です。

vue
<script setup lang="ts">
import { useAppBridge } from 'polaris-vue-elements/app-bridge'

const shopify = useAppBridge()

function generate(): void {
  shopify.toast.show('Blog post template generated')
}
</script>

<template>
  <button @click="generate">Generate blog post</button>
</template>

@shopify/app-bridge-react と同様です。

  • サーバー上では、いずれかのプロパティを読み取ると例外を投げるオブジェクトを返します。API は onMounted() またはイベントハンドラーから呼び出してください。
  • ブラウザーでは、shopify が定義されていない場合に例外を投げます。これは "likely means the App Bridge script tag was not added correctly to this page" ということです。

埋め込みアプリガイドのように shopify グローバルを直接使うこともできます。

MIT ライセンスの下で公開されています。Vue ロゴは Evan You によるもの(CC BY-NC-SA 4.0)。