Skip to content

UIモード概要 ​

UIモードによって、RAKUFUNの購入導線をページ内でどのように、どこに表示するかが決まります。モードは4つあり、いずれか1つを選んで使用します。

モードの選び方 ​

目的推奨モード必要なコード
既存のページレイアウトを変えずに、最短で導入したいデフォルトモード最も少ない
ページ内の特定の位置(価格の下など)に購入ボタンを設置したいボタンモード少ない
ページ内の特定の位置にバナーを表示したいバナーモード少ない
独自にデザインしたボタンを使い、見た目を自由に決めたいカスタムモードやや多い

迷った場合は、まずデフォルトモードをお使いください。

最初の3つのモードではSDKがUIを提供するため、商品情報を設定するだけで利用できます。カスタムモードではSDKのUIを使用せず、購入ボタンをご自身で用意します。

ライブデモ ​

SDKが提供する3つのUI(デフォルト・ボタン・バナー)を切り替えてお試しいただけます。

🎨 实时 UI 模式切换演示

在下方选择一个模式,即可实时查看 UI 渲染效果

模式控制:
状态:模式: 未选择 | 已挂载: false
按钮容器

在 button 模式下激活

横幅容器

在 banner 模式下激活

💡 提示:在 default 模式下,底部面板出现在页面底部。 在 button 和 banner 模式下,组件会渲染到上方的容器中。

4つのモードの概要 ​

1. デフォルトモード:画面下部の購入パネル ​

画面下部に購入パネルが自動で表示されます。ページの構成を変更する必要はありません。SDKを読み込んだ後、表示中の商品の情報を設定するだけです。

html
<script src="https://sdk.rakufun.com/rakufun-universal.min.js"></script>
<script>
  rakufun.setUIProductData({
    url: window.location.href,
    title: '商品名',
    price: '12800',
    images: ['https://example.com/product.jpg']
  });
</script>

詳細を見る →


2. ボタンモード:指定位置に表示する購入ボタン ​

ページ内に空の div を配置すると、その位置にSDKが購入ボタンを表示します。

html
<!-- この位置にボタンが表示されます -->
<div class="rakufun-sdk-embed-button"></div>

<script src="https://sdk.rakufun.com/rakufun-universal.min.js"></script>
<script>
  rakufun.setUIMode('button');
  rakufun.setUIProductData({
    url: window.location.href,
    title: '商品名',
    price: '12800',
    images: ['https://example.com/product.jpg']
  });
</script>

詳細を見る →


3. バナーモード:指定位置に表示するバナー ​

使い方はボタンモードと同じで、ボタンの代わりにバナーが表示されます。バナーのどこをクリックしても購入処理が始まります。

html
<!-- この位置にバナーが表示されます -->
<div class="rakufun-sdk-embed-banner"></div>

<script src="https://sdk.rakufun.com/rakufun-universal.min.js"></script>
<script>
  rakufun.setUIMode('banner');
  rakufun.setUIProductData({
    url: window.location.href,
    title: '商品名',
    price: '12800',
    images: ['https://example.com/product.jpg']
  });
</script>

詳細を見る →


4. カスタムモード:独自のボタンを使用 ​

SDKのUIを使用しません。まず disableAutoUI() でSDK標準の画面下部パネルを無効にし、ユーザーが独自のボタンをクリックしたときに quickBuy() を呼び出します。

html
<button id="my-button">今すぐ購入</button>

<script src="https://sdk.rakufun.com/rakufun-universal.min.js"></script>
<script>
  rakufun.disableAutoUI(); // SDK標準の画面下部パネルを表示しない
  document.getElementById('my-button').onclick = async () => {
    const result = await rakufun.quickBuy({
      url: window.location.href,
      title: '商品名',
      price: '12800',
      images: ['https://example.com/product.jpg']
    });
    if (!result.success) console.error(result.message);
  };
</script>

詳細を見る →


補足 ​

日本国内でテストするとUIが表示されない ​

日本国内のIPアドレスでは、初期設定でSDKのUIが表示されません(デフォルト・ボタン・バナーの3つのモードが対象です)。日本国内でテストする場合は、一時的に以下を追加してください。

javascript
rakufun.enableDebug(); // UIが表示され、画面右上にDEBUG表示が出ます。テスト後は削除してください

クリック後に確認ダイアログを表示したい(ボタン/バナーモードのみ) ​

setUICartHandler を使用します。関数が true を返した場合のみ購入処理を続行し、それ以外はキャンセルされます。デフォルトモードでは、この設定は機能しません。

javascript
rakufun.setUICartHandler(async (product) => {
  return confirm(`「${product.title}」を購入しますか?`);
});

ご不明な点がございましたら、service@rakufun.com までお問い合わせください。

MITライセンスに基づいて公開