diff --git a/docs/enums/ActionVariableKind.html b/docs/enums/ActionVariableKind.html index a18866b5..25018e94 100644 --- a/docs/enums/ActionVariableKind.html +++ b/docs/enums/ActionVariableKind.html @@ -1 +1 @@ -ActionVariableKind | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ActionVariableKind

Index

Enumeration members

ARRAY = "ARRAY"
BOOLEAN = "BOOLEAN"
COLLECTION = "COLLECTION"
DATE = "DATE"
DATE_TIME = "DATE_TIME"
DECIMAL = "DECIMAL"
INTEGER = "INTEGER"
JSON = "JSON"
OBJECT = "OBJECT"
RECORD = "RECORD"
STRING = "STRING"

Generated using TypeDoc

\ No newline at end of file +ActionVariableKind | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ActionVariableKind

Index

Enumeration members

ARRAY = "ARRAY"
BOOLEAN = "BOOLEAN"
COLLECTION = "COLLECTION"
DATE = "DATE"
DATE_TIME = "DATE_TIME"
DECIMAL = "DECIMAL"
INTEGER = "INTEGER"
JSON = "JSON"
OBJECT = "OBJECT"
RECORD = "RECORD"
STRING = "STRING"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Icon.html b/docs/enums/Icon.html index f70a574b..70da5aa6 100644 --- a/docs/enums/Icon.html +++ b/docs/enums/Icon.html @@ -1 +1 @@ -Icon | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration members

AccordionIcon = "AccordionIcon"
AccordionItemIcon = "AccordionItemIcon"
AlertIcon = "AlertIcon"
AutoCompleteIcon = "AutoCompleteIcon"
AvatarIcon = "AvatarIcon"
BreadcrumbIcon = "BreadcrumbIcon"
BreadcrumbItemIcon = "BreadcrumbItemIcon"
ButtonGroupIcon = "ButtonGroupIcon"
ButtonIcon = "ButtonIcon"
CardActionsIcon = "CardActionsIcon"
CardContentIcon = "CardContentIcon"
CardHeaderIcon = "CardHeaderIcon"
CardIcon = "CardIcon"
CardMediaIcon = "CardMediaIcon"
CheckboxGroupIcon = "CheckboxGroupIcon"
CheckboxIcon = "CheckboxIcon"
ChipIcon = "ChipIcon"
Column2Icon = "Column2Icon"
Column3Icon = "Column3Icon"
ColumnIcon = "ColumnIcon"
ConditionalIcon = "ConditionalIcon"
ContainerIcon = "ContainerIcon"
CreateFormIcon = "CreateFormIcon"
DataContainer = "DataContainer"
DataList = "DataList"
DataTable = "DataTable"
DataTableBody = "DataTableBody"
DataTableColumn = "DataTableColumn"
DataTableHead = "DataTableHead"
DataTableRow = "DataTableRow"
DatePickerIcon = "DatePickerIcon"
DateTimePickerIcon = "DateTimePickerIcon"
DecimalInputIcon = "DecimalInputIcon"
DefinitionListIcon = "DefinitionListIcon"
DeleteRecordIcon = "DeleteRecordIcon"
DetailViewIcon = "DetailViewIcon"
DialogIcon = "DialogIcon"
DrawerIcon = "DrawerIcon"
DynamicFormIcon = "DynamicFormIcon"
DynamicTableIcon = "DynamicTableIcon"
DynamicTilesIcon = "DynamicTilesIcon"
EmailInputIcon = "EmailInputIcon"
FileInputIcon = "FileInputIcon"
FormIcon = "FormIcon"
GridIcon = "GridIcon"
HiddenInputIcon = "HiddenInputIcon"
HorizontalRuleIcon = "HorizontalRuleIcon"
HtmlIcon = "HtmlIcon"
IbanInputIcon = "IbanInputIcon"
IconIcon = "IconIcon"
ImageCarouselIcon = "ImageCarouselIcon"
ImageIcon = "ImageIcon"
ImageInputIcon = "ImageInputIcon"
IncludeIcon = "IncludeIcon"
LabelIcon = "LabelIcon"
Layout1Icon = "Layout1Icon"
Layout2Icon = "Layout2Icon"
Layout3333Icon = "Layout3333Icon"
Layout363Icon = "Layout363Icon"
Layout444Icon = "Layout444Icon"
Layout48Icon = "Layout48Icon"
Layout66Icon = "Layout66Icon"
Layout84Icon = "Layout84Icon"
ListItemIcon = "ListItemIcon"
ListWithDataIcon = "ListWithDataIcon"
LoginFormIcon = "LoginFormIcon"
LogoutIcon = "LogoutIcon"
MenuIcon = "MenuIcon"
MenuItemIcon = "MenuItemIcon"
MultiLineIcon = "MultiLineIcon"
MultiSelectIcon = "MultiSelectIcon"
NavItemIcon = "NavItemIcon"
NavSidebarIcon = "NavSidebarIcon"
NavbarIcon = "NavbarIcon"
NumberInputIcon = "NumberInputIcon"
OpenPageIcon = "OpenPageIcon"
OrderedListIcon = "OrderedListIcon"
PanelIcon = "PanelIcon"
PaperIcon = "PaperIcon"
ParagraphIcon = "ParagraphIcon"
PasswordInputIcon = "PasswordInputIcon"
PhoneInputIcon = "PhoneInputIcon"
PriceInputIcon = "PriceInputIcon"
ProgressBarIcon = "ProgressBarIcon"
RadioButtonIcon = "RadioButtonIcon"
RatingIcon = "RatingIcon"
RowColumnIcon = "RowColumnIcon"
RowIcon = "RowIcon"
SelectIcon = "SelectIcon"
SidebarLeftIcon = "SidebarLeftIcon"
SliderComponentIcon = "SliderComponentIcon"
SnackbarIcon = "SnackbarIcon"
StepIcon = "StepIcon"
StepperIcon = "StepperIcon"
SubmitButtonIcon = "SubmitButtonIcon"
SwitcherIcon = "SwitcherIcon"
TabIcon = "TabIcon"
Table = "Table"
TabsIcon = "TabsIcon"
TextInputIcon = "TextInputIcon"
TextareaIcon = "TextareaIcon"
TimePickerIcon = "TimePickerIcon"
TitleIcon = "TitleIcon"
UnorderedListIcon = "UnorderedListIcon"
UpdateFormIcon = "UpdateFormIcon"
UrlInputIcon = "UrlInputIcon"

Generated using TypeDoc

\ No newline at end of file +Icon | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration members

AccordionIcon = "AccordionIcon"
AccordionItemIcon = "AccordionItemIcon"
AlertIcon = "AlertIcon"
AutoCompleteIcon = "AutoCompleteIcon"
AvatarIcon = "AvatarIcon"
BreadcrumbIcon = "BreadcrumbIcon"
BreadcrumbItemIcon = "BreadcrumbItemIcon"
ButtonGroupIcon = "ButtonGroupIcon"
ButtonIcon = "ButtonIcon"
CardActionsIcon = "CardActionsIcon"
CardContentIcon = "CardContentIcon"
CardHeaderIcon = "CardHeaderIcon"
CardIcon = "CardIcon"
CardMediaIcon = "CardMediaIcon"
CheckboxGroupIcon = "CheckboxGroupIcon"
CheckboxIcon = "CheckboxIcon"
ChipIcon = "ChipIcon"
Column2Icon = "Column2Icon"
Column3Icon = "Column3Icon"
ColumnIcon = "ColumnIcon"
ConditionalIcon = "ConditionalIcon"
ContainerIcon = "ContainerIcon"
CreateFormIcon = "CreateFormIcon"
DataContainer = "DataContainer"
DataList = "DataList"
DataTable = "DataTable"
DataTableBody = "DataTableBody"
DataTableColumn = "DataTableColumn"
DataTableHead = "DataTableHead"
DataTableRow = "DataTableRow"
DatePickerIcon = "DatePickerIcon"
DateTimePickerIcon = "DateTimePickerIcon"
DecimalInputIcon = "DecimalInputIcon"
DefinitionListIcon = "DefinitionListIcon"
DeleteRecordIcon = "DeleteRecordIcon"
DetailViewIcon = "DetailViewIcon"
DialogIcon = "DialogIcon"
DrawerIcon = "DrawerIcon"
DynamicFormIcon = "DynamicFormIcon"
DynamicTableIcon = "DynamicTableIcon"
DynamicTilesIcon = "DynamicTilesIcon"
EmailInputIcon = "EmailInputIcon"
FileInputIcon = "FileInputIcon"
FormIcon = "FormIcon"
GridIcon = "GridIcon"
HiddenInputIcon = "HiddenInputIcon"
HorizontalRuleIcon = "HorizontalRuleIcon"
HtmlIcon = "HtmlIcon"
IbanInputIcon = "IbanInputIcon"
IconIcon = "IconIcon"
ImageCarouselIcon = "ImageCarouselIcon"
ImageIcon = "ImageIcon"
ImageInputIcon = "ImageInputIcon"
IncludeIcon = "IncludeIcon"
LabelIcon = "LabelIcon"
Layout1Icon = "Layout1Icon"
Layout2Icon = "Layout2Icon"
Layout3333Icon = "Layout3333Icon"
Layout363Icon = "Layout363Icon"
Layout444Icon = "Layout444Icon"
Layout48Icon = "Layout48Icon"
Layout66Icon = "Layout66Icon"
Layout84Icon = "Layout84Icon"
ListItemIcon = "ListItemIcon"
ListWithDataIcon = "ListWithDataIcon"
LoginFormIcon = "LoginFormIcon"
LogoutIcon = "LogoutIcon"
MenuIcon = "MenuIcon"
MenuItemIcon = "MenuItemIcon"
MultiLineIcon = "MultiLineIcon"
MultiSelectIcon = "MultiSelectIcon"
NavItemIcon = "NavItemIcon"
NavSidebarIcon = "NavSidebarIcon"
NavbarIcon = "NavbarIcon"
NumberInputIcon = "NumberInputIcon"
OpenPageIcon = "OpenPageIcon"
OrderedListIcon = "OrderedListIcon"
PanelIcon = "PanelIcon"
PaperIcon = "PaperIcon"
ParagraphIcon = "ParagraphIcon"
PasswordInputIcon = "PasswordInputIcon"
PhoneInputIcon = "PhoneInputIcon"
PriceInputIcon = "PriceInputIcon"
ProgressBarIcon = "ProgressBarIcon"
RadioButtonIcon = "RadioButtonIcon"
RatingIcon = "RatingIcon"
RowColumnIcon = "RowColumnIcon"
RowIcon = "RowIcon"
SelectIcon = "SelectIcon"
SidebarLeftIcon = "SidebarLeftIcon"
SliderComponentIcon = "SliderComponentIcon"
SnackbarIcon = "SnackbarIcon"
StepIcon = "StepIcon"
StepperIcon = "StepperIcon"
SubmitButtonIcon = "SubmitButtonIcon"
SwitcherIcon = "SwitcherIcon"
TabIcon = "TabIcon"
Table = "Table"
TabsIcon = "TabsIcon"
TextInputIcon = "TextInputIcon"
TextareaIcon = "TextareaIcon"
TimePickerIcon = "TimePickerIcon"
TitleIcon = "TitleIcon"
UnorderedListIcon = "UnorderedListIcon"
UpdateFormIcon = "UpdateFormIcon"
UrlInputIcon = "UrlInputIcon"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/InteractionOptionType.html b/docs/enums/InteractionOptionType.html index d76c4ac3..c756304b 100644 --- a/docs/enums/InteractionOptionType.html +++ b/docs/enums/InteractionOptionType.html @@ -1 +1 @@ -InteractionOptionType | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration InteractionOptionType

Index

Enumeration members

Boolean = "Boolean"
Event = "Event"
Locale = "Locale"
Number = "Number"
Page = "Page"
String = "String"
Void = "Void"

Generated using TypeDoc

\ No newline at end of file +InteractionOptionType | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration InteractionOptionType

Index

Enumeration members

Boolean = "Boolean"
Event = "Event"
Locale = "Locale"
Number = "Number"
Page = "Page"
String = "String"
Void = "Void"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/InteractionOptionTypeToDo.html b/docs/enums/InteractionOptionTypeToDo.html index a5b1ad1c..e8669bc6 100644 --- a/docs/enums/InteractionOptionTypeToDo.html +++ b/docs/enums/InteractionOptionTypeToDo.html @@ -1 +1 @@ -InteractionOptionTypeToDo | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration InteractionOptionTypeToDo

Index

Enumeration members

Color = "Color"
Endpoint = "Endpoint"
Filter = "Filter"
Font = "Font"
Properties = "Properties"
Property = "Property"
Size = "Size"
Unit = "Unit"

Generated using TypeDoc

\ No newline at end of file +InteractionOptionTypeToDo | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration InteractionOptionTypeToDo

Index

Enumeration members

Color = "Color"
Endpoint = "Endpoint"
Filter = "Filter"
Font = "Font"
Properties = "Properties"
Property = "Property"
Size = "Size"
Unit = "Unit"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/InteractionType.html b/docs/enums/InteractionType.html index 8379310b..58145362 100644 --- a/docs/enums/InteractionType.html +++ b/docs/enums/InteractionType.html @@ -1 +1 @@ -InteractionType | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration members

Enumeration members

Custom = "Custom"
Global = "Global"

Generated using TypeDoc

\ No newline at end of file +InteractionType | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration members

Enumeration members

Custom = "Custom"
Global = "Global"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/ThemeColor.html b/docs/enums/ThemeColor.html index 48bdec28..124cb011 100644 --- a/docs/enums/ThemeColor.html +++ b/docs/enums/ThemeColor.html @@ -1 +1 @@ -ThemeColor | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration members

ACCENT_1 = "Accent1"
ACCENT_2 = "Accent2"
ACCENT_3 = "Accent3"
BLACK = "Black"
DANGER = "Danger"
DARK = "Dark"
INFO = "Info"
LIGHT = "Light"
MEDIUM = "Medium"
PRIMARY = "Primary"
SECONDARY = "Secondary"
SUCCESS = "Success"
TRANSPARENT = "Transparent"
WARNING = "Warning"
WHITE = "White"

Generated using TypeDoc

\ No newline at end of file +ThemeColor | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration members

ACCENT_1 = "Accent1"
ACCENT_2 = "Accent2"
ACCENT_3 = "Accent3"
BLACK = "Black"
DANGER = "Danger"
DARK = "Dark"
INFO = "Info"
LIGHT = "Light"
MEDIUM = "Medium"
PRIMARY = "Primary"
SECONDARY = "Secondary"
SUCCESS = "Success"
TRANSPARENT = "Transparent"
WARNING = "Warning"
WHITE = "White"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AuthenticateUserStepOption.html b/docs/interfaces/AuthenticateUserStepOption.html index 9f831fe9..6dc9fe5d 100644 --- a/docs/interfaces/AuthenticateUserStepOption.html +++ b/docs/interfaces/AuthenticateUserStepOption.html @@ -1 +1 @@ -AuthenticateUserStepOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthenticateUserStepOption

Hierarchy

  • AuthenticateUserStepOption

Index

Properties

authenticationProfileId: string
ref: { jwtAs: string; password: string; username: string }

Type declaration

  • jwtAs: string
  • password: string
  • username: string

Generated using TypeDoc

\ No newline at end of file +AuthenticateUserStepOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthenticateUserStepOption

Hierarchy

  • AuthenticateUserStepOption

Index

Properties

authenticationProfileId: string
ref: { jwtAs: string; password: string; username: string }

Type declaration

  • jwtAs: string
  • password: string
  • username: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/BaseConfiguration.html b/docs/interfaces/BaseConfiguration.html index ceed5f5d..1acde5d7 100644 --- a/docs/interfaces/BaseConfiguration.html +++ b/docs/interfaces/BaseConfiguration.html @@ -1 +1 @@ -BaseConfiguration | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • BaseConfiguration

Index

Properties

Properties

condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }

Type declaration

  • comparator: "EQ"
  • option: string
  • type: "SHOW" | "HIDE"
  • value: string | boolean

Generated using TypeDoc

\ No newline at end of file +BaseConfiguration | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • BaseConfiguration

Index

Properties

Properties

condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }

Type declaration

  • comparator: "EQ"
  • option: string
  • type: "SHOW" | "HIDE"
  • value: string | boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/BasePrefabInteraction.html b/docs/interfaces/BasePrefabInteraction.html index cd1972c6..12d838f7 100644 --- a/docs/interfaces/BasePrefabInteraction.html +++ b/docs/interfaces/BasePrefabInteraction.html @@ -1 +1 @@ -BasePrefabInteraction | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

name: string
ref: { sourceComponentId?: string; targetComponentId?: string }

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string
sourceComponentId?: string
sourceEvent: string
targetOptionName?: string

Generated using TypeDoc

\ No newline at end of file +BasePrefabInteraction | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

name: string
ref: { sourceComponentId?: string; targetComponentId?: string }

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string
sourceComponentId?: string
sourceEvent: string
targetOptionName?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Interaction.html b/docs/interfaces/Interaction.html index 6f7ad574..896cf096 100644 --- a/docs/interfaces/Interaction.html +++ b/docs/interfaces/Interaction.html @@ -1 +1 @@ -Interaction | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

function: string
name: string
parameters: Record<string, InteractionOptionType>

Generated using TypeDoc

\ No newline at end of file +Interaction | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

function: string
name: string
parameters: Record<string, InteractionOptionType>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/InteractionCompatibility.html b/docs/interfaces/InteractionCompatibility.html index 5b87da0b..2d8f7d4b 100644 --- a/docs/interfaces/InteractionCompatibility.html +++ b/docs/interfaces/InteractionCompatibility.html @@ -1 +1 @@ -InteractionCompatibility | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InteractionCompatibility

Hierarchy

Index

Properties

name: string
parameters: Record<string, InteractionOptionType>

Generated using TypeDoc

\ No newline at end of file +InteractionCompatibility | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InteractionCompatibility

Hierarchy

Index

Properties

name: string
parameters: Record<string, InteractionOptionType>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ParameterOptionWithComponentRef.html b/docs/interfaces/ParameterOptionWithComponentRef.html index 7600a79b..4b0f65f3 100644 --- a/docs/interfaces/ParameterOptionWithComponentRef.html +++ b/docs/interfaces/ParameterOptionWithComponentRef.html @@ -1 +1 @@ -ParameterOptionWithComponentRef | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ParameterOptionWithComponentRef

Hierarchy

  • ParameterOptionWithComponentRef

Index

Properties

name: string
parameter: string
ref: { componentId: string }

Type declaration

  • componentId: string

Generated using TypeDoc

\ No newline at end of file +ParameterOptionWithComponentRef | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ParameterOptionWithComponentRef

Hierarchy

  • ParameterOptionWithComponentRef

Index

Properties

name: string
parameter: string
ref: { componentId: string }

Type declaration

  • componentId: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ParameterOptionWithId.html b/docs/interfaces/ParameterOptionWithId.html index 1c2e6090..5073838d 100644 --- a/docs/interfaces/ParameterOptionWithId.html +++ b/docs/interfaces/ParameterOptionWithId.html @@ -1 +1 @@ -ParameterOptionWithId | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ParameterOptionWithId

Index

Properties

Properties

id: string[]
parameter: string

Generated using TypeDoc

\ No newline at end of file +ParameterOptionWithId | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ParameterOptionWithId

Index

Properties

Properties

id: string[]
parameter: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ParameterOptionWithPageId.html b/docs/interfaces/ParameterOptionWithPageId.html index 16fcb5e5..39ee2809 100644 --- a/docs/interfaces/ParameterOptionWithPageId.html +++ b/docs/interfaces/ParameterOptionWithPageId.html @@ -1 +1 @@ -ParameterOptionWithPageId | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ParameterOptionWithPageId

Hierarchy

  • ParameterOptionWithPageId

Index

Properties

endpointId?: string
id?: string
name?: string
pageId: string
parameters?: { name: string; value: string }[]

Generated using TypeDoc

\ No newline at end of file +ParameterOptionWithPageId | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ParameterOptionWithPageId

Hierarchy

  • ParameterOptionWithPageId

Index

Properties

endpointId?: string
id?: string
name?: string
pageId: string
parameters?: { name: string; value: string }[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ParameterOptionWithPath.html b/docs/interfaces/ParameterOptionWithPath.html index 252b0713..ca5d6388 100644 --- a/docs/interfaces/ParameterOptionWithPath.html +++ b/docs/interfaces/ParameterOptionWithPath.html @@ -1 +1 @@ -ParameterOptionWithPath | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ParameterOptionWithPath

Index

Properties

Properties

parameter: string
path: string[]

Generated using TypeDoc

\ No newline at end of file +ParameterOptionWithPath | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ParameterOptionWithPath

Index

Properties

Properties

parameter: string
path: string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Prefab.html b/docs/interfaces/Prefab.html index 656c3d9f..820d61db 100644 --- a/docs/interfaces/Prefab.html +++ b/docs/interfaces/Prefab.html @@ -1 +1 @@ -Prefab | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Prefab

Index

Properties

actions?: PrefabAction[]
beforeCreate?: string
category: string
description?: string
icon: Icon
interactions?: PrefabInteraction[]
keywords?: string[]
name: string
structure: PrefabReference[]
type?: string
variables?: PrefabVariable[]

Generated using TypeDoc

\ No newline at end of file +Prefab | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Prefab

Index

Properties

actions?: PrefabAction[]
beforeCreate?: string
category: string
description?: string
icon: Icon
interactions?: PrefabInteraction[]
keywords?: string[]
name: string
structure: PrefabReference[]
type?: string
variables?: PrefabVariable[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabAction.html b/docs/interfaces/PrefabAction.html index 094a1569..ec62f8ed 100644 --- a/docs/interfaces/PrefabAction.html +++ b/docs/interfaces/PrefabAction.html @@ -1 +1 @@ -PrefabAction | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabAction

Index

Properties

events?: PrefabActionStep[]
name: string
options?: { ref: { result: string } }

Type declaration

  • ref: { result: string }
    • result: string
ref: { endpointId?: string; id: string }

Type declaration

  • Optional endpointId?: string
  • id: string
useNewRuntime: boolean

Generated using TypeDoc

\ No newline at end of file +PrefabAction | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabAction

Index

Properties

events?: PrefabActionStep[]
name: string
options?: { ref: { result: string } }

Type declaration

  • ref: { result: string }
    • result: string
ref: { endpointId?: string; id: string }

Type declaration

  • Optional endpointId?: string
  • id: string
useNewRuntime: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabActionAssign.html b/docs/interfaces/PrefabActionAssign.html index cc07f65c..9b5137c2 100644 --- a/docs/interfaces/PrefabActionAssign.html +++ b/docs/interfaces/PrefabActionAssign.html @@ -1 +1 @@ -PrefabActionAssign | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabActionAssign

Index

Properties

Properties

leftHandSide: string
ref: { path: string[] }

Type declaration

  • path: string[]

Generated using TypeDoc

\ No newline at end of file +PrefabActionAssign | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabActionAssign

Index

Properties

Properties

leftHandSide: string
ref: { path: string[] }

Type declaration

  • path: string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabActionCreateStepOption.html b/docs/interfaces/PrefabActionCreateStepOption.html index 1ce72208..c083045d 100644 --- a/docs/interfaces/PrefabActionCreateStepOption.html +++ b/docs/interfaces/PrefabActionCreateStepOption.html @@ -1 +1 @@ -PrefabActionCreateStepOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabActionCreateStepOption

Hierarchy

  • PrefabActionCreateStepOption

Index

Properties

modelId: string
ref: { customModel: string }

Type declaration

  • customModel: string

Generated using TypeDoc

\ No newline at end of file +PrefabActionCreateStepOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabActionCreateStepOption

Hierarchy

  • PrefabActionCreateStepOption

Index

Properties

modelId: string
ref: { customModel: string }

Type declaration

  • customModel: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabActionDeleteStepOption.html b/docs/interfaces/PrefabActionDeleteStepOption.html index b951a60f..5192cb97 100644 --- a/docs/interfaces/PrefabActionDeleteStepOption.html +++ b/docs/interfaces/PrefabActionDeleteStepOption.html @@ -1 +1 @@ -PrefabActionDeleteStepOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabActionDeleteStepOption

Hierarchy

  • PrefabActionDeleteStepOption

Index

Properties

Properties

ref: { customModel: string; object: string }

Type declaration

  • customModel: string
  • object: string

Generated using TypeDoc

\ No newline at end of file +PrefabActionDeleteStepOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabActionDeleteStepOption

Hierarchy

  • PrefabActionDeleteStepOption

Index

Properties

Properties

ref: { customModel: string; object: string }

Type declaration

  • customModel: string
  • object: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabActionStep.html b/docs/interfaces/PrefabActionStep.html index da02a9a4..5b0bef7f 100644 --- a/docs/interfaces/PrefabActionStep.html +++ b/docs/interfaces/PrefabActionStep.html @@ -1 +1 @@ -PrefabActionStep | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabActionStep

Index

Properties

Properties

kind: string

Generated using TypeDoc

\ No newline at end of file +PrefabActionStep | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabActionStep

Index

Properties

Properties

kind: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabActionUpdateStepOption.html b/docs/interfaces/PrefabActionUpdateStepOption.html index 458b64a4..c517f795 100644 --- a/docs/interfaces/PrefabActionUpdateStepOption.html +++ b/docs/interfaces/PrefabActionUpdateStepOption.html @@ -1 +1 @@ -PrefabActionUpdateStepOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabActionUpdateStepOption

Hierarchy

  • PrefabActionUpdateStepOption

Index

Properties

Properties

ref: { customModel?: string; object: string }

Type declaration

  • Optional customModel?: string
  • object: string

Generated using TypeDoc

\ No newline at end of file +PrefabActionUpdateStepOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabActionUpdateStepOption

Hierarchy

  • PrefabActionUpdateStepOption

Index

Properties

Properties

ref: { customModel?: string; object: string }

Type declaration

  • Optional customModel?: string
  • object: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabComponent.html b/docs/interfaces/PrefabComponent.html index 255a7425..64606485 100644 --- a/docs/interfaces/PrefabComponent.html +++ b/docs/interfaces/PrefabComponent.html @@ -1 +1 @@ -PrefabComponent | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabComponent

Index

Properties

$afterCreate?: Hook[]
$afterDelete?: Hook[]
$onUpdate?: Hook[]
actions?: PrefabAction[]
descendants: PrefabReference[]
id?: string
label?: string
name: string
optionCategories?: OptionCategory[]
ref?: { id: string }

Type declaration

  • id: string
type?: "COMPONENT"

Generated using TypeDoc

\ No newline at end of file +PrefabComponent | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabComponent

Index

Properties

$afterCreate?: Hook[]
$afterDelete?: Hook[]
$onUpdate?: Hook[]
actions?: PrefabAction[]
descendants: PrefabReference[]
id?: string
label?: string
name: string
optionCategories?: OptionCategory[]
ref?: { id: string }

Type declaration

  • id: string
type?: "COMPONENT"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabComponentOptionBase.html b/docs/interfaces/PrefabComponentOptionBase.html index 8400a1ed..89eb509c 100644 --- a/docs/interfaces/PrefabComponentOptionBase.html +++ b/docs/interfaces/PrefabComponentOptionBase.html @@ -1 +1 @@ -PrefabComponentOptionBase | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabComponentOptionBase

Hierarchy

Index

Properties

configuration?: unknown
key: string
label: string
type: string

Generated using TypeDoc

\ No newline at end of file +PrefabComponentOptionBase | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabComponentOptionBase

Hierarchy

Index

Properties

configuration?: unknown
key: string
label: string
type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabCustomInteraction.html b/docs/interfaces/PrefabCustomInteraction.html index 8a335b3c..f5dd9cb1 100644 --- a/docs/interfaces/PrefabCustomInteraction.html +++ b/docs/interfaces/PrefabCustomInteraction.html @@ -1 +1 @@ -PrefabCustomInteraction | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

name: string
ref: { sourceComponentId?: string; targetComponentId?: string }

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string
sourceComponentId?: string
sourceEvent: string
targetOptionName?: string
type: Custom

Generated using TypeDoc

\ No newline at end of file +PrefabCustomInteraction | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

name: string
ref: { sourceComponentId?: string; targetComponentId?: string }

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string
sourceComponentId?: string
sourceEvent: string
targetOptionName?: string
type: Custom

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabGlobalInteraction.html b/docs/interfaces/PrefabGlobalInteraction.html index 7372066d..7d769ca4 100644 --- a/docs/interfaces/PrefabGlobalInteraction.html +++ b/docs/interfaces/PrefabGlobalInteraction.html @@ -1 +1 @@ -PrefabGlobalInteraction | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

name: string
ref: { sourceComponentId?: string; targetComponentId?: string }

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string
sourceComponentId?: string
sourceEvent: string
targetOptionName?: string
type: Global

Generated using TypeDoc

\ No newline at end of file +PrefabGlobalInteraction | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

name: string
ref: { sourceComponentId?: string; targetComponentId?: string }

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string
sourceComponentId?: string
sourceEvent: string
targetOptionName?: string
type: Global

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabLinkedOptionBase.html b/docs/interfaces/PrefabLinkedOptionBase.html index cc2b64d4..543e257d 100644 --- a/docs/interfaces/PrefabLinkedOptionBase.html +++ b/docs/interfaces/PrefabLinkedOptionBase.html @@ -1 +1 @@ -PrefabLinkedOptionBase | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Properties

key: string
label: string

Generated using TypeDoc

\ No newline at end of file +PrefabLinkedOptionBase | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Properties

key: string
label: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabPartial.html b/docs/interfaces/PrefabPartial.html index 264e9b05..dcea1ec5 100644 --- a/docs/interfaces/PrefabPartial.html +++ b/docs/interfaces/PrefabPartial.html @@ -1 +1 @@ -PrefabPartial | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabPartial

Index

Properties

Properties

partialId: string
type: "PARTIAL"

Generated using TypeDoc

\ No newline at end of file +PrefabPartial | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabPartial

Index

Properties

Properties

partialId: string
type: "PARTIAL"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabVariable.html b/docs/interfaces/PrefabVariable.html index 7f461fe4..776e4c86 100644 --- a/docs/interfaces/PrefabVariable.html +++ b/docs/interfaces/PrefabVariable.html @@ -1 +1 @@ -PrefabVariable | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabVariable

Index

Properties

name: string
options?: unknown
ref: { actionId?: string; endpointId?: string; id: string }

Type declaration

  • Optional actionId?: string
  • Optional endpointId?: string
  • id: string

Generated using TypeDoc

\ No newline at end of file +PrefabVariable | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabVariable

Index

Properties

name: string
options?: unknown
ref: { actionId?: string; endpointId?: string; id: string }

Type declaration

  • Optional actionId?: string
  • Optional endpointId?: string
  • id: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabWrapper.html b/docs/interfaces/PrefabWrapper.html index c85fb8c0..b7c1e2bf 100644 --- a/docs/interfaces/PrefabWrapper.html +++ b/docs/interfaces/PrefabWrapper.html @@ -1 +1 @@ -PrefabWrapper | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabWrapper

Index

Properties

descendants: PrefabReference[]
label?: string
optionCategories?: OptionCategory[]
type: "WRAPPER"

Generated using TypeDoc

\ No newline at end of file +PrefabWrapper | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PrefabWrapper

Index

Properties

descendants: PrefabReference[]
label?: string
optionCategories?: OptionCategory[]
type: "WRAPPER"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabWrapperLinkedOption.html b/docs/interfaces/PrefabWrapperLinkedOption.html index 6be515f3..f35e4b59 100644 --- a/docs/interfaces/PrefabWrapperLinkedOption.html +++ b/docs/interfaces/PrefabWrapperLinkedOption.html @@ -1 +1 @@ -PrefabWrapperLinkedOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabWrapperLinkedOption

Hierarchy

Index

Properties

key: string
label: string
type: "LINKED_OPTION"
value?: { ref: { componentId: string; optionId: string } }

Type declaration

  • ref: { componentId: string; optionId: string }
    • componentId: string
    • optionId: string

Generated using TypeDoc

\ No newline at end of file +PrefabWrapperLinkedOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabWrapperLinkedOption

Hierarchy

Index

Properties

key: string
label: string
type: "LINKED_OPTION"
value?: { ref: { componentId: string; optionId: string } }

Type declaration

  • ref: { componentId: string; optionId: string }
    • componentId: string
    • optionId: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabWrapperLinkedPartialOption.html b/docs/interfaces/PrefabWrapperLinkedPartialOption.html index a6a52902..bab897eb 100644 --- a/docs/interfaces/PrefabWrapperLinkedPartialOption.html +++ b/docs/interfaces/PrefabWrapperLinkedPartialOption.html @@ -1 +1 @@ -PrefabWrapperLinkedPartialOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabWrapperLinkedPartialOption

Hierarchy

Index

Properties

key: string
label: string
type: "LINKED_PARTIAL"
value?: { ref: { componentId: string } }

Type declaration

  • ref: { componentId: string }
    • componentId: string

Generated using TypeDoc

\ No newline at end of file +PrefabWrapperLinkedPartialOption | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefabWrapperLinkedPartialOption

Hierarchy

Index

Properties

key: string
label: string
type: "LINKED_PARTIAL"
value?: { ref: { componentId: string } }

Type declaration

  • ref: { componentId: string }
    • componentId: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ValueDefault.html b/docs/interfaces/ValueDefault.html index e41b2b70..a98447d5 100644 --- a/docs/interfaces/ValueDefault.html +++ b/docs/interfaces/ValueDefault.html @@ -1 +1 @@ -ValueDefault | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

configuration?: unknown
key: string
label: string
ref?: { id?: string }

Type declaration

  • Optional id?: string
type: string
value: string | number | boolean | string[] | ValueConfig

Generated using TypeDoc

\ No newline at end of file +ValueDefault | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

configuration?: unknown
key: string
label: string
ref?: { id?: string }

Type declaration

  • Optional id?: string
type: string
value: string | number | boolean | string[] | ValueConfig

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ValueRef.html b/docs/interfaces/ValueRef.html index 08830e4b..12b9a6b8 100644 --- a/docs/interfaces/ValueRef.html +++ b/docs/interfaces/ValueRef.html @@ -1 +1 @@ -ValueRef | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

configuration?: unknown
key: string
label: string
ref: { id?: string; value: string | string[] }

Type declaration

  • Optional id?: string
  • value: string | string[]
type: string

Generated using TypeDoc

\ No newline at end of file +ValueRef | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

configuration?: unknown
key: string
label: string
ref: { id?: string; value: string | string[] }

Type declaration

  • Optional id?: string
  • value: string | string[]
type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index d6287d95..c31d0bef 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4 +1,4 @@ -@betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

@betty-blocks/component-sdk

Index

Type aliases

BeforeCreateArgs: { components: {}; helpers: { BettyPrefabs: typeof BettyPrefabs; PropertyKind: typeof PropertyKind; addActionVariable: any; camelToSnakeCase: any; cloneStructure: any; createUuid: any; makeBettyInput: any; makeBettyUpdateInput: any; prepareAction: any; setOption: any; useCurrentPageId: any; useCurrentPartialId: any; useModelQuery: any }; prefab: Prefab; prefabs: Prefab[]; close: any; save: any }

Type declaration

  • components: {}
    • [name: string]: any
  • helpers: { BettyPrefabs: typeof BettyPrefabs; PropertyKind: typeof PropertyKind; addActionVariable: any; camelToSnakeCase: any; cloneStructure: any; createUuid: any; makeBettyInput: any; makeBettyUpdateInput: any; prepareAction: any; setOption: any; useCurrentPageId: any; useCurrentPartialId: any; useModelQuery: any }
    • BettyPrefabs: typeof BettyPrefabs
    • PropertyKind: typeof PropertyKind
    • addActionVariable:function
      • addActionVariable(actionId: string, name: string, kind: ActionVariableKind, options: object): Promise<ActionVariable>
    • camelToSnakeCase:function
      • camelToSnakeCase(str: string): string
    • cloneStructure:function
    • createUuid:function
      • createUuid(): string
    • makeBettyInput:function
      • makeBettyInput(prefabName: string, model: Model, property: Property, variable: ActionVariable, relatedIdProperties?: Record<string, string>, relatedModelIds?: Record<string, string>): PrefabReference
      • Parameters

        • prefabName: string
        • model: Model
        • property: Property
        • variable: ActionVariable
        • Optional relatedIdProperties: Record<string, string>
        • Optional relatedModelIds: Record<string, string>

        Returns PrefabReference

    • makeBettyUpdateInput:function
      • makeBettyUpdateInput(prefabName: string, model: Model, property: Property, variable: ActionVariable, relatedIdProperties?: Record<string, string>, relatedModelIds?: Record<string, string>): PrefabReference
      • Parameters

        • prefabName: string
        • model: Model
        • property: Property
        • variable: ActionVariable
        • Optional relatedIdProperties: Record<string, string>
        • Optional relatedModelIds: Record<string, string>

        Returns PrefabReference

    • prepareAction:function
      • prepareAction(componentId: string, idProperty: Property, properties: Property[], actionTemplate: "create" | "update" | "delete" | "login" | "empty", authenticationProfile?: AuthenticationProfile): Promise<PreparedAction>
      • Parameters

        • componentId: string
        • idProperty: Property
        • properties: Property[]
        • actionTemplate: "create" | "update" | "delete" | "login" | "empty"
        • Optional authenticationProfile: AuthenticationProfile

        Returns Promise<PreparedAction>

    • setOption:function
    • useCurrentPageId:function
      • useCurrentPageId(): string
    • useCurrentPartialId:function
      • useCurrentPartialId(): string
    • useModelQuery:function
      • useModelQuery(options: Record<string, any>): { data: Record<string, any> | null; error: Record<string, any> | null; loading: boolean }
      • Parameters

        • options: Record<string, any>

        Returns { data: Record<string, any> | null; error: Record<string, any> | null; loading: boolean }

        • data: Record<string, any> | null
        • error: Record<string, any> | null
        • loading: boolean
  • prefab: Prefab
  • prefabs: Prefab[]
  • close:function
    • close(): void
  • save:function
Configuration: VariableConfiguration | ButtonGroupConfiguration | DropdownConfiguration
Hook: { input: Record<string, Ref>; output?: {}; query: string }

Type declaration

  • input: Record<string, Ref>
  • Optional output?: {}
    • [key: string]: Ref
  • query: string
LinkedOptionProducer: (key: string) => PrefabWrapperLinkedOption

Type declaration

LinkedPartialOptionProducer: (key: string) => PrefabWrapperLinkedPartialOption

Type declaration

OptionCategory: { condition?: { comparator: string; option: string; type: string; value: string | boolean | number }; expanded?: boolean; label: string; members: string[] }

Type declaration

  • Optional condition?: { comparator: string; option: string; type: string; value: string | boolean | number }
    • comparator: string
    • option: string
    • type: string
    • value: string | boolean | number
  • Optional expanded?: boolean
  • label: string
  • members: string[]
OptionProducer: (key: string) => PrefabComponentOption

Type declaration

PrefabComponentOption: ValueDefault | ValueRef
PrefabComponentStyle: { name?: string; overwrite?: { backgroundColor?: { type: string; value: string }; borderColor?: { type: string; value: string }; borderRadius?: string | string[]; borderStyle?: string; borderWidth?: string | string[]; boxShadow?: string; color?: { type: string; value: string }; fontFamily?: string; fontSize?: string; fontStyle?: string; fontWeight?: string; letterSpacing?: string; lineHeight?: string; padding?: string | string[]; textDecoration?: string; textTransform?: string } }

Type declaration

  • Optional name?: string
  • Optional overwrite?: { backgroundColor?: { type: string; value: string }; borderColor?: { type: string; value: string }; borderRadius?: string | string[]; borderStyle?: string; borderWidth?: string | string[]; boxShadow?: string; color?: { type: string; value: string }; fontFamily?: string; fontSize?: string; fontStyle?: string; fontWeight?: string; letterSpacing?: string; lineHeight?: string; padding?: string | string[]; textDecoration?: string; textTransform?: string }
    • Optional backgroundColor?: { type: string; value: string }
      • type: string
      • value: string
    • Optional borderColor?: { type: string; value: string }
      • type: string
      • value: string
    • Optional borderRadius?: string | string[]
    • Optional borderStyle?: string
    • Optional borderWidth?: string | string[]
    • Optional boxShadow?: string
    • Optional color?: { type: string; value: string }
      • type: string
      • value: string
    • Optional fontFamily?: string
    • Optional fontSize?: string
    • Optional fontStyle?: string
    • Optional fontWeight?: string
    • Optional letterSpacing?: string
    • Optional lineHeight?: string
    • Optional padding?: string | string[]
    • Optional textDecoration?: string
    • Optional textTransform?: string
PrefabVariableKind: "construct" | "object" | "string" | "integer"
PrefabWrapperLinkedOptionConfiguration: { allowedInput?: { name: string; value: string | boolean | number }[]; as?: string; condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean | number }; dataType?: string }

Type declaration

  • Optional allowedInput?: { name: string; value: string | boolean | number }[]
  • Optional as?: string
  • Optional condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean | number }
    • comparator: "EQ"
    • option: string
    • type: "SHOW" | "HIDE"
    • value: string | boolean | number
  • Optional dataType?: string
StyleProducer: (key: string) => PrefabComponentStyle

Type declaration

ValueConfig: Record<string, unknown>

Functions

  • action(label: string, attrs: Attributes): OptionProducer
  • actionInputObjects(label: string, attrs: Attributes): OptionProducer
  • authenticationProfile(label: string, attrs: Attributes): OptionProducer
  • buttongroup(label: string, options: [string, string][], attrs?: Attributes): OptionProducer
  • childSelector(label: string, attrs?: Attributes): OptionProducer
  • dropdown(label: string, options: [string, string][], attrs?: Attributes): OptionProducer
  • endpoint(label: string, attrs?: Attributes): OptionProducer
  • filter(label: string, attrs?: Attributes): OptionProducer
  • font(label: string, attrs: Attributes): OptionProducer
  • hideIf(key: string, comparator: "EQ", value: string | boolean): undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
  • icon(label: string, attrs?: Attributes): OptionProducer
  • model(label: string, attrs?: Attributes): OptionProducer
  • modelAndRelation(label: string, attrs?: Attributes): OptionProducer
  • number(label: string, attrs?: Attributes): OptionProducer
  • option(type: string, attrs: Attributes): OptionProducer
  • prefab(name: string, attr: Attributes, beforeCreate: undefined | BeforeCreate, structure: PrefabReference[]): Prefab
  • property(label: string, attrs?: Attributes): OptionProducer
  • reconfigure(label: string, attrs?: Attributes): OptionProducer
  • showIf(key: string, comparator: "EQ", value: string | boolean): undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
  • showIfTrue(key: string): undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
  • size(label: string, attrs: Attributes): OptionProducer
  • sizes(label: string, attrs: Attributes): OptionProducer
  • text(label: string, attrs?: Attributes): OptionProducer
  • toggle(label: string, attrs?: Attributes): OptionProducer
  • variable(label: string, attrs?: Attributes): OptionProducer
  • prefab(name: string, attr: Attributes, beforeCreate: undefined | BeforeCreate, structure: PrefabReference[]): Prefab
  • property(label: string, attrs?: Attributes): OptionProducer
  • reconfigure(label: string, attrs?: Attributes): OptionProducer
  • showIf(key: string, comparator: "EQ", value: string | boolean): undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
  • showIfTrue(key: string): undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
  • size(label: string, attrs: Attributes): OptionProducer
  • sizes(label: string, attrs: Attributes): OptionProducer
  • text(label: string, attrs?: Attributes): OptionProducer
  • toggle(label: string, attrs?: Attributes): OptionProducer
  • variable(label: string, attrs?: Attributes): OptionProducer

Generated using TypeDoc

\ No newline at end of file