Skip to content
On this page

Home > @plaidev/karte-action-sdk

karte-action-sdk package

Functions

FunctionDescription
addChoiceAnswer(questionId, choices, validation)選択式のアンケート回答を追加する
addFreeAnswer(questionId, freeAnswer, validation)自由記述式のアンケート回答を追加する
applyCss(css)アクションに CSS を適用する
applyGlobalCss(css)グローバル CSS をページに適用する
closeAction(trigger)アクションを閉じる
collection(config)アクションテーブルを管理するメソッドを取得する
create(App, options)アクションを作成する
destroyAction()アクションの破棄する
getActionRoot()アクションのルートの DOM 要素を取得する
getAnsweredQuestion(questionId)回答済の回答内容を取得する
getAnsweredQuestionIds()回答済の回答IDのリストを取得
getCssVariables(data)
getEventHandlers()イベントハンドラーの一覧を取得する
getState()現在のステートを取得する
getStates()ステートID一覧を取得する
getSystem()KARTE の設定を取得する
getVariables()変数の一覧を取得する
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)指定した時間の経過後に呼び出すコールバックを登録します
removeAnswer(questionId)回答済の回答を削除
resetEventHandlers()イベントハンドラーをリセットする
resetVariables()変数をリセットする
sendAnswer()sendAnswersのエイリアス
sendAnswers()回答済の回答をまとめてイベントとして送信する
setEventHandlers(handlers)イベントハンドラーを登録する
setSetting(setting)アクション設定を更新する
setState(stateId, options)現在のステートを設定する
setVariables(vars)変数を設定する
showAction()アクションを表示する

Interfaces

InterfaceDescription
ActionOptionscreate() 向けのオプション
ActionPropsアクションのプロパティ
OnScrollContextonScroll() のスクロールコンテキスト情報

Namespaces

NamespaceDescription
widget

Variables

VariableDescription
afterUpdateエレメントを更新した後に実行される関数の登録
AVATAR_SHAPE
AVATAR_SIZE
beforeUpdateエレメントを更新する前に実行される関数の登録
BRAND_KIT
BUTTON_ICON_ANGLE
BUTTON_LINK_TARGET
BUTTON_OUTLINED_ROUND_STYLES
BUTTON_OUTLINED_SIZE_STYLES
BUTTON_OUTLINED_THEME_STYLES
BUTTON_OUTLINED_WRAP_STYLES
BUTTON_ROUND_STYLES
BUTTON_ROUND
BUTTON_SIZE_STYLES
BUTTON_SIZE
BUTTON_TEXT_SIZE_STYLES
BUTTON_TEXT_SIZE
BUTTON_TEXT_THEME_STYLES
BUTTON_TEXT_THEME
BUTTON_THEME_STYLES
BUTTON_THEME
BUTTON_WRAP_STYLES
buttonOutlinedPropsDefault
buttonPropsDefault
CLOSE_BUTTON_LABEL_PLACEMENT
CLOSE_BUTTON_PLACEMENT
CLOSE_BUTTON_ROUND
FormIdentifyTextFields
ICON_SIZE
ICON_VARIANTS
LAYER_TEXT_SIZE
LAYOUT_ALIGN
LAYOUT_COMPONENT_NAMES
LAYOUT_DIRECTION
LAYOUT_DISPLAY_TYPE
LAYOUT_JUSTIFY
onDestoryエレメントを破棄したときに実行される関数の登録
onMountエレメントをマウントしたときに実行される関数の登録
ROUND_STYLES
ROUND_VARIANT
SHADOW_STYLES
SHADOW_VARIANT
TEXT_LINK_SIZE_STYLES
TEXT_LINK_SIZE
TEXT_LINK_THEME_STYLES
TEXT_LINK_THEME
TEXT_LINK_UNDERLINE
TEXT_STYLE
TEXT_THEME_STYLES
TEXT_THEME
TEXT_VARIANTS
tickエレメントのライフサイクルを進める

Type Aliases

Type AliasDescription
ActionChangeStateHookアクションのライフサイクル changeState で呼び出されるフック関数
ActionCloseHookアクションのライフサイクル close で呼び出されるフックする関数
ActionEventHandlerアクションのイベントハンドラ
ActionHookアクションのライフサイクルで呼び出されるフック
ActionVariablesアクションの変数
AvatarProps
BackgroundColorProps
BackgroundImageProps
BorderProps
BrandKit
BrandKitColor
BrandKitColors
ButtonOutlinedProps
ButtonProps
ButtonTextProps
ClickableProps
CloseButtonProps
CloseTrigger閉じるアクショントリガー
CodeProps
CollectionConfigアクションテーブルの設定情報
CommonProps
CustomizeCssProps
Font
IconProps
ImageProps
LayerLayoutProps
LayerTextProps
LayoutDisplayType
LayoutFlexAlign
LayoutFlexDirection
LayoutFlexJustify
LinkProps
MetaProps
OnScrollFunctiononScroll() によって呼び出されるコールバック関数
OverflowProps
PaddingProps
PositionProps
PropStyles
PublishFunctionアクションの publish 関数
RadiusProps
ScrollDirectionスクロール方向
SendFunctionアクションの send 関数
ShadowProps
SliderProps
SystemConfigKARTE のシステム設定情報
TextLinkProps
WithIconProps