From 8563309dcd5e6f23a00737a35e9d47547bc032cc Mon Sep 17 00:00:00 2001 From: SanderVanRiessen Date: Thu, 5 Jan 2023 08:46:07 +0000 Subject: [PATCH] ci: Updated docs [skip ci] --- docs/enums/ActionVariableKind.html | 2 +- docs/enums/AllowedStateKeys.html | 2 +- docs/enums/Icon.html | 2 +- docs/enums/InteractionOptionType.html | 2 +- docs/enums/InteractionOptionTypeToDo.html | 2 +- docs/enums/InteractionType.html | 2 +- docs/enums/ThemeColor.html | 2 +- docs/interfaces/AuthenticateUserStepOption.html | 2 +- docs/interfaces/BaseConfiguration.html | 2 +- docs/interfaces/BasePrefabInteraction.html | 2 +- docs/interfaces/BuildStyleDefinition.html | 2 +- docs/interfaces/Interaction.html | 2 +- docs/interfaces/InteractionCompatibility.html | 2 +- docs/interfaces/ParameterOptionWithComponentRef.html | 2 +- docs/interfaces/ParameterOptionWithId.html | 2 +- docs/interfaces/ParameterOptionWithPageId.html | 2 +- docs/interfaces/ParameterOptionWithPath.html | 2 +- docs/interfaces/Prefab.html | 2 +- docs/interfaces/PrefabAction.html | 2 +- docs/interfaces/PrefabActionAssign.html | 2 +- docs/interfaces/PrefabActionCreateStepOption.html | 2 +- docs/interfaces/PrefabActionDeleteStepOption.html | 2 +- docs/interfaces/PrefabActionStep.html | 2 +- docs/interfaces/PrefabActionUpdateStepOption.html | 2 +- docs/interfaces/PrefabComponent.html | 2 +- docs/interfaces/PrefabComponentOptionBase.html | 2 +- docs/interfaces/PrefabCustomInteraction.html | 2 +- docs/interfaces/PrefabGlobalInteraction.html | 2 +- docs/interfaces/PrefabLinkedOptionBase.html | 2 +- docs/interfaces/PrefabPartial.html | 2 +- docs/interfaces/PrefabVariable.html | 2 +- docs/interfaces/PrefabWrapper.html | 2 +- docs/interfaces/PrefabWrapperLinkedOption.html | 2 +- docs/interfaces/PrefabWrapperLinkedPartialOption.html | 2 +- docs/interfaces/StaticValue.html | 2 +- docs/interfaces/StyleDefinition.html | 2 +- docs/interfaces/StyleDefinitionContentObject.html | 2 +- docs/interfaces/StyleDefinitionState.html | 2 +- docs/interfaces/StyleReference.html | 2 +- docs/interfaces/ThemeColorReference.html | 2 +- docs/interfaces/ValueDefault.html | 2 +- docs/interfaces/ValueRef.html | 2 +- docs/modules.html | 6 +++--- 43 files changed, 45 insertions(+), 45 deletions(-) diff --git a/docs/enums/ActionVariableKind.html b/docs/enums/ActionVariableKind.html index 7b4351ef..b5a83866 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

Enumeration members

ARRAY

ARRAY = "ARRAY"

BOOLEAN

BOOLEAN = "BOOLEAN"

COLLECTION

COLLECTION = "COLLECTION"

DATE

DATE = "DATE"

DATE_TIME

DATE_TIME = "DATE_TIME"

DECIMAL

DECIMAL = "DECIMAL"

INTEGER

INTEGER = "INTEGER"

JSON

JSON = "JSON"

OBJECT

OBJECT = "OBJECT"

RECORD

RECORD = "RECORD"

STRING

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

Enumeration members

ARRAY

ARRAY = "ARRAY"

BOOLEAN

BOOLEAN = "BOOLEAN"

COLLECTION

COLLECTION = "COLLECTION"

DATE

DATE = "DATE"

DATE_TIME

DATE_TIME = "DATE_TIME"

DECIMAL

DECIMAL = "DECIMAL"

INTEGER

INTEGER = "INTEGER"

JSON

JSON = "JSON"

OBJECT

OBJECT = "OBJECT"

RECORD

RECORD = "RECORD"

STRING

STRING = "STRING"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/AllowedStateKeys.html b/docs/enums/AllowedStateKeys.html index 5e5ff386..d74eec96 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

Enumeration AllowedStateKeys

Index

Enumeration members

Enumeration members

DISABLED

DISABLED = "disabled"

FOCUS

FOCUS = "focus"

HOVER

HOVER = "hover"

INVALID

INVALID = "invalid"

READONLY

READONLY = "readOnly"

SELECTED

SELECTED = "selected"

VALID

VALID = "valid"

Generated using TypeDoc

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

Enumeration AllowedStateKeys

Index

Enumeration members

Enumeration members

DISABLED

DISABLED = "disabled"

FOCUS

FOCUS = "focus"

HOVER

HOVER = "hover"

INVALID

INVALID = "invalid"

READONLY

READONLY = "readOnly"

SELECTED

SELECTED = "selected"

VALID

VALID = "valid"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Icon.html b/docs/enums/Icon.html index ad3b133a..0f268984 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

Enumeration Icon

Index

Enumeration members

Enumeration members

AccordionIcon

AccordionIcon = "AccordionIcon"

AccordionItemIcon

AccordionItemIcon = "AccordionItemIcon"

AlertIcon

AlertIcon = "AlertIcon"

AutoCompleteIcon

AutoCompleteIcon = "AutoCompleteIcon"

AvatarIcon

AvatarIcon = "AvatarIcon"

BreadcrumbIcon

BreadcrumbIcon = "BreadcrumbIcon"

BreadcrumbItemIcon

BreadcrumbItemIcon = "BreadcrumbItemIcon"

ButtonGroupIcon

ButtonGroupIcon = "ButtonGroupIcon"

ButtonIcon

ButtonIcon = "ButtonIcon"

CardActionsIcon

CardActionsIcon = "CardActionsIcon"

CardContentIcon

CardContentIcon = "CardContentIcon"

CardHeaderIcon

CardHeaderIcon = "CardHeaderIcon"

CardIcon

CardIcon = "CardIcon"

CardMediaIcon

CardMediaIcon = "CardMediaIcon"

CheckboxGroupIcon

CheckboxGroupIcon = "CheckboxGroupIcon"

CheckboxIcon

CheckboxIcon = "CheckboxIcon"

ChipIcon

ChipIcon = "ChipIcon"

Column2Icon

Column2Icon = "Column2Icon"

Column3Icon

Column3Icon = "Column3Icon"

ColumnIcon

ColumnIcon = "ColumnIcon"

ConditionalIcon

ConditionalIcon = "ConditionalIcon"

ContainerIcon

ContainerIcon = "ContainerIcon"

CreateFormIcon

CreateFormIcon = "CreateFormIcon"

DataContainer

DataContainer = "DataContainer"

DataList

DataList = "DataList"

DataTable

DataTable = "DataTable"

DataTableBody

DataTableBody = "DataTableBody"

DataTableColumn

DataTableColumn = "DataTableColumn"

DataTableHead

DataTableHead = "DataTableHead"

DataTableRow

DataTableRow = "DataTableRow"

DatePickerIcon

DatePickerIcon = "DatePickerIcon"

DateTimePickerIcon

DateTimePickerIcon = "DateTimePickerIcon"

DecimalInputIcon

DecimalInputIcon = "DecimalInputIcon"

DefinitionListIcon

DefinitionListIcon = "DefinitionListIcon"

DeleteRecordIcon

DeleteRecordIcon = "DeleteRecordIcon"

DetailViewIcon

DetailViewIcon = "DetailViewIcon"

DialogIcon

DialogIcon = "DialogIcon"

DrawerIcon

DrawerIcon = "DrawerIcon"

DynamicFormIcon

DynamicFormIcon = "DynamicFormIcon"

DynamicTableIcon

DynamicTableIcon = "DynamicTableIcon"

DynamicTilesIcon

DynamicTilesIcon = "DynamicTilesIcon"

EmailInputIcon

EmailInputIcon = "EmailInputIcon"

FileInputIcon

FileInputIcon = "FileInputIcon"

FilterIcon

FilterIcon = "FilterIcon"

FormIcon

FormIcon = "FormIcon"

GridIcon

GridIcon = "GridIcon"

HiddenInputIcon

HiddenInputIcon = "HiddenInputIcon"

HorizontalRuleIcon

HorizontalRuleIcon = "HorizontalRuleIcon"

HtmlIcon

HtmlIcon = "HtmlIcon"

IbanInputIcon

IbanInputIcon = "IbanInputIcon"

IconIcon

IconIcon = "IconIcon"

ImageCarouselIcon

ImageCarouselIcon = "ImageCarouselIcon"

ImageIcon

ImageIcon = "ImageIcon"

ImageInputIcon

ImageInputIcon = "ImageInputIcon"

IncludeIcon

IncludeIcon = "IncludeIcon"

LabelIcon

LabelIcon = "LabelIcon"

Layout1Icon

Layout1Icon = "Layout1Icon"

Layout2Icon

Layout2Icon = "Layout2Icon"

Layout3333Icon

Layout3333Icon = "Layout3333Icon"

Layout363Icon

Layout363Icon = "Layout363Icon"

Layout444Icon

Layout444Icon = "Layout444Icon"

Layout48Icon

Layout48Icon = "Layout48Icon"

Layout66Icon

Layout66Icon = "Layout66Icon"

Layout84Icon

Layout84Icon = "Layout84Icon"

ListItemIcon

ListItemIcon = "ListItemIcon"

ListWithDataIcon

ListWithDataIcon = "ListWithDataIcon"

LoginFormIcon

LoginFormIcon = "LoginFormIcon"

LogoutIcon

LogoutIcon = "LogoutIcon"

MenuIcon

MenuIcon = "MenuIcon"

MenuItemIcon

MenuItemIcon = "MenuItemIcon"

MultiLineIcon

MultiLineIcon = "MultiLineIcon"

MultiSelectIcon

MultiSelectIcon = "MultiSelectIcon"

NavItemIcon

NavItemIcon = "NavItemIcon"

NavSidebarIcon

NavSidebarIcon = "NavSidebarIcon"

NavbarIcon

NavbarIcon = "NavbarIcon"

NumberInputIcon

NumberInputIcon = "NumberInputIcon"

OpenPageIcon

OpenPageIcon = "OpenPageIcon"

OrderedListIcon

OrderedListIcon = "OrderedListIcon"

PanelIcon

PanelIcon = "PanelIcon"

PaperIcon

PaperIcon = "PaperIcon"

ParagraphIcon

ParagraphIcon = "ParagraphIcon"

PasswordInputIcon

PasswordInputIcon = "PasswordInputIcon"

PhoneInputIcon

PhoneInputIcon = "PhoneInputIcon"

PriceInputIcon

PriceInputIcon = "PriceInputIcon"

ProgressBarIcon

ProgressBarIcon = "ProgressBarIcon"

RadioButtonIcon

RadioButtonIcon = "RadioButtonIcon"

RatingIcon

RatingIcon = "RatingIcon"

RichTextEditorIcon

RichTextEditorIcon = "RichTextEditorIcon"

RowColumnIcon

RowColumnIcon = "RowColumnIcon"

RowIcon

RowIcon = "RowIcon"

SelectIcon

SelectIcon = "SelectIcon"

SidebarLeftIcon

SidebarLeftIcon = "SidebarLeftIcon"

SliderComponentIcon

SliderComponentIcon = "SliderComponentIcon"

SnackbarIcon

SnackbarIcon = "SnackbarIcon"

StepIcon

StepIcon = "StepIcon"

StepperIcon

StepperIcon = "StepperIcon"

SubViewIcon

SubViewIcon = "SubViewIcon"

SubViewItemIcon

SubViewItemIcon = "SubViewItemIcon"

SubmitButtonIcon

SubmitButtonIcon = "SubmitButtonIcon"

SwitcherIcon

SwitcherIcon = "SwitcherIcon"

TabIcon

TabIcon = "TabIcon"

Table

Table = "Table"

TabsIcon

TabsIcon = "TabsIcon"

TextInputIcon

TextInputIcon = "TextInputIcon"

TextareaIcon

TextareaIcon = "TextareaIcon"

TimePickerIcon

TimePickerIcon = "TimePickerIcon"

TitleIcon

TitleIcon = "TitleIcon"

UnorderedListIcon

UnorderedListIcon = "UnorderedListIcon"

UpdateFormIcon

UpdateFormIcon = "UpdateFormIcon"

UrlInputIcon

UrlInputIcon = "UrlInputIcon"

Generated using TypeDoc

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

Enumeration Icon

Index

Enumeration members

Enumeration members

AccordionIcon

AccordionIcon = "AccordionIcon"

AccordionItemIcon

AccordionItemIcon = "AccordionItemIcon"

AlertIcon

AlertIcon = "AlertIcon"

AutoCompleteIcon

AutoCompleteIcon = "AutoCompleteIcon"

AvatarIcon

AvatarIcon = "AvatarIcon"

BreadcrumbIcon

BreadcrumbIcon = "BreadcrumbIcon"

BreadcrumbItemIcon

BreadcrumbItemIcon = "BreadcrumbItemIcon"

ButtonGroupIcon

ButtonGroupIcon = "ButtonGroupIcon"

ButtonIcon

ButtonIcon = "ButtonIcon"

CardActionsIcon

CardActionsIcon = "CardActionsIcon"

CardContentIcon

CardContentIcon = "CardContentIcon"

CardHeaderIcon

CardHeaderIcon = "CardHeaderIcon"

CardIcon

CardIcon = "CardIcon"

CardMediaIcon

CardMediaIcon = "CardMediaIcon"

CheckboxGroupIcon

CheckboxGroupIcon = "CheckboxGroupIcon"

CheckboxIcon

CheckboxIcon = "CheckboxIcon"

ChipIcon

ChipIcon = "ChipIcon"

Column2Icon

Column2Icon = "Column2Icon"

Column3Icon

Column3Icon = "Column3Icon"

ColumnIcon

ColumnIcon = "ColumnIcon"

ConditionalIcon

ConditionalIcon = "ConditionalIcon"

ContainerIcon

ContainerIcon = "ContainerIcon"

CreateFormIcon

CreateFormIcon = "CreateFormIcon"

DataContainer

DataContainer = "DataContainer"

DataList

DataList = "DataList"

DataTable

DataTable = "DataTable"

DataTableBody

DataTableBody = "DataTableBody"

DataTableColumn

DataTableColumn = "DataTableColumn"

DataTableHead

DataTableHead = "DataTableHead"

DataTableRow

DataTableRow = "DataTableRow"

DatePickerIcon

DatePickerIcon = "DatePickerIcon"

DateTimePickerIcon

DateTimePickerIcon = "DateTimePickerIcon"

DecimalInputIcon

DecimalInputIcon = "DecimalInputIcon"

DefinitionListIcon

DefinitionListIcon = "DefinitionListIcon"

DeleteRecordIcon

DeleteRecordIcon = "DeleteRecordIcon"

DetailViewIcon

DetailViewIcon = "DetailViewIcon"

DialogIcon

DialogIcon = "DialogIcon"

DrawerIcon

DrawerIcon = "DrawerIcon"

DynamicFormIcon

DynamicFormIcon = "DynamicFormIcon"

DynamicTableIcon

DynamicTableIcon = "DynamicTableIcon"

DynamicTilesIcon

DynamicTilesIcon = "DynamicTilesIcon"

EmailInputIcon

EmailInputIcon = "EmailInputIcon"

FileInputIcon

FileInputIcon = "FileInputIcon"

FilterIcon

FilterIcon = "FilterIcon"

FormIcon

FormIcon = "FormIcon"

GridIcon

GridIcon = "GridIcon"

HiddenInputIcon

HiddenInputIcon = "HiddenInputIcon"

HorizontalRuleIcon

HorizontalRuleIcon = "HorizontalRuleIcon"

HtmlIcon

HtmlIcon = "HtmlIcon"

IbanInputIcon

IbanInputIcon = "IbanInputIcon"

IconIcon

IconIcon = "IconIcon"

ImageCarouselIcon

ImageCarouselIcon = "ImageCarouselIcon"

ImageIcon

ImageIcon = "ImageIcon"

ImageInputIcon

ImageInputIcon = "ImageInputIcon"

IncludeIcon

IncludeIcon = "IncludeIcon"

LabelIcon

LabelIcon = "LabelIcon"

Layout1Icon

Layout1Icon = "Layout1Icon"

Layout2Icon

Layout2Icon = "Layout2Icon"

Layout3333Icon

Layout3333Icon = "Layout3333Icon"

Layout363Icon

Layout363Icon = "Layout363Icon"

Layout444Icon

Layout444Icon = "Layout444Icon"

Layout48Icon

Layout48Icon = "Layout48Icon"

Layout66Icon

Layout66Icon = "Layout66Icon"

Layout84Icon

Layout84Icon = "Layout84Icon"

ListItemIcon

ListItemIcon = "ListItemIcon"

ListWithDataIcon

ListWithDataIcon = "ListWithDataIcon"

LoginFormIcon

LoginFormIcon = "LoginFormIcon"

LogoutIcon

LogoutIcon = "LogoutIcon"

MenuIcon

MenuIcon = "MenuIcon"

MenuItemIcon

MenuItemIcon = "MenuItemIcon"

MultiLineIcon

MultiLineIcon = "MultiLineIcon"

MultiSelectIcon

MultiSelectIcon = "MultiSelectIcon"

NavItemIcon

NavItemIcon = "NavItemIcon"

NavSidebarIcon

NavSidebarIcon = "NavSidebarIcon"

NavbarIcon

NavbarIcon = "NavbarIcon"

NumberInputIcon

NumberInputIcon = "NumberInputIcon"

OpenPageIcon

OpenPageIcon = "OpenPageIcon"

OrderedListIcon

OrderedListIcon = "OrderedListIcon"

PanelIcon

PanelIcon = "PanelIcon"

PaperIcon

PaperIcon = "PaperIcon"

ParagraphIcon

ParagraphIcon = "ParagraphIcon"

PasswordInputIcon

PasswordInputIcon = "PasswordInputIcon"

PhoneInputIcon

PhoneInputIcon = "PhoneInputIcon"

PriceInputIcon

PriceInputIcon = "PriceInputIcon"

ProgressBarIcon

ProgressBarIcon = "ProgressBarIcon"

RadioButtonIcon

RadioButtonIcon = "RadioButtonIcon"

RatingIcon

RatingIcon = "RatingIcon"

RichTextEditorIcon

RichTextEditorIcon = "RichTextEditorIcon"

RowColumnIcon

RowColumnIcon = "RowColumnIcon"

RowIcon

RowIcon = "RowIcon"

SelectIcon

SelectIcon = "SelectIcon"

SidebarLeftIcon

SidebarLeftIcon = "SidebarLeftIcon"

SliderComponentIcon

SliderComponentIcon = "SliderComponentIcon"

SnackbarIcon

SnackbarIcon = "SnackbarIcon"

StepIcon

StepIcon = "StepIcon"

StepperIcon

StepperIcon = "StepperIcon"

SubViewIcon

SubViewIcon = "SubViewIcon"

SubViewItemIcon

SubViewItemIcon = "SubViewItemIcon"

SubmitButtonIcon

SubmitButtonIcon = "SubmitButtonIcon"

SwitcherIcon

SwitcherIcon = "SwitcherIcon"

TabIcon

TabIcon = "TabIcon"

Table

Table = "Table"

TabsIcon

TabsIcon = "TabsIcon"

TextInputIcon

TextInputIcon = "TextInputIcon"

TextareaIcon

TextareaIcon = "TextareaIcon"

TimePickerIcon

TimePickerIcon = "TimePickerIcon"

TitleIcon

TitleIcon = "TitleIcon"

UnorderedListIcon

UnorderedListIcon = "UnorderedListIcon"

UpdateFormIcon

UpdateFormIcon = "UpdateFormIcon"

UrlInputIcon

UrlInputIcon = "UrlInputIcon"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/InteractionOptionType.html b/docs/enums/InteractionOptionType.html index db7b0d0e..69aa330e 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

Enumeration members

Boolean

Boolean = "Boolean"

Event

Event = "Event"

Locale

Locale = "Locale"

Number

Number = "Number"

Page

Page = "Page"

String

String = "String"

Void

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

Enumeration members

Boolean

Boolean = "Boolean"

Event

Event = "Event"

Locale

Locale = "Locale"

Number

Number = "Number"

Page

Page = "Page"

String

String = "String"

Void

Void = "Void"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/InteractionOptionTypeToDo.html b/docs/enums/InteractionOptionTypeToDo.html index a00ab7cf..22111985 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

Enumeration members

Color

Color = "Color"

Endpoint

Endpoint = "Endpoint"

Filter

Filter = "Filter"

Font

Font = "Font"

Properties

Properties = "Properties"

Property

Property = "Property"

Size

Size = "Size"

Unit

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

Enumeration members

Color

Color = "Color"

Endpoint

Endpoint = "Endpoint"

Filter

Filter = "Filter"

Font

Font = "Font"

Properties

Properties = "Properties"

Property

Property = "Property"

Size

Size = "Size"

Unit

Unit = "Unit"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/InteractionType.html b/docs/enums/InteractionType.html index 85ec4011..30b82ffa 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

Enumeration InteractionType

Index

Enumeration members

Enumeration members

Custom

Custom = "Custom"

Global

Global = "Global"

Generated using TypeDoc

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

Enumeration InteractionType

Index

Enumeration members

Enumeration members

Custom

Custom = "Custom"

Global

Global = "Global"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/ThemeColor.html b/docs/enums/ThemeColor.html index 6facb514..f5235f1f 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

Enumeration ThemeColor

Index

Enumeration members

Enumeration members

ACCENT_1

ACCENT_1 = "Accent1"

ACCENT_2

ACCENT_2 = "Accent2"

ACCENT_3

ACCENT_3 = "Accent3"

BLACK

BLACK = "Black"

DANGER

DANGER = "Danger"

DARK

DARK = "Dark"

INFO

INFO = "Info"

LIGHT

LIGHT = "Light"

MEDIUM

MEDIUM = "Medium"

PRIMARY

PRIMARY = "Primary"

SECONDARY

SECONDARY = "Secondary"

SUCCESS

SUCCESS = "Success"

TRANSPARENT

TRANSPARENT = "Transparent"

WARNING

WARNING = "Warning"

WHITE

WHITE = "White"

Generated using TypeDoc

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

Enumeration ThemeColor

Index

Enumeration members

Enumeration members

ACCENT_1

ACCENT_1 = "Accent1"

ACCENT_2

ACCENT_2 = "Accent2"

ACCENT_3

ACCENT_3 = "Accent3"

BLACK

BLACK = "Black"

DANGER

DANGER = "Danger"

DARK

DARK = "Dark"

INFO

INFO = "Info"

LIGHT

LIGHT = "Light"

MEDIUM

MEDIUM = "Medium"

PRIMARY

PRIMARY = "Primary"

SECONDARY

SECONDARY = "Secondary"

SUCCESS

SUCCESS = "Success"

TRANSPARENT

TRANSPARENT = "Transparent"

WARNING

WARNING = "Warning"

WHITE

WHITE = "White"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AuthenticateUserStepOption.html b/docs/interfaces/AuthenticateUserStepOption.html index da495d7b..aef5027b 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

Properties

authenticationProfileId

authenticationProfileId: string

ref

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

Properties

authenticationProfileId

authenticationProfileId: string

ref

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 c4ec463e..2609ae89 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

Interface BaseConfiguration

Hierarchy

  • BaseConfiguration

Index

Properties

Properties

Optional condition

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

Interface BaseConfiguration

Hierarchy

  • BaseConfiguration

Index

Properties

Properties

Optional condition

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 a0ad729e..e754aa85 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

Interface BasePrefabInteraction

Hierarchy

Index

Properties

Properties

name

name: string

ref

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

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string

Optional sourceComponentId

sourceComponentId?: string

sourceEvent

sourceEvent: string

Optional targetOptionName

targetOptionName?: string

Generated using TypeDoc

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

Interface BasePrefabInteraction

Hierarchy

Index

Properties

Properties

name

name: string

ref

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

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string

Optional sourceComponentId

sourceComponentId?: string

sourceEvent

sourceEvent: string

Optional targetOptionName

targetOptionName?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/BuildStyleDefinition.html b/docs/interfaces/BuildStyleDefinition.html index d04f9b1f..9d06e248 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

Interface BuildStyleDefinition

Hierarchy

Index

Properties

Properties

content

content: StyleDefinitionContent

name

name: string

type

type: string

Generated using TypeDoc

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

Interface BuildStyleDefinition

Hierarchy

Index

Properties

Properties

content

content: StyleDefinitionContent

name

name: string

type

type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Interaction.html b/docs/interfaces/Interaction.html index bcbfaed0..fb39f5cb 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

Interface Interaction

Hierarchy

Index

Properties

Properties

function

function: string

name

name: string

parameters

parameters: Record<string, InteractionOptionType>

type

type: InteractionOptionType

Generated using TypeDoc

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

Interface Interaction

Hierarchy

Index

Properties

Properties

function

function: string

name

name: string

parameters

parameters: Record<string, InteractionOptionType>

type

type: InteractionOptionType

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/InteractionCompatibility.html b/docs/interfaces/InteractionCompatibility.html index bb12c5a2..a8c27e04 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

Properties

name

name: string

parameters

parameters: Record<string, InteractionOptionType>

type

type: 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

Properties

name

name: string

parameters

parameters: Record<string, InteractionOptionType>

type

type: InteractionOptionType

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ParameterOptionWithComponentRef.html b/docs/interfaces/ParameterOptionWithComponentRef.html index 799a2954..e83f153b 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

Properties

name

name: string

parameter

parameter: string

ref

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

Properties

name

name: string

parameter

parameter: string

ref

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 2577aa38..2424294e 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

Interface ParameterOptionWithId

Hierarchy

  • ParameterOptionWithId

Index

Properties

Properties

id

id: string[]

parameter

parameter: string

Generated using TypeDoc

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

Interface ParameterOptionWithId

Hierarchy

  • ParameterOptionWithId

Index

Properties

Properties

id

id: string[]

parameter

parameter: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ParameterOptionWithPageId.html b/docs/interfaces/ParameterOptionWithPageId.html index 1657b8fb..f826f7e9 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

Properties

Optional endpointId

endpointId?: string

Optional id

id?: string

Optional name

name?: string

pageId

pageId: string

Optional parameters

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

Properties

Optional endpointId

endpointId?: string

Optional id

id?: string

Optional name

name?: string

pageId

pageId: string

Optional parameters

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 8908da64..eac2ddc4 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

Interface ParameterOptionWithPath

Hierarchy

  • ParameterOptionWithPath

Index

Properties

Properties

parameter

parameter: string

path

path: string[]

Generated using TypeDoc

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

Interface ParameterOptionWithPath

Hierarchy

  • ParameterOptionWithPath

Index

Properties

Properties

parameter

parameter: string

path

path: string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Prefab.html b/docs/interfaces/Prefab.html index 8f7280d0..68f4cfda 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

Interface Prefab

Hierarchy

  • Prefab

Index

Properties

Properties

Optional actions

actions?: PrefabAction[]

Optional beforeCreate

beforeCreate?: string

category

category: string

Optional description

description?: string

icon

icon: Icon

Optional interactions

interactions?: PrefabInteraction[]

Optional keywords

keywords?: string[]

name

name: string

Optional reconfigure

reconfigure?: { addChildWizardType?: string; children: PrefabComponent[]; reconfigureWizardType?: string }

Type declaration

  • Optional addChildWizardType?: string
  • children: PrefabComponent[]
  • Optional reconfigureWizardType?: string

structure

structure: PrefabReference[]

Optional type

type?: string

Optional variables

variables?: PrefabVariable[]

Generated using TypeDoc

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

Interface Prefab

Hierarchy

  • Prefab

Index

Properties

Properties

Optional actions

actions?: PrefabAction[]

Optional beforeCreate

beforeCreate?: string

category

category: string

Optional description

description?: string

icon

icon: Icon

Optional interactions

interactions?: PrefabInteraction[]

Optional keywords

keywords?: string[]

name

name: string

Optional reconfigure

reconfigure?: { addChildWizardType?: string; children: PrefabComponent[]; reconfigureWizardType?: string }

Type declaration

  • Optional addChildWizardType?: string
  • children: PrefabComponent[]
  • Optional reconfigureWizardType?: string

structure

structure: PrefabReference[]

Optional type

type?: string

Optional variables

variables?: PrefabVariable[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabAction.html b/docs/interfaces/PrefabAction.html index eaf0a532..a3fd42b6 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

Interface PrefabAction

Hierarchy

  • PrefabAction

Index

Properties

Properties

Optional events

events?: PrefabActionStep[]

name

name: string

Optional options

options?: { ref: { result: string } }

Type declaration

  • ref: { result: string }
    • result: string

ref

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

Type declaration

  • Optional endpointId?: string
  • id: string

useNewRuntime

useNewRuntime: boolean

Generated using TypeDoc

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

Interface PrefabAction

Hierarchy

  • PrefabAction

Index

Properties

Properties

Optional events

events?: PrefabActionStep[]

name

name: string

Optional options

options?: { ref: { result: string } }

Type declaration

  • ref: { result: string }
    • result: string

ref

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

Type declaration

  • Optional endpointId?: string
  • id: string

useNewRuntime

useNewRuntime: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabActionAssign.html b/docs/interfaces/PrefabActionAssign.html index db441485..2e6f4312 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

Interface PrefabActionAssign

Hierarchy

  • PrefabActionAssign

Index

Properties

Properties

leftHandSide

leftHandSide: string

ref

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

Interface PrefabActionAssign

Hierarchy

  • PrefabActionAssign

Index

Properties

Properties

leftHandSide

leftHandSide: string

ref

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 3080edd5..bf51ab4f 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

Properties

assign

assign: PrefabActionAssign[]

modelId

modelId: string

ref

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

Properties

assign

assign: PrefabActionAssign[]

modelId

modelId: string

ref

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 ba6bc368..22b757cb 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

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

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 56fc7e6e..6e06f952 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

Interface PrefabActionStep

Hierarchy

  • PrefabActionStep

Index

Properties

Properties

kind

kind: string

Optional options

options?: PrefabActionUpdateStepOption | PrefabActionCreateStepOption | PrefabActionDeleteStepOption | AuthenticateUserStepOption

Generated using TypeDoc

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

Interface PrefabActionStep

Hierarchy

  • PrefabActionStep

Index

Properties

Properties

kind

kind: string

Optional options

options?: PrefabActionUpdateStepOption | PrefabActionCreateStepOption | PrefabActionDeleteStepOption | AuthenticateUserStepOption

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabActionUpdateStepOption.html b/docs/interfaces/PrefabActionUpdateStepOption.html index 2df1997d..74ca53ad 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

assign

assign: PrefabActionAssign[]

ref

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

assign

assign: PrefabActionAssign[]

ref

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 c4410669..644a0e9a 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

Interface PrefabComponent

Hierarchy

  • PrefabComponent

Index

Properties

Properties

Optional $afterCreate

$afterCreate?: Hook[]

Optional $afterDelete

$afterDelete?: Hook[]

Optional $onUpdate

$onUpdate?: Hook[]

Optional actions

actions?: PrefabAction[]

descendants

descendants: PrefabReference[]

Optional id

id?: string

Optional label

label?: string

name

name: string

Optional optionCategories

optionCategories?: OptionCategory[]

options

options: PrefabComponentOption[]

Optional ref

ref?: { id: string }

Type declaration

  • id: string

Optional style

style?: PrefabComponentStyle

Optional type

type?: "COMPONENT"

Generated using TypeDoc

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

Interface PrefabComponent

Hierarchy

  • PrefabComponent

Index

Properties

Properties

Optional $afterCreate

$afterCreate?: Hook[]

Optional $afterDelete

$afterDelete?: Hook[]

Optional $onUpdate

$onUpdate?: Hook[]

Optional actions

actions?: PrefabAction[]

descendants

descendants: PrefabReference[]

Optional id

id?: string

Optional label

label?: string

name

name: string

Optional optionCategories

optionCategories?: OptionCategory[]

options

options: PrefabComponentOption[]

Optional ref

ref?: { id: string }

Type declaration

  • id: string

Optional style

style?: PrefabComponentStyle

Optional type

type?: "COMPONENT"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabComponentOptionBase.html b/docs/interfaces/PrefabComponentOptionBase.html index 8a47a966..4948b6f4 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

Properties

Optional configuration

configuration?: unknown

key

key: string

label

label: string

type

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

Properties

Optional configuration

configuration?: unknown

key

key: string

label

label: string

type

type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabCustomInteraction.html b/docs/interfaces/PrefabCustomInteraction.html index 53ddbe9c..bb2a59b7 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

Interface PrefabCustomInteraction

Hierarchy

Index

Properties

Properties

name

name: string

ref

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

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string

Optional sourceComponentId

sourceComponentId?: string

sourceEvent

sourceEvent: string

Optional targetOptionName

targetOptionName?: string

type

type: Custom

Generated using TypeDoc

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

Interface PrefabCustomInteraction

Hierarchy

Index

Properties

Properties

name

name: string

ref

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

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string

Optional sourceComponentId

sourceComponentId?: string

sourceEvent

sourceEvent: string

Optional targetOptionName

targetOptionName?: string

type

type: Custom

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabGlobalInteraction.html b/docs/interfaces/PrefabGlobalInteraction.html index 0ce81522..7b48b897 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

Interface PrefabGlobalInteraction

Hierarchy

Index

Properties

Properties

name

name: string

parameters

parameters: PrefabInteractionParameter[]

ref

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

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string

Optional sourceComponentId

sourceComponentId?: string

sourceEvent

sourceEvent: string

Optional targetOptionName

targetOptionName?: string

type

type: Global

Generated using TypeDoc

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

Interface PrefabGlobalInteraction

Hierarchy

Index

Properties

Properties

name

name: string

parameters

parameters: PrefabInteractionParameter[]

ref

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

Type declaration

  • Optional sourceComponentId?: string
  • Optional targetComponentId?: string

Optional sourceComponentId

sourceComponentId?: string

sourceEvent

sourceEvent: string

Optional targetOptionName

targetOptionName?: string

type

type: Global

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabLinkedOptionBase.html b/docs/interfaces/PrefabLinkedOptionBase.html index a8724f3f..d86f2fcf 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

Interface PrefabLinkedOptionBase

Hierarchy

Index

Properties

Properties

key

key: string

label

label: string

Generated using TypeDoc

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

Interface PrefabLinkedOptionBase

Hierarchy

Index

Properties

Properties

key

key: string

label

label: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabPartial.html b/docs/interfaces/PrefabPartial.html index 1a6d34b3..8e4e0959 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

Interface PrefabPartial

Hierarchy

  • PrefabPartial

Index

Properties

Properties

partialId

partialId: string

type

type: "PARTIAL"

Generated using TypeDoc

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

Interface PrefabPartial

Hierarchy

  • PrefabPartial

Index

Properties

Properties

partialId

partialId: string

type

type: "PARTIAL"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabVariable.html b/docs/interfaces/PrefabVariable.html index ee3f7d61..45f429c3 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

Interface PrefabVariable

Hierarchy

  • PrefabVariable

Index

Properties

Properties

kind

kind: PrefabVariableKind

name

name: string

Optional options

options?: unknown

ref

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

Interface PrefabVariable

Hierarchy

  • PrefabVariable

Index

Properties

Properties

kind

kind: PrefabVariableKind

name

name: string

Optional options

options?: unknown

ref

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 b0dceefa..17c4478c 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

Interface PrefabWrapper

Hierarchy

  • PrefabWrapper

Index

Properties

Properties

descendants

descendants: PrefabReference[]

Optional label

label?: string

Optional optionCategories

optionCategories?: OptionCategory[]

options

options: (PrefabWrapperLinkedOption | PrefabWrapperLinkedPartialOption)[]

type

type: "WRAPPER"

Generated using TypeDoc

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

Interface PrefabWrapper

Hierarchy

  • PrefabWrapper

Index

Properties

Properties

descendants

descendants: PrefabReference[]

Optional label

label?: string

Optional optionCategories

optionCategories?: OptionCategory[]

options

options: (PrefabWrapperLinkedOption | PrefabWrapperLinkedPartialOption)[]

type

type: "WRAPPER"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PrefabWrapperLinkedOption.html b/docs/interfaces/PrefabWrapperLinkedOption.html index 13c1d95d..2405c1bd 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

Properties

Optional configuration

configuration?: PrefabWrapperLinkedOptionConfiguration

key

key: string

label

label: string

type

type: "LINKED_OPTION"

Optional value

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

Properties

Optional configuration

configuration?: PrefabWrapperLinkedOptionConfiguration

key

key: string

label

label: string

type

type: "LINKED_OPTION"

Optional value

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 14a81c6b..b33f9504 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

Properties

Optional configuration

configuration?: PrefabWrapperLinkedOptionConfiguration

key

key: string

label

label: string

type

type: "LINKED_PARTIAL"

Optional value

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

Properties

Optional configuration

configuration?: PrefabWrapperLinkedOptionConfiguration

key

key: string

label

label: string

type

type: "LINKED_PARTIAL"

Optional value

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 472d5a47..6b43cf9b 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

Interface StaticValue

Hierarchy

  • StaticValue

Index

Properties

Properties

type

type: "STATIC"

value

value: string

Generated using TypeDoc

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

Interface StaticValue

Hierarchy

  • StaticValue

Index

Properties

Properties

type

type: "STATIC"

value

value: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/StyleDefinition.html b/docs/interfaces/StyleDefinition.html index 2ba4167b..359fc5fd 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

Interface StyleDefinition

Hierarchy

  • StyleDefinition

Index

Properties

Properties

basis

basis: StyleDefinitionContentObject

name

name: string

states

states: StyleDefinitionState[]

type

type: string

Generated using TypeDoc

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

Interface StyleDefinition

Hierarchy

  • StyleDefinition

Index

Properties

Properties

basis

basis: StyleDefinitionContentObject

name

name: string

states

states: StyleDefinitionState[]

type

type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/StyleDefinitionContentObject.html b/docs/interfaces/StyleDefinitionContentObject.html index da38fee9..414b4f24 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

Properties

Optional backgroundColor

backgroundColor?: RefOrValue

Optional borderColor

borderColor?: RefOrValue

Optional borderRadius

borderRadius?: string[]

Optional borderStyle

borderStyle?: string

Optional borderWidth

borderWidth?: string[]

Optional boxShadow

boxShadow?: string

Optional color

color?: RefOrValue

Optional fontFamily

fontFamily?: string

Optional fontSize

fontSize?: string

Optional fontStyle

fontStyle?: string

Optional fontWeight

fontWeight?: string

Optional letterSpacing

letterSpacing?: string

Optional lineHeight

lineHeight?: string

Optional padding

padding?: string[]

Optional textDecoration

textDecoration?: string

Optional textTransform

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

Properties

Optional backgroundColor

backgroundColor?: RefOrValue

Optional borderColor

borderColor?: RefOrValue

Optional borderRadius

borderRadius?: string[]

Optional borderStyle

borderStyle?: string

Optional borderWidth

borderWidth?: string[]

Optional boxShadow

boxShadow?: string

Optional color

color?: RefOrValue

Optional fontFamily

fontFamily?: string

Optional fontSize

fontSize?: string

Optional fontStyle

fontStyle?: string

Optional fontWeight

fontWeight?: string

Optional letterSpacing

letterSpacing?: string

Optional lineHeight

lineHeight?: string

Optional padding

padding?: string[]

Optional textDecoration

textDecoration?: string

Optional textTransform

textTransform?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/StyleDefinitionState.html b/docs/interfaces/StyleDefinitionState.html index e0de3b60..543f9614 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

Interface StyleDefinitionState

Hierarchy

  • StyleDefinitionState

Index

Properties

Properties

content

content: StyleDefinitionContentObject

name

name: string

Generated using TypeDoc

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

Interface StyleDefinitionState

Hierarchy

  • StyleDefinitionState

Index

Properties

Properties

content

content: StyleDefinitionContentObject

name

name: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/StyleReference.html b/docs/interfaces/StyleReference.html index 2f1d4266..e32f9f64 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

Interface StyleReference

Hierarchy

  • StyleReference

Index

Properties

Properties

name

name: string

Optional overwrite

overwrite?: StyleDefinitionState[]

Generated using TypeDoc

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

Interface StyleReference

Hierarchy

  • StyleReference

Index

Properties

Properties

name

name: string

Optional overwrite

overwrite?: StyleDefinitionState[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ThemeColorReference.html b/docs/interfaces/ThemeColorReference.html index f8360a35..b129cba4 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

Interface ThemeColorReference

Hierarchy

  • ThemeColorReference

Index

Properties

Properties

type

type: "THEME_COLOR"

value

value: string

Generated using TypeDoc

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

Interface ThemeColorReference

Hierarchy

  • ThemeColorReference

Index

Properties

Properties

type

type: "THEME_COLOR"

value

value: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ValueDefault.html b/docs/interfaces/ValueDefault.html index 1794c954..0a81c1b5 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

Interface ValueDefault

Hierarchy

Index

Properties

Properties

Optional configuration

configuration?: unknown

key

key: string

label

label: string

Optional ref

ref?: { id?: string }

Type declaration

  • Optional id?: string

Optional showInAddChild

showInAddChild?: boolean

Optional showInReconfigure

showInReconfigure?: boolean

type

type: string

value

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

Interface ValueDefault

Hierarchy

Index

Properties

Properties

Optional configuration

configuration?: unknown

key

key: string

label

label: string

Optional ref

ref?: { id?: string }

Type declaration

  • Optional id?: string

Optional showInAddChild

showInAddChild?: boolean

Optional showInReconfigure

showInReconfigure?: boolean

type

type: string

value

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 d5d2240b..5777bd3d 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

Interface ValueRef

Hierarchy

Index

Properties

Properties

Optional configuration

configuration?: unknown

key

key: string

label

label: string

ref

ref: { id?: string; value: string | string[] }

Type declaration

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

Optional showInAddChild

showInAddChild?: boolean

Optional showInReconfigure

showInReconfigure?: boolean

type

type: string

Generated using TypeDoc

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

Interface ValueRef

Hierarchy

Index

Properties

Properties

Optional configuration

configuration?: unknown

key

key: string

label

label: string

ref

ref: { id?: string; value: string | string[] }

Type declaration

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

Optional showInAddChild

showInAddChild?: boolean

Optional showInReconfigure

showInReconfigure?: boolean

type

type: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 3fae2f91..446c6246 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

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

Configuration: VariableConfiguration | ButtonGroupConfiguration | DropdownConfiguration

Hook

Hook: { input: Record<string, Ref>; output?: {}; query: string }

Type declaration

  • input: Record<string, Ref>
  • Optional output?: {}
    • [key: string]: Ref
  • query: string

LinkedOptionProducer

LinkedOptionProducer: (key: string) => PrefabWrapperLinkedOption

Type declaration

LinkedPartialOptionProducer

LinkedPartialOptionProducer: (key: string) => PrefabWrapperLinkedPartialOption

Type declaration

OptionCategory

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

OptionProducer: (key: string) => PrefabComponentOption

Type declaration

PrefabComponentOption

PrefabComponentOption: ValueDefault | ValueRef

PrefabComponentStyle

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[]

PrefabInteraction

PrefabInteraction: PrefabCustomInteraction | PrefabGlobalInteraction

PrefabInteractionParameter

PrefabInteractionParameter: ParameterOptionWithId | ParameterOptionWithPath | ParameterOptionWithComponentRef | ParameterOptionWithPageId

PrefabReference

PrefabReference: PrefabPartial | PrefabComponent | PrefabWrapper

PrefabVariableKind

PrefabVariableKind: "construct" | "object" | "string" | "integer"

PrefabWrapperLinkedOptionConfiguration

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

RefOrValue

RefOrValue: ThemeColorReference | StaticValue

StyleDefinitionContent

StyleDefinitionContent: Partial<StyleDefinitionContentBase> & Pick<StyleDefinitionContentBase, "basis">

StyleDefinitionContentBase

StyleDefinitionContentBase: { [ key in StyleStateKeys | "basis"]: StyleDefinitionContentObject }

StyleProducer

StyleProducer: (key: string) => PrefabComponentStyle

Type declaration

StyleStateKeys

StyleStateKeys: SELECTED | HOVER | FOCUS | DISABLED | VALID | INVALID | READONLY

ValueConfig

ValueConfig: Record<string, unknown>

Functions

Const action

  • action(label: string, attrs: Attributes): OptionProducer

Const actionInputObjects

  • actionInputObjects(label: string, attrs: Attributes): OptionProducer

Const addChild

  • addChild(label: string, attrs?: Attributes): OptionProducer

Const authenticationProfile

  • authenticationProfile(label: string, attrs: Attributes): OptionProducer

Const buttongroup

  • buttongroup(label: string, options: [string, string][], attrs?: Attributes): OptionProducer

Const childSelector

  • childSelector(label: string, attrs?: Attributes): OptionProducer

Const color

Const component

Const createPage

  • createPage(label: string, attrs?: Attributes): OptionProducer

Const dropdown

  • dropdown(label: string, options: [string, string][], attrs?: Attributes): OptionProducer

Const endpoint

  • endpoint(label: string, attrs?: Attributes): OptionProducer

Const filter

  • filter(label: string, attrs?: Attributes): OptionProducer

Const font

  • font(label: string, attrs: Attributes): OptionProducer

Const hideIf

  • hideIf(key: string, comparator: "EQ", value: string | boolean): undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }

Const icon

  • icon(label: string, attrs?: Attributes): OptionProducer

Const linked

Const linkedPartial

Const model

  • model(label: string, attrs?: Attributes): OptionProducer

Const modelAndRelation

  • modelAndRelation(label: string, attrs?: Attributes): OptionProducer

Const number

  • number(label: string, attrs?: Attributes): OptionProducer

Const option

  • option(type: string, attrs: Attributes): OptionProducer

Const partial

Const prefab

  • prefab(name: string, attr: Attributes, beforeCreate: undefined | BeforeCreate, structure: PrefabReference[], reconfigure?: { addChildWizardType?: string; children: PrefabComponent[]; reconfigureWizardType?: string }): Prefab

Const property

  • property(label: string, attrs?: Attributes): OptionProducer

Const reconfigure

  • reconfigure(label: string, attrs?: Attributes): OptionProducer

Const showIf

  • showIf(key: string, comparator: "EQ", value: string | boolean): undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }

Const showIfTrue

  • showIfTrue(key: string): undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }

Const size

  • size(label: string, attrs: Attributes): OptionProducer

Const sizes

  • sizes(label: string, attrs: Attributes): OptionProducer

Const staticColor

Const style

  • style(type: string, __namedParameters: RequiredStyleAttrs): StyleDefinition

Const styleReference

  • styleReference(name: string, attrs: StyleReferenceAttrs): StyleReference

Const text

  • text(label: string, attrs?: Attributes): OptionProducer

Const themeColor

Const toggle

  • toggle(label: string, attrs?: Attributes): OptionProducer

Const variable

  • variable(label: string, attrs?: Attributes): OptionProducer

Const wrapper

Const prefab

  • prefab(name: string, attr: Attributes, beforeCreate: undefined | BeforeCreate, structure: PrefabReference[], reconfigure?: { addChildWizardType?: string; children: PrefabComponent[]; reconfigureWizardType?: string }): Prefab

Const property

  • property(label: string, attrs?: Attributes): OptionProducer

Const reconfigure

  • reconfigure(label: string, attrs?: Attributes): OptionProducer

Const showIf

  • showIf(key: string, comparator: "EQ", value: string | boolean): undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }

Const showIfTrue

  • showIfTrue(key: string): undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }

Const size

  • size(label: string, attrs: Attributes): OptionProducer

Const sizes

  • sizes(label: string, attrs: Attributes): OptionProducer

Const staticColor

Const style

  • style(type: string, __namedParameters: RequiredStyleAttrs): StyleDefinition

Const styleReference

  • styleReference(name: string, attrs: StyleReferenceAttrs): StyleReference

Const text

  • text(label: string, attrs?: Attributes): OptionProducer

Const themeColor

Const toggle

  • toggle(label: string, attrs?: Attributes): OptionProducer

Const variable

  • variable(label: string, attrs?: Attributes): OptionProducer

Const wrapper

Generated using TypeDoc

\ No newline at end of file