Appearance
Home > @plaidev/karte-action-sdk > widget
widget namespace #
Signature:
typescript
declare namespace widget
Functions #
| Function | Description |
|---|---|
| applyCss(css) | アクションに CSS を適用する |
| closeAction(trigger) | アクションを閉じる |
| collection(config) | アクションテーブルを管理するメソッドを取得する |
| collection$0(table) | アクションテーブルを操作するオブジェクト |
| getActionRoot() | アクションのルートの DOM 要素を取得する |
| getCssVariables(data) | |
| getLocalStore(key) | ページをまたぐ変数を取得設定する |
| getMemoryStore(key) | ページ内の変数を取定する |
| getState() | 現在のステートを取得する |
| getVal(name) | 変数を取得する |
| loadStyle(href) | アクションにグローバルなスタイルを読み込む |
| method(name, callback) | WEBのイベントが発生したときに実行されるコールバック関数を設定する |
| on(name, callback) | Widgetのイベントが発生したときに実行されるコールバック関数を設定する |
| onChangeState(fn) | アクションのステートが変更された (changeState) 後にフックする関数 |
| onChangeVal(name, callback) | 変数が変更されたときに実行されるコールバック関数を設定する |
| onClose(fn) | アクションがクローズ (close) される前にフックする関数 |
| onShow(fn) | アクションが表示 (show) された後にフックする関数 |
| setLocalStore(key, value, options) | ページをまたぐ変数を設定する |
| setMemoryStore(key, value) | ページ内の変数を設定する |
| setState(stateId) | 現在のステートを設定する |
| setVal(name, value) | 変数を設定する |
| showAction() | アクションを表示する |
Interfaces #
| Interface | Description |
|---|---|
| ActionOptions | create() 向けのオプション |
| ActionProps | アクションのプロパティ |
Variables #
| Variable | Description |
|---|---|
| storage |
Type Aliases #
| Type Alias | Description |
|---|---|
| ActionChangeStateHook | アクションのライフサイクル changeState で呼び出されるフック関数 |
| ActionCloseHook | アクションのライフサイクル close で呼び出されるフックする関数 |
| ActionEventHandler | アクションのイベントハンドラ |
| ActionHook | アクションのライフサイクルで呼び出されるフック |
| ActionRunnerContext | アクション実行時のコンテキスト |
| ActionSetting | アクション設定 |
| ActionTableQueryParam | |
| ActionTableQueryParams | |
| ActionTableResult | |
| ActionVariables | アクションの変数 |
| ChangeValCallback | |
| CloseTrigger | 閉じるアクショントリガー |
| CollectionConfig | アクションテーブルの設定情報 |
| EventCallback | |
| ModalProps | |
| PublishFunction | アクションの publish 関数 |
| SendFunction | アクションの send 関数 |
| SystemConfig | KARTE のシステム設定情報 |
| WidgetEventName |