Stripe Apps の SettingsView コンポーネント

アカウントでのアプリの機能に関して、顧客が詳細を変更できるようにします。

SDK バージョン

You can define a specialized settings view to let users change specific details about how the app works with their account. For example, an app that uses a third-party API like Zendesk could use SettingsView to authorize a user with their Zendesk account. For more details, learn how to add a settings page for your app.

SettingsView のデザイン

SettingsView は、ContextView と同様に、その他すべての UI エレメントを含むビューのルートコンポーネントです。特定のオブジェクトに関連付けられていない唯一のビューですが、settings ビューポートに関連付けられています。settings ビューポートは、アプリドロワー以外の、ダッシュボードの事前設定された場所にマッピングされます。

SettingsView renders on the app settings page in the Dashboard after you upload an app. While previewing your app locally, you can preview the SettingsView in the Dashboard at https://dashboard.stripe.com/apps/settings-preview.

SettingsView を使用するには、settings ビューポートでアプリマニフェストにビューを追加する必要があります。SettingsView があるアプリケーションには、以下のような ui_extension フィールドを含むアプリマニフェストがあります。

{
  ...,
  "ui_extension": {
    "views": [
      ...,
      {
        "viewport": "settings",
        "component": "AppSettings"
      }
    ],
  }
}

SettingsView プロパティ

プロパティータイプ

プロパティー	タイプ
`children`	必須 `React.ReactNode` コンポーネントのコンテンツ。
`onSave`	オプション `((values: { [x: string]: string; }) => void) \| undefined` If provided, a “Save” `Button` will be rendered with the `SettingsView`. This callback will be called when the `Button` is clicked.
`statusMessage`	オプション `string \| undefined` A string to display a status such as “Saved” or “Error” in the header of the view.

children

必須

React.ReactNode

コンポーネントのコンテンツ。

onSave

オプション

((values: { [x: string]: string; }) => void) | undefined

If provided, a “Save” Button will be rendered with the SettingsView. This callback will be called when the Button is clicked.

statusMessage

オプション

string | undefined

A string to display a status such as “Saved” or “Error” in the header of the view.

例

この例は、外部 API から設定を取得して表示し、変更を保存する方法を示しています。

import React from 'react';
import {ExtensionContextValue} from '@stripe/ui-extension-sdk/context';
import {Box, SettingsView, TextField} from '@stripe/ui-extension-sdk/ui';

type FormStatus = 'initial' | 'saving' | 'saved' | 'error';

const AppSettings = ({userContext}: ExtensionContextValue) => {
  const [storedValue, setStoredValue] = React.useState<string>('');
  const [status, setStatus] = React.useState<FormStatus>('initial');

  // use the current user id to retrieve the stored value from an external api
  const key = userContext.id;

  React.useEffect(() => {
    if (!key) {
      return;
    }

    const fetchSetting = async (key: string) => {
      try {
        const response = await fetch(`https://www.my-api.com/${key}`);
        const storedSettingValue = await response.text();
        if (storedSettingValue) {
          setStoredValue(storedSettingValue);
        }
      } catch (error) {
        console.log('Error fetching setting: ', error);
      }
    };
    fetchSetting(key);
  }, [key]);

  const saveSettings = React.useCallback(async (values) => {
    setStatus('saving');
    try {
      const {greeting} = values;
      const result = await fetch('https://www.my-api.com/', {
        method: 'POST',
        body: JSON.stringify(values),
      });
      await result.text();
      setStatus('saved');
      setStoredValue(greeting);
    } catch (error) {
      console.error(error);
      setStatus('error');
    }
  }, []);

  const getStatusLabel = React.useCallback(() => {
    switch (status) {
      case 'saving':
        return 'Saving...';
      case 'saved':
        return 'Saved!';
      case 'error':
        return 'Error: There was an error saving your settings.';
      case 'initial':
      default:
        return '';
    }
  }, [status]);
  const statusLabel = getStatusLabel();

  return (
    <SettingsView onSave={saveSettings} statusMessage={statusLabel}>
      <Box
        css={{
          padding: 'medium',
          backgroundColor: 'container',
        }}
      >
        <Box
          css={{
            font: 'lead',
          }}
        >
          Please enter a greeting
        </Box>
        <Box
          css={{
            marginBottom: 'medium',
            font: 'caption',
          }}
        >
          Saved value: {storedValue || 'None'}
        </Box>
        <TextField
          name="greeting"
          type="text"
          label="Greeting:"
          size="medium"
        />
      </Box>
    </SettingsView>
  );
};

注

Stripe Apps の SettingsView コンポーネント

アカウントでのアプリの機能に関して、顧客が詳細を変更できるようにします。

SettingsView プロパティ

例

参照情報