diff --git a/docs/enums/ActionVariableKind.html b/docs/enums/ActionVariableKind.html index 86325203..7fb5fcd9 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/AllowedStateKeys.html b/docs/enums/AllowedStateKeys.html index b87175d6..b2b608ef 100644 --- a/docs/enums/AllowedStateKeys.html +++ b/docs/enums/AllowedStateKeys.html @@ -1 +1 @@ -AllowedStateKeys | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration members

DISABLED = "disabled"
FOCUS = "focus"
HOVER = "hover"
INVALID = "invalid"
READONLY = "readOnly"
SELECTED = "selected"
VALID = "valid"

Generated using TypeDoc

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

Index

Enumeration members

DISABLED = "disabled"
FOCUS = "focus"
HOVER = "hover"
INVALID = "invalid"
READONLY = "readOnly"
SELECTED = "selected"
VALID = "valid"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Icon.html b/docs/enums/Icon.html index dcbd1112..e29d1a42 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"
FilterIcon = "FilterIcon"
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"
RichTextEditorIcon = "RichTextEditorIcon"
RowColumnIcon = "RowColumnIcon"
RowIcon = "RowIcon"
SelectIcon = "SelectIcon"
SidebarLeftIcon = "SidebarLeftIcon"
SliderComponentIcon = "SliderComponentIcon"
SnackbarIcon = "SnackbarIcon"
StepIcon = "StepIcon"
StepperIcon = "StepperIcon"
SubViewIcon = "SubViewIcon"
SubViewItemIcon = "SubViewItemIcon"
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"
FilterIcon = "FilterIcon"
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"
RichTextEditorIcon = "RichTextEditorIcon"
RowColumnIcon = "RowColumnIcon"
RowIcon = "RowIcon"
SelectIcon = "SelectIcon"
SidebarLeftIcon = "SidebarLeftIcon"
SliderComponentIcon = "SliderComponentIcon"
SnackbarIcon = "SnackbarIcon"
StepIcon = "StepIcon"
StepperIcon = "StepperIcon"
SubViewIcon = "SubViewIcon"
SubViewItemIcon = "SubViewItemIcon"
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 57cda67f..5b2b54de 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 2dd438cb..b8065b49 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 cd703e3e..63ba0e63 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 c1c51e59..0458db53 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"
INHERITED = "[Inherited]"
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"
INHERITED = "[Inherited]"
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 d87939d3..985da52d 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 abf3d63c..2e7b76a2 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 46c3bc8f..c03eedba 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/BuildStyleDefinition.html b/docs/interfaces/BuildStyleDefinition.html index 0e9eee7d..c074f51e 100644 --- a/docs/interfaces/BuildStyleDefinition.html +++ b/docs/interfaces/BuildStyleDefinition.html @@ -1 +1 @@ -BuildStyleDefinition | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Properties

name: string
type: string

Generated using TypeDoc

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

Hierarchy

Index

Properties

Properties

name: string
type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Interaction.html b/docs/interfaces/Interaction.html index babed3cb..a8f1c992 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 b0fe1602..ea503933 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 c2a2a752..7e0fef00 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 e4c287e1..281be0ed 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 8dfc76fb..e7d5c7d3 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 634f25ef..466ec9f0 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 27a262d6..c3ab8839 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 4f375130..cf9bbb47 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 876feb9a..e7d5ad0c 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 098098b2..4002c8a3 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 1ba148bc..5d025bb2 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 05fc230a..8de10a28 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 4dc4142d..534743e4 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 3d28c604..f47381df 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 ed1d182f..dacf3f24 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?: { afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }; allowManageValues?: string; allowRelations?: boolean; allowedExtensions?: string[]; allowedInput?: { name: string; value: string | number | boolean }[]; allowedTypes?: string[]; apiVersion?: string; as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"; component?: string; condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }; dataType?: string; dependsOn?: string; disabled?: boolean; mediaType?: "IMAGE" | "VIDEO"; modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }; placeholder?: string; showOnDrop?: boolean }

Type declaration

  • Optional afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }
    • Optional createNewProperty?: { dependsOn: string; type: string; value: string }[]
  • Optional allowManageValues?: string
  • Optional allowRelations?: boolean
  • Optional allowedExtensions?: string[]
  • Optional allowedInput?: { name: string; value: string | number | boolean }[]
  • Optional allowedTypes?: string[]
  • Optional apiVersion?: string
  • Optional as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"
  • Optional component?: string
  • Optional condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }
    • comparator: "EQ"
    • option: string
    • type: "SHOW" | "HIDE"
    • value: string | number | boolean
  • Optional dataType?: string
  • Optional dependsOn?: string
  • Optional disabled?: boolean
  • Optional mediaType?: "IMAGE" | "VIDEO"
  • Optional modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }
    • generateCustomModel: boolean
    • modelRequired: boolean
    • type: "MODEL_AND_PROPERTIES"
  • Optional placeholder?: string
  • Optional showOnDrop?: boolean
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?: { afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }; allowManageValues?: string; allowRelations?: boolean; allowedExtensions?: string[]; allowedInput?: { name: string; value: string | number | boolean }[]; allowedTypes?: string[]; apiVersion?: string; as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"; component?: string; condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }; dataType?: string; dependsOn?: string; disabled?: boolean; mediaType?: "IMAGE" | "VIDEO"; modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }; placeholder?: string; showOnDrop?: boolean }

Type declaration

  • Optional afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }
    • Optional createNewProperty?: { dependsOn: string; type: string; value: string }[]
  • Optional allowManageValues?: string
  • Optional allowRelations?: boolean
  • Optional allowedExtensions?: string[]
  • Optional allowedInput?: { name: string; value: string | number | boolean }[]
  • Optional allowedTypes?: string[]
  • Optional apiVersion?: string
  • Optional as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"
  • Optional component?: string
  • Optional condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }
    • comparator: "EQ"
    • option: string
    • type: "SHOW" | "HIDE"
    • value: string | number | boolean
  • Optional dataType?: string
  • Optional dependsOn?: string
  • Optional disabled?: boolean
  • Optional mediaType?: "IMAGE" | "VIDEO"
  • Optional modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }
    • generateCustomModel: boolean
    • modelRequired: boolean
    • type: "MODEL_AND_PROPERTIES"
  • Optional placeholder?: string
  • Optional showOnDrop?: boolean
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 3079c538..cb19415a 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 3e707a9f..aa845c63 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 74b0f176..1309a83e 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 22fa1b33..a92a1834 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

partialId: string
ref?: { id: string }

Type declaration

  • id: 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

partialId: string
ref?: { id: string }

Type declaration

  • id: 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 5c9e7164..8ce40c24 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 5e573f9f..1f6d39ec 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 419c6990..a4716b41 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
showInAddChild?: boolean
showInReconfigure?: boolean
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
showInAddChild?: boolean
showInReconfigure?: boolean
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 873ea17f..4f8b6eb5 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
showInAddChild?: boolean
showInReconfigure?: boolean
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
showInAddChild?: boolean
showInReconfigure?: boolean
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/StaticValue.html b/docs/interfaces/StaticValue.html index 18cb4331..4c540ed2 100644 --- a/docs/interfaces/StaticValue.html +++ b/docs/interfaces/StaticValue.html @@ -1 +1 @@ -StaticValue | @betty-blocks/component-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • StaticValue

Index

Properties

Properties

type: "STATIC"
value: string

Generated using TypeDoc

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

Hierarchy

  • StaticValue

Index

Properties

Properties

type: "STATIC"
value: string

Generated using TypeDoc

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

Hierarchy

  • StyleDefinition

Index

Properties

name: string
type: string

Generated using TypeDoc

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

Hierarchy

  • StyleDefinition

Index

Properties

name: string
type: string

Generated using TypeDoc

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

Interface StyleDefinitionContentObject

Hierarchy

  • StyleDefinitionContentObject

Index

Properties

backgroundColor?: RefOrValue
borderColor?: RefOrValue
borderRadius?: string[]
borderStyle?: string
borderWidth?: string[]
boxShadow?: string
color?: RefOrValue
fontFamily?: string
fontSize?: string
fontStyle?: string
fontWeight?: string
letterSpacing?: string
lineHeight?: string
padding?: string[]
textDecoration?: string
textTransform?: string

Generated using TypeDoc

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

Interface StyleDefinitionContentObject

Hierarchy

  • StyleDefinitionContentObject

Index

Properties

backgroundColor?: RefOrValue
borderColor?: RefOrValue
borderRadius?: string[]
borderStyle?: string
borderWidth?: string[]
boxShadow?: string
color?: RefOrValue
fontFamily?: string
fontSize?: string
fontStyle?: string
fontWeight?: string
letterSpacing?: string
lineHeight?: string
padding?: string[]
textDecoration?: string
textTransform?: string

Generated using TypeDoc

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

Hierarchy

  • StyleDefinitionState

Index

Properties

Properties

name: string

Generated using TypeDoc

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

Hierarchy

  • StyleDefinitionState

Index

Properties

Properties

name: string

Generated using TypeDoc

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

Hierarchy

  • StyleReference

Index

Properties

Properties

name: string
overwrite?: StyleDefinitionState[]

Generated using TypeDoc

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

Hierarchy

  • StyleReference

Index

Properties

Properties

name: string
overwrite?: StyleDefinitionState[]

Generated using TypeDoc

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

Hierarchy

  • ThemeColorReference

Index

Properties

Properties

type: "THEME_COLOR"
value: string

Generated using TypeDoc

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

Hierarchy

  • ThemeColorReference

Index

Properties

Properties

type: "THEME_COLOR"
value: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ValueDefault.html b/docs/interfaces/ValueDefault.html index 7c573231..f09822ef 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?: { afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }; allowManageValues?: string; allowRelations?: boolean; allowedExtensions?: string[]; allowedInput?: { name: string; value: string | number | boolean }[]; allowedTypes?: string[]; apiVersion?: string; as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"; component?: string; condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }; dataType?: string; dependsOn?: string; disabled?: boolean; mediaType?: "IMAGE" | "VIDEO"; modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }; placeholder?: string; showOnDrop?: boolean }

Type declaration

  • Optional afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }
    • Optional createNewProperty?: { dependsOn: string; type: string; value: string }[]
  • Optional allowManageValues?: string
  • Optional allowRelations?: boolean
  • Optional allowedExtensions?: string[]
  • Optional allowedInput?: { name: string; value: string | number | boolean }[]
  • Optional allowedTypes?: string[]
  • Optional apiVersion?: string
  • Optional as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"
  • Optional component?: string
  • Optional condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }
    • comparator: "EQ"
    • option: string
    • type: "SHOW" | "HIDE"
    • value: string | number | boolean
  • Optional dataType?: string
  • Optional dependsOn?: string
  • Optional disabled?: boolean
  • Optional mediaType?: "IMAGE" | "VIDEO"
  • Optional modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }
    • generateCustomModel: boolean
    • modelRequired: boolean
    • type: "MODEL_AND_PROPERTIES"
  • Optional placeholder?: string
  • Optional showOnDrop?: boolean
key: string
label: string
ref?: { id?: string }

Type declaration

  • Optional id?: string
showInAddChild?: boolean
showInReconfigure?: boolean
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?: { afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }; allowManageValues?: string; allowRelations?: boolean; allowedExtensions?: string[]; allowedInput?: { name: string; value: string | number | boolean }[]; allowedTypes?: string[]; apiVersion?: string; as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"; component?: string; condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }; dataType?: string; dependsOn?: string; disabled?: boolean; mediaType?: "IMAGE" | "VIDEO"; modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }; placeholder?: string; showOnDrop?: boolean }

Type declaration

  • Optional afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }
    • Optional createNewProperty?: { dependsOn: string; type: string; value: string }[]
  • Optional allowManageValues?: string
  • Optional allowRelations?: boolean
  • Optional allowedExtensions?: string[]
  • Optional allowedInput?: { name: string; value: string | number | boolean }[]
  • Optional allowedTypes?: string[]
  • Optional apiVersion?: string
  • Optional as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"
  • Optional component?: string
  • Optional condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }
    • comparator: "EQ"
    • option: string
    • type: "SHOW" | "HIDE"
    • value: string | number | boolean
  • Optional dataType?: string
  • Optional dependsOn?: string
  • Optional disabled?: boolean
  • Optional mediaType?: "IMAGE" | "VIDEO"
  • Optional modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }
    • generateCustomModel: boolean
    • modelRequired: boolean
    • type: "MODEL_AND_PROPERTIES"
  • Optional placeholder?: string
  • Optional showOnDrop?: boolean
key: string
label: string
ref?: { id?: string }

Type declaration

  • Optional id?: string
showInAddChild?: boolean
showInReconfigure?: boolean
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 6ef7d424..6cafc727 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?: { afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }; allowManageValues?: string; allowRelations?: boolean; allowedExtensions?: string[]; allowedInput?: { name: string; value: string | number | boolean }[]; allowedTypes?: string[]; apiVersion?: string; as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"; component?: string; condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }; dataType?: string; dependsOn?: string; disabled?: boolean; mediaType?: "IMAGE" | "VIDEO"; modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }; placeholder?: string; showOnDrop?: boolean }

Type declaration

  • Optional afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }
    • Optional createNewProperty?: { dependsOn: string; type: string; value: string }[]
  • Optional allowManageValues?: string
  • Optional allowRelations?: boolean
  • Optional allowedExtensions?: string[]
  • Optional allowedInput?: { name: string; value: string | number | boolean }[]
  • Optional allowedTypes?: string[]
  • Optional apiVersion?: string
  • Optional as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"
  • Optional component?: string
  • Optional condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }
    • comparator: "EQ"
    • option: string
    • type: "SHOW" | "HIDE"
    • value: string | number | boolean
  • Optional dataType?: string
  • Optional dependsOn?: string
  • Optional disabled?: boolean
  • Optional mediaType?: "IMAGE" | "VIDEO"
  • Optional modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }
    • generateCustomModel: boolean
    • modelRequired: boolean
    • type: "MODEL_AND_PROPERTIES"
  • Optional placeholder?: string
  • Optional showOnDrop?: boolean
key: string
label: string
ref: { id?: string; value: string | string[] }

Type declaration

  • Optional id?: string
  • value: string | string[]
showInAddChild?: boolean
showInReconfigure?: boolean
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?: { afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }; allowManageValues?: string; allowRelations?: boolean; allowedExtensions?: string[]; allowedInput?: { name: string; value: string | number | boolean }[]; allowedTypes?: string[]; apiVersion?: string; as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"; component?: string; condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }; dataType?: string; dependsOn?: string; disabled?: boolean; mediaType?: "IMAGE" | "VIDEO"; modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }; placeholder?: string; showOnDrop?: boolean }

Type declaration

  • Optional afterCreate?: { createNewProperty?: { dependsOn: string; type: string; value: string }[] }
    • Optional createNewProperty?: { dependsOn: string; type: string; value: string }[]
  • Optional allowManageValues?: string
  • Optional allowRelations?: boolean
  • Optional allowedExtensions?: string[]
  • Optional allowedInput?: { name: string; value: string | number | boolean }[]
  • Optional allowedTypes?: string[]
  • Optional apiVersion?: string
  • Optional as?: "BUTTONGROUP" | "DROPDOWN" | "MULTILINE" | "UNIT" | "VISIBILITY"
  • Optional component?: string
  • Optional condition?: { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | number | boolean }
    • comparator: "EQ"
    • option: string
    • type: "SHOW" | "HIDE"
    • value: string | number | boolean
  • Optional dataType?: string
  • Optional dependsOn?: string
  • Optional disabled?: boolean
  • Optional mediaType?: "IMAGE" | "VIDEO"
  • Optional modal?: { generateCustomModel: boolean; modelRequired: boolean; type: "MODEL_AND_PROPERTIES" }
    • generateCustomModel: boolean
    • modelRequired: boolean
    • type: "MODEL_AND_PROPERTIES"
  • Optional placeholder?: string
  • Optional showOnDrop?: boolean
key: string
label: string
ref: { id?: string; value: string | string[] }

Type declaration

  • Optional id?: string
  • value: string | string[]
showInAddChild?: boolean
showInReconfigure?: boolean
type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 69232ae6..0f488f32 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

Enumerations

Interfaces

Type aliases

Functions

Type aliases

BeforeCreateArgs: { components: {}; helpers: { BettyPrefabs: typeof BettyPrefabs; PropertyKind: typeof PropertyKind; addActionVariable: any; camelToSnakeCase: any; cloneStructure: any; createBlacklist: any; createUuid: any; getPageAuthenticationProfileId: any; getPageName: any; makeBettyInput: any; makeBettyUpdateInput: any; prepareAction: any; prepareInput: any; setOption: any; useActionIdSelector: any; useCurrentPageId: any; useCurrentPartialId: any; useModelIdSelector: any; useModelQuery: any; useModelRelationQuery: any; usePrefabSelector: any; usePropertyQuery: any }; modelId: string; 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; createBlacklist: any; createUuid: any; getPageAuthenticationProfileId: any; getPageName: any; makeBettyInput: any; makeBettyUpdateInput: any; prepareAction: any; prepareInput: any; setOption: any; useActionIdSelector: any; useCurrentPageId: any; useCurrentPartialId: any; useModelIdSelector: any; useModelQuery: any; useModelRelationQuery: any; usePrefabSelector: any; usePropertyQuery: 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
    • createBlacklist:function
      • createBlacklist(whiteList: ("AUTO_INCREMENT" | "BELONGS_TO" | "BOOLEAN" | "BOOLEAN_EXPRESSION" | "COUNT" | "DATE" | "DATE_EXPRESSION" | "DATE_TIME" | "DATE_TIME_EXPRESSION" | "DECIMAL" | "DECIMAL_EXPRESSION" | "EMAIL" | "EMAIL_ADDRESS" | "ENUM" | "FILE" | "FLOAT" | "GOOGLE_DOCUMENT" | "HAS_AND_BELONGS_TO_MANY" | "HAS_MANY" | "HAS_ONE" | "IBAN" | "IMAGE" | "INTEGER" | "INTEGER_EXPRESSION" | "LIST" | "LOGIN_TOKEN" | "MINUTES" | "MINUTES_EXPRESSION" | "MULTI_FILE" | "MULTI_IMAGE" | "PASSWORD" | "PDF" | "PERIODIC_COUNT" | "PHONE_NUMBER" | "PRICE" | "PRICE_EXPRESSION" | "RICH_TEXT" | "SERIAL" | "SIGNED_PDF" | "STRING" | "STRING_EXPRESSION" | "SUM" | "TEXT" | "TEXT_EXPRESSION" | "TIME" | "URL" | "ZIPCODE")[]): ("AUTO_INCREMENT" | "BELONGS_TO" | "BOOLEAN" | "BOOLEAN_EXPRESSION" | "COUNT" | "DATE" | "DATE_EXPRESSION" | "DATE_TIME" | "DATE_TIME_EXPRESSION" | "DECIMAL" | "DECIMAL_EXPRESSION" | "EMAIL" | "EMAIL_ADDRESS" | "ENUM" | "FILE" | "FLOAT" | "GOOGLE_DOCUMENT" | "HAS_AND_BELONGS_TO_MANY" | "HAS_MANY" | "HAS_ONE" | "IBAN" | "IMAGE" | "INTEGER" | "INTEGER_EXPRESSION" | "LIST" | "LOGIN_TOKEN" | "MINUTES" | "MINUTES_EXPRESSION" | "MULTI_FILE" | "MULTI_IMAGE" | "PASSWORD" | "PDF" | "PERIODIC_COUNT" | "PHONE_NUMBER" | "PRICE" | "PRICE_EXPRESSION" | "RICH_TEXT" | "SERIAL" | "SIGNED_PDF" | "STRING" | "STRING_EXPRESSION" | "SUM" | "TEXT" | "TEXT_EXPRESSION" | "TIME" | "URL" | "ZIPCODE")[]
      • Parameters

        • whiteList: ("AUTO_INCREMENT" | "BELONGS_TO" | "BOOLEAN" | "BOOLEAN_EXPRESSION" | "COUNT" | "DATE" | "DATE_EXPRESSION" | "DATE_TIME" | "DATE_TIME_EXPRESSION" | "DECIMAL" | "DECIMAL_EXPRESSION" | "EMAIL" | "EMAIL_ADDRESS" | "ENUM" | "FILE" | "FLOAT" | "GOOGLE_DOCUMENT" | "HAS_AND_BELONGS_TO_MANY" | "HAS_MANY" | "HAS_ONE" | "IBAN" | "IMAGE" | "INTEGER" | "INTEGER_EXPRESSION" | "LIST" | "LOGIN_TOKEN" | "MINUTES" | "MINUTES_EXPRESSION" | "MULTI_FILE" | "MULTI_IMAGE" | "PASSWORD" | "PDF" | "PERIODIC_COUNT" | "PHONE_NUMBER" | "PRICE" | "PRICE_EXPRESSION" | "RICH_TEXT" | "SERIAL" | "SIGNED_PDF" | "STRING" | "STRING_EXPRESSION" | "SUM" | "TEXT" | "TEXT_EXPRESSION" | "TIME" | "URL" | "ZIPCODE")[]

        Returns ("AUTO_INCREMENT" | "BELONGS_TO" | "BOOLEAN" | "BOOLEAN_EXPRESSION" | "COUNT" | "DATE" | "DATE_EXPRESSION" | "DATE_TIME" | "DATE_TIME_EXPRESSION" | "DECIMAL" | "DECIMAL_EXPRESSION" | "EMAIL" | "EMAIL_ADDRESS" | "ENUM" | "FILE" | "FLOAT" | "GOOGLE_DOCUMENT" | "HAS_AND_BELONGS_TO_MANY" | "HAS_MANY" | "HAS_ONE" | "IBAN" | "IMAGE" | "INTEGER" | "INTEGER_EXPRESSION" | "LIST" | "LOGIN_TOKEN" | "MINUTES" | "MINUTES_EXPRESSION" | "MULTI_FILE" | "MULTI_IMAGE" | "PASSWORD" | "PDF" | "PERIODIC_COUNT" | "PHONE_NUMBER" | "PRICE" | "PRICE_EXPRESSION" | "RICH_TEXT" | "SERIAL" | "SIGNED_PDF" | "STRING" | "STRING_EXPRESSION" | "SUM" | "TEXT" | "TEXT_EXPRESSION" | "TIME" | "URL" | "ZIPCODE")[]

    • createUuid:function
      • createUuid(): string
    • getPageAuthenticationProfileId:function
      • getPageAuthenticationProfileId(): string
    • getPageName:function
      • getPageName(): 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, actionName?: string, permissions?: "public" | "private" | "inherit", getPageAuthenticationProfileId?: string, pageName?: string): Promise<PreparedAction>
      • Parameters

        • componentId: string
        • idProperty: Property
        • properties: Property[]
        • actionTemplate: "create" | "update" | "delete" | "login" | "empty"
        • Optional authenticationProfile: AuthenticationProfile
        • Optional actionName: string
        • Optional permissions: "public" | "private" | "inherit"
        • Optional getPageAuthenticationProfileId: string
        • Optional pageName: string

        Returns Promise<PreparedAction>

    • prepareInput:function
      • prepareInput(actionId: null | string, variableName: undefined | string, kind: "AUTO_INCREMENT" | "BELONGS_TO" | "BOOLEAN" | "BOOLEAN_EXPRESSION" | "COUNT" | "DATE" | "DATE_EXPRESSION" | "DATE_TIME" | "DATE_TIME_EXPRESSION" | "DECIMAL" | "DECIMAL_EXPRESSION" | "EMAIL" | "EMAIL_ADDRESS" | "ENUM" | "FILE" | "FLOAT" | "GOOGLE_DOCUMENT" | "HAS_AND_BELONGS_TO_MANY" | "HAS_MANY" | "HAS_ONE" | "IBAN" | "IMAGE" | "INTEGER" | "INTEGER_EXPRESSION" | "LIST" | "LOGIN_TOKEN" | "MINUTES" | "MINUTES_EXPRESSION" | "MULTI_FILE" | "MULTI_IMAGE" | "PASSWORD" | "PDF" | "PERIODIC_COUNT" | "PHONE_NUMBER" | "PRICE" | "PRICE_EXPRESSION" | "RICH_TEXT" | "SERIAL" | "SIGNED_PDF" | "STRING" | "STRING_EXPRESSION" | "SUM" | "TEXT" | "TEXT_EXPRESSION" | "TIME" | "URL" | "ZIPCODE", propertyKind: "AUTO_INCREMENT" | "BELONGS_TO" | "BOOLEAN" | "BOOLEAN_EXPRESSION" | "COUNT" | "DATE" | "DATE_EXPRESSION" | "DATE_TIME" | "DATE_TIME_EXPRESSION" | "DECIMAL" | "DECIMAL_EXPRESSION" | "EMAIL" | "EMAIL_ADDRESS" | "ENUM" | "FILE" | "FLOAT" | "GOOGLE_DOCUMENT" | "HAS_AND_BELONGS_TO_MANY" | "HAS_MANY" | "HAS_ONE" | "IBAN" | "IMAGE" | "INTEGER" | "INTEGER_EXPRESSION" | "LIST" | "LOGIN_TOKEN" | "MINUTES" | "MINUTES_EXPRESSION" | "MULTI_FILE" | "MULTI_IMAGE" | "PASSWORD" | "PDF" | "PERIODIC_COUNT" | "PHONE_NUMBER" | "PRICE" | "PRICE_EXPRESSION" | "RICH_TEXT" | "SERIAL" | "SIGNED_PDF" | "STRING" | "STRING_EXPRESSION" | "SUM" | "TEXT" | "TEXT_EXPRESSION" | "TIME" | "URL" | "ZIPCODE", permissions?: "public" | "private" | "inherit", getPageAuthenticationProfileId?: string): Promise<PreparedInput>
      • Parameters

        • actionId: null | string
        • variableName: undefined | string
        • kind: "AUTO_INCREMENT" | "BELONGS_TO" | "BOOLEAN" | "BOOLEAN_EXPRESSION" | "COUNT" | "DATE" | "DATE_EXPRESSION" | "DATE_TIME" | "DATE_TIME_EXPRESSION" | "DECIMAL" | "DECIMAL_EXPRESSION" | "EMAIL" | "EMAIL_ADDRESS" | "ENUM" | "FILE" | "FLOAT" | "GOOGLE_DOCUMENT" | "HAS_AND_BELONGS_TO_MANY" | "HAS_MANY" | "HAS_ONE" | "IBAN" | "IMAGE" | "INTEGER" | "INTEGER_EXPRESSION" | "LIST" | "LOGIN_TOKEN" | "MINUTES" | "MINUTES_EXPRESSION" | "MULTI_FILE" | "MULTI_IMAGE" | "PASSWORD" | "PDF" | "PERIODIC_COUNT" | "PHONE_NUMBER" | "PRICE" | "PRICE_EXPRESSION" | "RICH_TEXT" | "SERIAL" | "SIGNED_PDF" | "STRING" | "STRING_EXPRESSION" | "SUM" | "TEXT" | "TEXT_EXPRESSION" | "TIME" | "URL" | "ZIPCODE"
        • propertyKind: "AUTO_INCREMENT" | "BELONGS_TO" | "BOOLEAN" | "BOOLEAN_EXPRESSION" | "COUNT" | "DATE" | "DATE_EXPRESSION" | "DATE_TIME" | "DATE_TIME_EXPRESSION" | "DECIMAL" | "DECIMAL_EXPRESSION" | "EMAIL" | "EMAIL_ADDRESS" | "ENUM" | "FILE" | "FLOAT" | "GOOGLE_DOCUMENT" | "HAS_AND_BELONGS_TO_MANY" | "HAS_MANY" | "HAS_ONE" | "IBAN" | "IMAGE" | "INTEGER" | "INTEGER_EXPRESSION" | "LIST" | "LOGIN_TOKEN" | "MINUTES" | "MINUTES_EXPRESSION" | "MULTI_FILE" | "MULTI_IMAGE" | "PASSWORD" | "PDF" | "PERIODIC_COUNT" | "PHONE_NUMBER" | "PRICE" | "PRICE_EXPRESSION" | "RICH_TEXT" | "SERIAL" | "SIGNED_PDF" | "STRING" | "STRING_EXPRESSION" | "SUM" | "TEXT" | "TEXT_EXPRESSION" | "TIME" | "URL" | "ZIPCODE"
        • Optional permissions: "public" | "private" | "inherit"
        • Optional getPageAuthenticationProfileId: string

        Returns Promise<PreparedInput>

    • setOption:function
    • useActionIdSelector:function
      • useActionIdSelector(): null | string
    • useCurrentPageId:function
      • useCurrentPageId(): string
    • useCurrentPartialId:function
      • useCurrentPartialId(): string
    • useModelIdSelector:function
      • useModelIdSelector(): null | 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
    • useModelRelationQuery:function
      • useModelRelationQuery(propertyModelId: string): { data: Record<string, any> | null; error: Record<string, any> | null; loading: boolean }
      • Parameters

        • propertyModelId: string

        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
    • usePrefabSelector:function
      • usePrefabSelector(): null | { id: string; name: string }
    • usePropertyQuery:function
      • usePropertyQuery(propertyId: string): { data: Record<string, any> | null; error: Record<string, any> | null; loading: boolean }
      • Parameters

        • propertyId: string

        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
  • modelId: string
  • 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 } | StyleDefinitionState[] }

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 } | StyleDefinitionState[]
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
StyleDefinitionContent: Partial<StyleDefinitionContentBase> & Pick<StyleDefinitionContentBase, "basis">
StyleDefinitionContentBase: { [ key in StyleStateKeys | "basis"]: StyleDefinitionContentObject }
StyleProducer: (key: string) => PrefabComponentStyle

Type declaration

StyleStateKeys: SELECTED | HOVER | FOCUS | DISABLED | VALID | INVALID | READONLY
ValueConfig: Record<string, unknown>

Functions

  • action(label: string, attrs: Attributes): OptionProducer
  • actionInputObjects(label: string, attrs: Attributes): OptionProducer
  • addChild(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
  • displayLogic(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
  • style(type: string, __namedParameters: RequiredStyleAttrs): StyleDefinition
  • styleReference(name: string, attrs: StyleReferenceAttrs): StyleReference
  • 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
  • style(type: string, __namedParameters: RequiredStyleAttrs): StyleDefinition
  • styleReference(name: string, attrs: StyleReferenceAttrs): StyleReference
  • 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