Appearance
diff --git a/docs/404.html b/docs/404.html index 587594ec..fc43a579 100644 --- a/docs/404.html +++ b/docs/404.html @@ -12,7 +12,7 @@
404
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Home > @plaidev/karte-action-sdk > ActionChangeStateHook
アクションのライフサイクル changeState で呼び出されるフック関数
Signature:
type ActionChangeStateHook<Props, Variables> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], newState: string) => void | Promise<void>;
References: ActionHook, ActionVariables
Home > @plaidev/karte-action-sdk > ActionCloseHook
アクションのライフサイクル close で呼び出されるフックする関数
Signature:
type ActionCloseHook<Props extends ModalProps$1, Variables> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], trigger: CloseTrigger) => void | Promise<void>;
References: ActionHook, ActionVariables, CloseTrigger
Home > @plaidev/karte-action-sdk > ActionEventHandler
アクションのイベントハンドラ
Signature:
type ActionEventHandler = (...args: any[]) => any | Promise<any>;
Home > @plaidev/karte-action-sdk > ActionHook
アクションのライフサイクルで呼び出されるフック
Signature:
type ActionHook<Props, Variables> = (props: ActionProps<Props, Variables & ActionVariables>) => void | Promise<void>;
References: ActionProps, ActionVariables
Home > @plaidev/karte-action-sdk > ActionProps > data
アクションで使用されるデータ
Signature:
data: Props & Variables & ActionVariables;
Home > @plaidev/karte-action-sdk > ActionProps
アクションのプロパティ
Signature:
interface ActionProps<Props, Variables>
Property | Modifiers | Type | Description |
---|---|---|---|
data | Props & Variables & ActionVariables | アクションで使用されるデータ | |
onChangeState? | ActionChangeStateHook<Props, Variables & ActionVariables> | (Optional) アクションのステートが変更されたときにフックされる onChangeState() | |
onShow? | ActionHook<Props, Variables & ActionVariables> | (Optional) アクションが表示されたときにフックされる onShow() | |
publish | PublishFunction | アクション内でタグのQueueにリクエストを発行する関数 | |
send | SendFunction | アクションでイベントがトリガーされたときに受信するための関数 |
Home > @plaidev/karte-action-sdk > ActionProps > onChangeState
アクションのステートが変更されたときにフックされる onChangeState()
Signature:
onChangeState?: ActionChangeStateHook<Props, Variables & ActionVariables>;
Home > @plaidev/karte-action-sdk > ActionProps > onShow
アクションが表示されたときにフックされる onShow()
Signature:
onShow?: ActionHook<Props, Variables & ActionVariables>;
Home > @plaidev/karte-action-sdk > ActionProps > publish
アクション内でタグのQueueにリクエストを発行する関数
Signature:
publish: PublishFunction;
Home > @plaidev/karte-action-sdk > ActionProps > send
アクションでイベントがトリガーされたときに受信するための関数
Signature:
send: SendFunction;
Home > @plaidev/karte-action-sdk > afterUpdate
エレメントを更新した後に実行される関数の登録
Signature:
afterUpdate: typeof afterUpdateSvelte
Home > @plaidev/karte-action-sdk > applyCss
アクションに CSS を適用する
Signature:
declare function applyCss(css: string): Promise<HTMLStyleElement>;
Parameter | Type | Description |
---|---|---|
css | string | 適用する CSS |
Returns:
Promise<HTMLStyleElement>
適用された style 要素を返す Promise
Home > @plaidev/karte-action-sdk > applyGlobalCss
グローバル CSS をページに適用する
Signature:
declare function applyGlobalCss(css: string): Promise<any>;
Parameter | Type | Description |
---|---|---|
css | string | CSS |
Returns:
Promise<any>
Home > @plaidev/karte-action-sdk > beforeUpdate
エレメントを更新する前に実行される関数の登録
Signature:
beforeUpdate: typeof beforeUpdateSvelte
Home > @plaidev/karte-action-sdk > closeAction
アクションを閉じる
Signature:
declare function closeAction(trigger?: CloseTrigger): void;
Parameter | Type | Description |
---|---|---|
trigger | CloseTrigger | (Optional) 閉じた時のトリガー。デフォルト 'none' |
Returns:
void
Home > @plaidev/karte-action-sdk > CloseTrigger
閉じるアクショントリガー
Signature:
type CloseTrigger = "button" | "overlay" | "auto" | "none";
Home > @plaidev/karte-action-sdk > create
アクションを作成する
Signature:
declare function create<Props extends ModalProps, Variables, VariablesQuery extends Array<VariableQuery>>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & ActionVariables, VariablesQuery>): () => void;
Parameter | Type | Description |
---|---|---|
App | typeof SvelteComponentDev | Svelte コンポーネントのエントリポイント |
options | ActionOptions<Props, Variables & ActionVariables, VariablesQuery> | (Optional) オプション |
Returns:
() => void
アクションを破棄する関数
Home > @plaidev/karte-action-sdk > destroyAction
アクションの破棄する
Signature:
declare function destroyAction(): void;
Returns:
void
Home > @plaidev/karte-action-sdk > Font
Signature:
type Font = (typeof Fonts)[number];
Home > @plaidev/karte-action-sdk > getActionRoot
アクションのルートの DOM 要素を取得する
Signature:
declare function getActionRoot(): ShadowRoot | null;
Returns:
ShadowRoot | null
アクションがルートの DOM 要素 を持つ場合は DOM 要素を返します。ない場合は null
を返します
Home > @plaidev/karte-action-sdk > getCssVariables
Signature:
declare function getCssVariables<Props extends ModalProps$1, Variables>(data: Writable<Props & Variables & ActionVariables & VariableQuery>): string;
Parameter | Type | Description |
---|---|---|
data | Writable<Props & Variables & ActionVariables & VariableQuery> |
Returns:
string
Home > @plaidev/karte-action-sdk > getState
現在のステートを取得する
Signature:
declare function getState(): string;
Returns:
string
現在のステートID
アクションが表示されて設定されるため、onShow() フック関数で利用できます。
Home > @plaidev/karte-action-sdk > getStates
ステートID一覧を取得する
Signature:
declare function getStates(): string[];
Returns:
string[]
すべてのステートID
アクションが表示されて設定されるため、onShow() フック関数で利用できます。
Home > @plaidev/karte-action-sdk > getSystem
KARTE の設定を取得する
Signature:
declare function getSystem(): SystemConfig;
Returns:
現在の KARTE システムの設定を返します
アクションが表示されて設定されるため、onShow() フック関数で利用できます。 取得できる設定は、APIキー、接客ID、アクションショートIDなどです。
Home > @plaidev/karte-action-sdk
Function | Description |
---|---|
applyCss(css) | アクションに CSS を適用する |
applyGlobalCss(css) | グローバル CSS をページに適用する |
closeAction(trigger) | アクションを閉じる |
collection(config) | アクションテーブルを管理するメソッドを取得する |
create(App, options) | アクションを作成する |
destroyAction() | アクションの破棄する |
getActionRoot() | アクションのルートの DOM 要素を取得する |
getCssVariables(data) | |
getEventHandlers() | イベントハンドラーの一覧を取得する |
getState() | 現在のステートを取得する |
getStates() | ステートID一覧を取得する |
getSystem() | KARTE の設定を取得する |
isOpened() | アクションの表示・非表示の状態を取得する |
loadGlobalScript(src) | ES Modules に対応していない JavaScript をページに読み込む |
loadGlobalStyle(href) | style ファイルをページに読み込む |
loadStyle(href) | アクションにグローバルなスタイルを読み込む |
onChangeState(fn) | アクションのステートが変更された (changeState) 後にフックする関数 |
onClose(fn) | アクションがクローズ (close) される前にフックする関数 |
onCreate(fn) | アクションが作成 (create) される前にフックする関数 |
onDestroy(fn) | アクションが破棄 (destroy) される前にフックする関数 |
onScroll(rate, fn) | スクロール率が達したときに呼び出すコールバックを登録します |
onShow(fn) | アクションが表示 (show) された後にフックする関数 |
onTime(time, fn) | 指定した時間の経過後に呼び出すコールバックを登録します |
resetEventHandlers() | イベントハンドラーをリセットする |
resetVariables() | 変数をリセットする |
setEventHandlers(handlers) | イベントハンドラーを登録する |
setSetting(setting) | アクション設定を更新する |
setState(stateId, options) | 現在のステートを設定する |
showAction() | アクションを表示する |
Interface | Description |
---|---|
ActionOptions | create() 向けのオプション |
ActionProps | アクションのプロパティ |
OnScrollContext | onScroll() のスクロールコンテキスト情報 |
Namespace | Description |
---|---|
widget |
Variable | Description |
---|---|
afterUpdate | エレメントを更新した後に実行される関数の登録 |
beforeUpdate | エレメントを更新する前に実行される関数の登録 |
LAYOUT_COMPONENT_NAMES | |
onDestory | エレメントを破棄したときに実行される関数の登録 |
onMount | エレメントをマウントしたときに実行される関数の登録 |
tick | エレメントのライフサイクルを進める |
Type Alias | Description |
---|---|
ActionChangeStateHook | アクションのライフサイクル changeState で呼び出されるフック関数 |
ActionCloseHook | アクションのライフサイクル close で呼び出されるフックする関数 |
ActionEventHandler | アクションのイベントハンドラ |
ActionHook | アクションのライフサイクルで呼び出されるフック |
ActionVariables | アクションの変数 |
CloseTrigger | 閉じるアクショントリガー |
CollectionConfig | アクションテーブルの設定情報 |
Font | |
OnScrollFunction | onScroll() によって呼び出されるコールバック関数 |
PublishFunction | アクションの publish 関数 |
ScrollDirection | スクロール方向 |
SendFunction | アクションの send 関数 |
SystemConfig | KARTE のシステム設定情報 |
Home > @plaidev/karte-action-sdk > isOpened
アクションの表示・非表示の状態を取得する
Signature:
declare function isOpened(): boolean;
Returns:
boolean
アクションが表示されているときは true
、非表示のときは false
を返します。
Home > @plaidev/karte-action-sdk > LAYOUT_COMPONENT_NAMES
Signature:
LAYOUT_COMPONENT_NAMES: string[]
Home > @plaidev/karte-action-sdk > loadGlobalScript
ES Modules に対応していない JavaScript をページに読み込む
Signature:
declare function loadGlobalScript(src: string): Promise<any>;
Parameter | Type | Description |
---|---|---|
src | string | JavaScript ファイルのリンク URL |
Returns:
Promise<any>
Home > @plaidev/karte-action-sdk > loadGlobalStyle
style ファイルをページに読み込む
Signature:
declare function loadGlobalStyle(href: string): Promise<any>;
Parameter | Type | Description |
---|---|---|
href | string | style ファイルのリンク URL |
Returns:
Promise<any>
Home > @plaidev/karte-action-sdk > loadStyle
アクションにグローバルなスタイルを読み込む
Signature:
declare function loadStyle(href: string): Promise<void>;
Parameter | Type | Description |
---|---|---|
href | string | style ファイルのリンク URL |
Returns:
Promise<void>
Home > @plaidev/karte-action-sdk > onChangeState
アクションのステートが変更された (changeState) 後にフックする関数
Signature:
declare function onChangeState<Props extends ModalProps$1, Variables>(fn: ActionChangeStateHook<Props, Variables & ActionVariables>): void;
Parameter | Type | Description |
---|---|---|
fn | ActionChangeStateHook<Props, Variables & ActionVariables> | 呼び出されるフック関数 |
Returns:
void
Home > @plaidev/karte-action-sdk > onClose
アクションがクローズ (close) される前にフックする関数
Signature:
declare function onClose<Props extends ModalProps$1, Variables>(fn: ActionCloseHook<Props, Variables & ActionVariables>): void;
Parameter | Type | Description |
---|---|---|
fn | ActionCloseHook<Props, Variables & ActionVariables> | 呼び出されるフック関数 |
Returns:
void
Home > @plaidev/karte-action-sdk > onCreate
アクションが作成 (create) される前にフックする関数
Signature:
declare function onCreate<Props extends ModalProps, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
Parameter | Type | Description |
---|---|---|
fn | ActionHook<Props, Variables & ActionVariables> | 呼び出されるフック関数 |
Returns:
void
Home > @plaidev/karte-action-sdk > onDestory
エレメントを破棄したときに実行される関数の登録
Signature:
onDestory: typeof onDestorySvelte
Home > @plaidev/karte-action-sdk > onDestroy
アクションが破棄 (destroy) される前にフックする関数
Signature:
declare function onDestroy<Props extends ModalProps, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
Parameter | Type | Description |
---|---|---|
fn | ActionHook<Props, Variables & ActionVariables> | 呼び出されるフック関数 |
Returns:
void
Home > @plaidev/karte-action-sdk > onMount
エレメントをマウントしたときに実行される関数の登録
Signature:
onMount: typeof onMountSvelte
Home > @plaidev/karte-action-sdk > onScroll
スクロール率が達したときに呼び出すコールバックを登録します
Signature:
declare function onScroll(rate: number | number[], fn: OnScrollFunction): () => void;
Parameter | Type | Description |
---|---|---|
rate | number | number[] | スクロール率。この値は viewport でのスクロールのパーセンテージ |
fn | OnScrollFunction | スクロール率が達したときに呼び出されるコールバック関数 |
Returns:
() => void
スクロール率によって呼び出されるコールバックを停止する関数を返します
Home > @plaidev/karte-action-sdk > OnScrollContext > deltaRate
現在のスクロール率と前のスクロール率との差分値
Signature:
deltaRate: number;
Home > @plaidev/karte-action-sdk > OnScrollContext > direction
スクロール方向
Signature:
direction: ScrollDirection;
Home > @plaidev/karte-action-sdk > OnScrollContext
onScroll() のスクロールコンテキスト情報
Signature:
interface OnScrollContext
このコンテキスト情報は、OnScrollFunction が呼び出されたタイミングの情報が格納されています
Property | Modifiers | Type | Description |
---|---|---|---|
deltaRate | number | 現在のスクロール率と前のスクロール率との差分値 | |
direction | ScrollDirection | スクロール方向 | |
previousRate | number | 前のスクロール率 | |
rate | number | onScroll() によって指定されたスクロール率 | |
scrollRate | number | ページのスクロール率 |
Home > @plaidev/karte-action-sdk > OnScrollContext > previousRate
前のスクロール率
Signature:
previousRate: number;
Home > @plaidev/karte-action-sdk > OnScrollContext > rate
onScroll() によって指定されたスクロール率
Signature:
rate: number;
Home > @plaidev/karte-action-sdk > OnScrollContext > scrollRate
ページのスクロール率
Signature:
scrollRate: number;
Home > @plaidev/karte-action-sdk > OnScrollFunction
onScroll() によって呼び出されるコールバック関数
Signature:
type OnScrollFunction = (ctx: OnScrollContext) => boolean;
References: OnScrollContext
Home > @plaidev/karte-action-sdk > onShow
アクションが表示 (show) された後にフックする関数
Signature:
declare function onShow<Props extends ModalProps$1, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
Parameter | Type | Description |
---|---|---|
fn | ActionHook<Props, Variables & ActionVariables> | 呼び出されるフック関数 |
Returns:
void
Home > @plaidev/karte-action-sdk > onTime
指定した時間の経過後に呼び出すコールバックを登録します
Signature:
declare function onTime(time: number, fn: Function): () => void;
Parameter | Type | Description |
---|---|---|
time | number | コールバックを呼び出すまでの時間。単位はミリセカンド(ms) |
fn | Function | 指定した時間が経過後に呼び出されるコールバック関数 |
Returns:
() => void
コールバックを呼び出すためのタイマーを停止する関数を返します
Home > @plaidev/karte-action-sdk > PublishFunction
アクションの publish 関数
Signature:
type PublishFunction = (topic: string, values?: any) => void;
Home > @plaidev/karte-action-sdk > resetEventHandlers
イベントハンドラーをリセットする
Signature:
declare function resetEventHandlers(): void;
Returns:
void
Home > @plaidev/karte-action-sdk > resetVariables
変数をリセットする
Signature:
declare function resetVariables(): void;
Returns:
void
Home > @plaidev/karte-action-sdk > ScrollDirection
スクロール方向
Signature:
type ScrollDirection = "up" | "down";
Home > @plaidev/karte-action-sdk > SendFunction
アクションの send 関数
Signature:
type SendFunction = (event_name: string, values?: any) => void;
Home > @plaidev/karte-action-sdk > setSetting
アクション設定を更新する
Signature:
declare function setSetting(setting: ActionSetting): ActionSetting;
Parameter | Type | Description |
---|---|---|
setting | ActionSetting | 更新するアクション設定 |
Returns:
ActionSetting
新しいアクション設定
Home > @plaidev/karte-action-sdk > showAction
アクションを表示する
Signature:
declare function showAction(): void;
Returns:
void
Home > @plaidev/karte-action-sdk > tick
エレメントのライフサイクルを進める
Signature:
tick: typeof tickSvelte