このトピックでは、PageWidget の使用方法について説明します。PageWidget は、開発者が iframe を使用して PDS BasicUI のページを独自の Web アプリケーションに迅速に埋め込むためのメソッドを提供します。
1. コンストラクター
iframe のカスタムマウントポイントとスタイル
デフォルトでは、iframe は body 要素にマウントされます。必要に応じて、iframe のカスタム マウントポイント を指定できます。例:
<div id="container"></div>import { PageWidget } from 'aliyun-pds-js-widget';
const domain_id = 'bj1'; // ご自身の domain_id
const token_info = {
access_token: 'xxxxx',
refresh_token: 'xxxxx',
// ...
};
const widgetOpts = {
widget_endpoint: `https://${domain_id}.apps.aliyunpds.com`,
// マウントポイント。
container: document.querySelector('#container'),
// カスタムスタイル。
iframe_style: {
width: '100%',
height: '100%',
},
// 埋め込むページ。
module: 'drive/user',
token_info,
// 現在のトークンの有効期限が切れたときにトークンを取得する関数を設定します。
refresh_token_fun: async () => {
// サーバーサイドの refreshToken API を呼び出すビジネスロジック。
// サーバーから new_token_info を取得します。
// let new_token_info = await fetch(.....)
return new_token_info;
},
};
const ins = new PageWidget(widgetOpts);
PageWidget コンストラクターのパラメーター
パラメーター | タイプ | 必須 | 説明 |
module | string | はい | コンポーネント名。詳細については、「4. module パラメーター」をご参照ください。 |
widget_endpoint | string | はい | コンポーネント UI のエントリ URL。通常、これはご使用のドメインの |
container | string or HTMLElement | はい | コンポーネントがマウントされる要素。 |
lang | string | 言語。有効値: | |
token_info | Object | はい |
|
share_token | string |
| |
refresh_token_fun | Function | はい | 有効期限が切れたときに |
refresh_share_token_fun | Function | 有効期限が切れたときに | |
iframe_style | Object | iframe のカスタムスタイル。 | |
iframe_attr | Object | iframe のカスタム属性。 | |
menus | {name:string, hide:boolean}[] | ファイル操作のメニュー項目のリスト。特定のメニューボタンを非表示にできます。例: | |
show_avatar | boolean | 右上隅にユーザーアバターを表示するかどうかを指定します。デフォルト値: | |
show_sidebar | boolean | サイドバーを表示するかどうかを指定します。デフォルト値: |
2. インスタンスメソッド
呼び出し例:
const ins = new PageWidget(widgetOpts)
// メソッドを呼び出します。
ins.setLang('zh-CN')PageWidget は、次のメソッドをサポートしています:
メソッド | 説明 | パラメーター |
setToken | コンポーネントの | トークン情報を含む JSON オブジェクト。 |
removeToken |
| なし |
setLang | コンポーネントの言語を設定します。 | 言語コード。ハイフン (-) をアンダースコア (_) に置き換えます。例: |
setShareToken |
| string |
on | イベントをリッスンします。 | 下記の詳細をご参照ください。 |
destroy | コンポーネントを破棄します。 | なし |
changeModule | 表示されるページモジュールを切り替えます。 | コンポーネント名を指定する文字列 (例:"drive/user")。詳細については、「4. module パラメーター」をご参照ください。 |
setMenus | メニュー項目の表示/非表示を設定します。 | ファイル操作のメニュー項目のリスト。特定のメニューボタンを非表示にできます。例: |
3. イベントリッスン
コンポーネントイベントをリッスンし、イベントがトリガーされたときにコールバック関数を実行できます。
例:
const ins = new PageWidget(widgetOpts);
ins.on('event_name', function(data) {
// 何らかの処理を実行...
})サポートされるイベント
イベント | 説明 | ペイロード |
load | コンポーネントが初めてレンダリングされるときに発生します。 | なし |
error | コンポーネントでエラーが発生したときに発生します。 |
|
tokenChanged |
|
|
shareTokenChanged |
|
|
langChanged | コンポーネントの言語が変更されたときに発生します。 | 言語名を指定する文字列 (例: |
routerChanged | コンポーネントのルートが変更されたときに発生します。 |
|
fileChanged | ファイル操作が発生したときに発生します。 | {"type": "copy", "fileList": []}。ここで、 |
preview | ファイルのプレビューが開始または停止したときに発生します。 | ファイル情報を含むオブジェクト。プレビューが停止すると、値は |
popup | ポップアップウィンドウの表示/非表示が変更されたときに発生します。 | {"visible": false}。ここで、 |
error イベントコード
TokenInvalid:トークンが無効か、設定されていません。TokenExpired:トークンの有効期限が切れています。
その他のエラーコードについては、「エラー処理」をご参照ください。
fileChanged コールバックパラメーター
ins.on('fileChanged', ({type, fileList})=>{
// コールバックを処理します。
})パラメーター | 必須 | タイプ | 説明 |
type | はい | string |
|
fileList | はい | Object | ファイル項目のフィールドの詳細については、「ファイル」をご参照ください。 必須プロパティ:
任意プロパティ:
|
4. module パラメーター
module コンストラクターパラメーターで初期モジュールを設定するか、changeModule メソッドで実行時にモジュールを切り替えることができます。
PageWidget がサポートするコンポーネント名 | ユーザーインターフェース
管理コンソール
|
例:
const widgetOpts = {
module: 'drive/user',
// ...
}
const ins = new PageWidget(widgetOpts);
ins.changeModule('drive/group')5. menus パラメーター
menus コンストラクターパラメーターまたは setMenus メソッドを使用して、ページ上のファイル操作ボタンを表示または非表示にできます。値 true はボタンを非表示にし、false は表示します。
download:ダウンロードshare:共有sharelink:共有リンクmove:移動copy:コピーstar:お気に入りへの追加/削除rename:名前の変更remark:備考detail:詳細share_owner:コラボレーターの管理delete:削除
例:
const widgetOpts = {
menus: [
{ name: 'download', hide: false },
{ name: 'copy', hide: false },
{ name: 'move', hide: false },
{ name: 'rename', hide: false },
{ name: 'delete', hide: false },
{ name: 'remark', hide: false },
// ...
],
// ...
}
const ins = new PageWidget(widgetOpts);
ins.setMenus([
{ name: 'download', hide: false },
{ name: 'copy', hide: false },
{ name: 'move', hide: false },
{ name: 'rename', hide: false },
{ name: 'delete', hide: false },
{ name: 'remark', hide: false },
// ...
])