\ No newline at end of file
diff --git a/docs/enums/AllowedStateKeys.html b/docs/enums/AllowedStateKeys.html
index 38b0d0a1..34398bf8 100644
--- a/docs/enums/AllowedStateKeys.html
+++ b/docs/enums/AllowedStateKeys.html
@@ -1 +1 @@
-AllowedStateKeys | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/enums/CreatePropertyKind.html b/docs/enums/CreatePropertyKind.html
index 602a15d7..6c0ee7dc 100644
--- a/docs/enums/CreatePropertyKind.html
+++ b/docs/enums/CreatePropertyKind.html
@@ -1 +1 @@
-CreatePropertyKind | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/enums/Icon.html b/docs/enums/Icon.html
index 622073b8..a55b8b75 100644
--- a/docs/enums/Icon.html
+++ b/docs/enums/Icon.html
@@ -1 +1 @@
-Icon | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/enums/InteractionOptionType.html b/docs/enums/InteractionOptionType.html
index 3aacce70..3b8e483d 100644
--- a/docs/enums/InteractionOptionType.html
+++ b/docs/enums/InteractionOptionType.html
@@ -1 +1 @@
-InteractionOptionType | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/enums/InteractionOptionTypeToDo.html b/docs/enums/InteractionOptionTypeToDo.html
index 2f5838d3..2fbc9298 100644
--- a/docs/enums/InteractionOptionTypeToDo.html
+++ b/docs/enums/InteractionOptionTypeToDo.html
@@ -1 +1 @@
-InteractionOptionTypeToDo | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/enums/InteractionType.html b/docs/enums/InteractionType.html
index 7d3ded49..013c6d24 100644
--- a/docs/enums/InteractionType.html
+++ b/docs/enums/InteractionType.html
@@ -1 +1 @@
-InteractionType | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/enums/ThemeColor.html b/docs/enums/ThemeColor.html
index 08f89328..53de52bc 100644
--- a/docs/enums/ThemeColor.html
+++ b/docs/enums/ThemeColor.html
@@ -1 +1 @@
-ThemeColor | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/AuthenticateUserStepOption.html b/docs/interfaces/AuthenticateUserStepOption.html
index f47ba26f..1eba1d84 100644
--- a/docs/interfaces/AuthenticateUserStepOption.html
+++ b/docs/interfaces/AuthenticateUserStepOption.html
@@ -1 +1 @@
-AuthenticateUserStepOption | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/BaseConfiguration.html b/docs/interfaces/BaseConfiguration.html
index 9dd05a91..7441836e 100644
--- a/docs/interfaces/BaseConfiguration.html
+++ b/docs/interfaces/BaseConfiguration.html
@@ -1 +1 @@
-BaseConfiguration | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/BasePrefabInteraction.html b/docs/interfaces/BasePrefabInteraction.html
index 950e826a..676b54c1 100644
--- a/docs/interfaces/BasePrefabInteraction.html
+++ b/docs/interfaces/BasePrefabInteraction.html
@@ -1 +1 @@
-BasePrefabInteraction | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/BuildStyleDefinition.html b/docs/interfaces/BuildStyleDefinition.html
index 68ad9df3..3da85688 100644
--- a/docs/interfaces/BuildStyleDefinition.html
+++ b/docs/interfaces/BuildStyleDefinition.html
@@ -1 +1 @@
-BuildStyleDefinition | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/Interaction.html b/docs/interfaces/Interaction.html
index 0fbc4874..bdc5351a 100644
--- a/docs/interfaces/Interaction.html
+++ b/docs/interfaces/Interaction.html
@@ -1 +1 @@
-Interaction | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/InteractionCompatibility.html b/docs/interfaces/InteractionCompatibility.html
index 315a46c0..cd36814a 100644
--- a/docs/interfaces/InteractionCompatibility.html
+++ b/docs/interfaces/InteractionCompatibility.html
@@ -1 +1 @@
-InteractionCompatibility | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/ParameterOptionWithComponentRef.html b/docs/interfaces/ParameterOptionWithComponentRef.html
index ee879604..8bc89185 100644
--- a/docs/interfaces/ParameterOptionWithComponentRef.html
+++ b/docs/interfaces/ParameterOptionWithComponentRef.html
@@ -1 +1 @@
-ParameterOptionWithComponentRef | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/ParameterOptionWithId.html b/docs/interfaces/ParameterOptionWithId.html
index 4cf2dc32..1d7c79ba 100644
--- a/docs/interfaces/ParameterOptionWithId.html
+++ b/docs/interfaces/ParameterOptionWithId.html
@@ -1 +1 @@
-ParameterOptionWithId | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/ParameterOptionWithPageId.html b/docs/interfaces/ParameterOptionWithPageId.html
index 580dd54f..bbf4d507 100644
--- a/docs/interfaces/ParameterOptionWithPageId.html
+++ b/docs/interfaces/ParameterOptionWithPageId.html
@@ -1 +1 @@
-ParameterOptionWithPageId | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/ParameterOptionWithPath.html b/docs/interfaces/ParameterOptionWithPath.html
index faa73304..c413d5e0 100644
--- a/docs/interfaces/ParameterOptionWithPath.html
+++ b/docs/interfaces/ParameterOptionWithPath.html
@@ -1 +1 @@
-ParameterOptionWithPath | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/Prefab.html b/docs/interfaces/Prefab.html
index 20d81c2e..83fd6600 100644
--- a/docs/interfaces/Prefab.html
+++ b/docs/interfaces/Prefab.html
@@ -1 +1 @@
-Prefab | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabAction.html b/docs/interfaces/PrefabAction.html
index 097d2590..14074b4d 100644
--- a/docs/interfaces/PrefabAction.html
+++ b/docs/interfaces/PrefabAction.html
@@ -1 +1 @@
-PrefabAction | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabActionAssign.html b/docs/interfaces/PrefabActionAssign.html
index 94c4dd82..c74bf633 100644
--- a/docs/interfaces/PrefabActionAssign.html
+++ b/docs/interfaces/PrefabActionAssign.html
@@ -1 +1 @@
-PrefabActionAssign | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabActionCreateStepOption.html b/docs/interfaces/PrefabActionCreateStepOption.html
index 72f46f18..da165a92 100644
--- a/docs/interfaces/PrefabActionCreateStepOption.html
+++ b/docs/interfaces/PrefabActionCreateStepOption.html
@@ -1 +1 @@
-PrefabActionCreateStepOption | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabActionDeleteStepOption.html b/docs/interfaces/PrefabActionDeleteStepOption.html
index 5f6f8569..86adda94 100644
--- a/docs/interfaces/PrefabActionDeleteStepOption.html
+++ b/docs/interfaces/PrefabActionDeleteStepOption.html
@@ -1 +1 @@
-PrefabActionDeleteStepOption | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabActionStep.html b/docs/interfaces/PrefabActionStep.html
index 4f78dcff..a57b3738 100644
--- a/docs/interfaces/PrefabActionStep.html
+++ b/docs/interfaces/PrefabActionStep.html
@@ -1 +1 @@
-PrefabActionStep | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabActionUpdateStepOption.html b/docs/interfaces/PrefabActionUpdateStepOption.html
index 847f22f1..2e93937e 100644
--- a/docs/interfaces/PrefabActionUpdateStepOption.html
+++ b/docs/interfaces/PrefabActionUpdateStepOption.html
@@ -1 +1 @@
-PrefabActionUpdateStepOption | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabComponent.html b/docs/interfaces/PrefabComponent.html
index 9be79c7e..aa9fdc67 100644
--- a/docs/interfaces/PrefabComponent.html
+++ b/docs/interfaces/PrefabComponent.html
@@ -1 +1 @@
-PrefabComponent | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabComponentOptionBase.html b/docs/interfaces/PrefabComponentOptionBase.html
index b55d65d8..569beea8 100644
--- a/docs/interfaces/PrefabComponentOptionBase.html
+++ b/docs/interfaces/PrefabComponentOptionBase.html
@@ -1 +1 @@
-PrefabComponentOptionBase | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabCustomInteraction.html b/docs/interfaces/PrefabCustomInteraction.html
index 2c449770..36d3ce43 100644
--- a/docs/interfaces/PrefabCustomInteraction.html
+++ b/docs/interfaces/PrefabCustomInteraction.html
@@ -1 +1 @@
-PrefabCustomInteraction | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabGlobalInteraction.html b/docs/interfaces/PrefabGlobalInteraction.html
index 4a850152..70ee998d 100644
--- a/docs/interfaces/PrefabGlobalInteraction.html
+++ b/docs/interfaces/PrefabGlobalInteraction.html
@@ -1 +1 @@
-PrefabGlobalInteraction | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabLinkedOptionBase.html b/docs/interfaces/PrefabLinkedOptionBase.html
index 0c500ee4..ec7132d8 100644
--- a/docs/interfaces/PrefabLinkedOptionBase.html
+++ b/docs/interfaces/PrefabLinkedOptionBase.html
@@ -1 +1 @@
-PrefabLinkedOptionBase | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabPartial.html b/docs/interfaces/PrefabPartial.html
index 032f79ad..15313c76 100644
--- a/docs/interfaces/PrefabPartial.html
+++ b/docs/interfaces/PrefabPartial.html
@@ -1 +1 @@
-PrefabPartial | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabVariable.html b/docs/interfaces/PrefabVariable.html
index 0861199e..ccf1be65 100644
--- a/docs/interfaces/PrefabVariable.html
+++ b/docs/interfaces/PrefabVariable.html
@@ -1 +1 @@
-PrefabVariable | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabWrapper.html b/docs/interfaces/PrefabWrapper.html
index abbc850e..d2b6b2d9 100644
--- a/docs/interfaces/PrefabWrapper.html
+++ b/docs/interfaces/PrefabWrapper.html
@@ -1 +1 @@
-PrefabWrapper | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabWrapperLinkedOption.html b/docs/interfaces/PrefabWrapperLinkedOption.html
index 4d0dbf9f..32b9d813 100644
--- a/docs/interfaces/PrefabWrapperLinkedOption.html
+++ b/docs/interfaces/PrefabWrapperLinkedOption.html
@@ -1 +1 @@
-PrefabWrapperLinkedOption | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/PrefabWrapperLinkedPartialOption.html b/docs/interfaces/PrefabWrapperLinkedPartialOption.html
index b3351e48..b1627394 100644
--- a/docs/interfaces/PrefabWrapperLinkedPartialOption.html
+++ b/docs/interfaces/PrefabWrapperLinkedPartialOption.html
@@ -1 +1 @@
-PrefabWrapperLinkedPartialOption | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/StaticValue.html b/docs/interfaces/StaticValue.html
index d556a7d7..9085d9f8 100644
--- a/docs/interfaces/StaticValue.html
+++ b/docs/interfaces/StaticValue.html
@@ -1 +1 @@
-StaticValue | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/StyleDefinition.html b/docs/interfaces/StyleDefinition.html
index 87ab2d3a..83f23e2d 100644
--- a/docs/interfaces/StyleDefinition.html
+++ b/docs/interfaces/StyleDefinition.html
@@ -1 +1 @@
-StyleDefinition | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/StyleDefinitionContentObject.html b/docs/interfaces/StyleDefinitionContentObject.html
index d374df29..f463d126 100644
--- a/docs/interfaces/StyleDefinitionContentObject.html
+++ b/docs/interfaces/StyleDefinitionContentObject.html
@@ -1 +1 @@
-StyleDefinitionContentObject | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/StyleDefinitionState.html b/docs/interfaces/StyleDefinitionState.html
index 137542e3..7c92b9fc 100644
--- a/docs/interfaces/StyleDefinitionState.html
+++ b/docs/interfaces/StyleDefinitionState.html
@@ -1 +1 @@
-StyleDefinitionState | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/StyleReference.html b/docs/interfaces/StyleReference.html
index 05d6c69b..f1f35c18 100644
--- a/docs/interfaces/StyleReference.html
+++ b/docs/interfaces/StyleReference.html
@@ -1 +1 @@
-StyleReference | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/ThemeColorReference.html b/docs/interfaces/ThemeColorReference.html
index fc641551..0daf4ed5 100644
--- a/docs/interfaces/ThemeColorReference.html
+++ b/docs/interfaces/ThemeColorReference.html
@@ -1 +1 @@
-ThemeColorReference | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/ValueDefault.html b/docs/interfaces/ValueDefault.html
index afc4ca14..11546760 100644
--- a/docs/interfaces/ValueDefault.html
+++ b/docs/interfaces/ValueDefault.html
@@ -1 +1 @@
-ValueDefault | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/interfaces/ValueRef.html b/docs/interfaces/ValueRef.html
index 9d34bcaa..1610b75c 100644
--- a/docs/interfaces/ValueRef.html
+++ b/docs/interfaces/ValueRef.html
@@ -1 +1 @@
-ValueRef | @betty-blocks/component-sdk
\ No newline at end of file
diff --git a/docs/modules.html b/docs/modules.html
index 26409e6f..0e9af861 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -1,4 +1,4 @@
-@betty-blocks/component-sdk
- Preparing search index...
- The search index is not available
@betty-blocks/component-sdk@betty-blocks/component-sdk
Index
Enumerations
Interfaces
Type aliases
Functions
Type aliases
Action
Allowed
Before
Type declaration
components: {}
[name: string]: any
helpers: { BettyPrefabs: typeof BettyPrefabs; PropertyKind: typeof PropertyKind; addActionVariable: any; addModelAndProperties: any; addSchemaModel: 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 }
Betty
Property
add
Parameters
actionId: string
name: string
kind: ActionVariableKind
options: object
Returns Promise<ActionVariable>
add
Parameters
modelName: string
properties: ModelPropertyInput[]
Returns Promise<Model>
add
Parameters
name: string
jsonSchema: string
Returns Promise<SchemaModel>
camel
Parameters
str: string
Returns string
clone
Parameters
prefabName: string
Returns PrefabReference
create
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" | "OBJECT" | "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" | "OBJECT" | "PASSWORD" | "PDF" | "PERIODIC_COUNT" | "PHONE_NUMBER" | "PRICE" | "PRICE_EXPRESSION" | "RICH_TEXT" | "SERIAL" | "SIGNED_PDF" | "STRING" | "STRING_EXPRESSION" | "SUM" | "TEXT" | "TEXT_EXPRESSION" | "TIME" | "URL" | "ZIPCODE")[]
create
Returns string
get
Returns string
get
Returns string
make
Parameters
prefabName: string
model: Model
property: Property
variable: ActionVariable
Optional relatedIdProperties: string[][]
Optional relatedModelIds: Record<string, string>
Returns PrefabReference
make
Parameters
prefabName: string
model: Model
property: Property
variable: ActionVariable
Optional relatedIdProperties: string[][]
Optional relatedModelIds: Record<string, string>
Returns PrefabReference
prepare
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>
prepare
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" | "OBJECT" | "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" | "OBJECT" | "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>
set
Parameters
structure: PrefabComponent
key: string
transform: (option: PrefabComponentOption) => PrefabComponentOption
Parameters
option: PrefabComponentOption
Returns PrefabComponentOption
Returns void
use
Returns null | string
use
Returns string
use
Returns string
use
Returns null | string
use
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
use
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
use
Returns null | { id: string; name: string }
use
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
model
prefab: Prefab
prefabs: Prefab[]
close:function
Returns void
save:function
Parameters
prefab: Prefab
Returns void
Configuration
Hook
Type declaration
input: Record<string, Ref>
Optional output?: {}
[key: string]: Ref
query: string
Linked
Type declaration
Parameters
key: string
Returns PrefabWrapperLinkedOption
Linked
Type declaration
Parameters
key: string
Returns PrefabWrapperLinkedPartialOption
Option
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[]
Option
Type declaration
Parameters
key: string
Returns PrefabComponentOption
Prefab
Prefab
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[]
Prefab
Prefab
Prefab
Prefab
Prefab
Type declaration
Optional allowed
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 data
Optional show
Ref
Row
Style
Style
Style
Type declaration
Parameters
key: string
Returns PrefabComponentStyle
Style
Value
Functions
Const action
Parameters
label: string
attrs: Attributes
Returns OptionProducer
Const action
Parameters
label: string
attrs: Attributes
Returns OptionProducer
Const add
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const authentication
Parameters
label: string
attrs: Attributes
Returns OptionProducer
Const buttongroup
Parameters
label: string
options: [string, string, string?][]
attrs: Attributes = {}
Returns OptionProducer
Const child
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const color
Parameters
label: string
attrs: ColorAttributes
Returns OptionProducer
Const component
Create a component prefab
Parameters
name: string
name of the component
@@ -6,8 +6,8 @@attributes
descendants: PrefabReference[]
a list of child prefab components
-Returns PrefabComponent
Const display
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const dropdown
Parameters
label: string
options: [string, string][]
attrs: Attributes = {}
Returns OptionProducer
Const endpoint
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const filter
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const font
Parameters
label: string
attrs: Attributes
Returns OptionProducer
Const hide
Parameters
key: string
comparator: "EQ"
value: string | boolean
Returns undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
Const icon
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const linked
Parameters
attrs: Partial<Omit<PrefabWrapperLinkedOption, RedundantKeys>>
Returns LinkedOptionProducer
Const linked
Parameters
attrs: Partial<Omit<PrefabWrapperLinkedPartialOption, RedundantKeys>>
Returns LinkedPartialOptionProducer
Const model
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const model
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const number
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const option
Parameters
type: string
attrs: Attributes
Returns OptionProducer
Const partial
Returns PrefabComponent
Const display
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const dropdown
Parameters
label: string
options: [string, string][]
attrs: Attributes = {}
Returns OptionProducer
Const endpoint
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const filter
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const font
Parameters
label: string
attrs: Attributes
Returns OptionProducer
Const hide
Parameters
key: string
comparator: "EQ"
value: string | boolean
Returns undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
Const icon
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const linked
Parameters
attrs: Partial<Omit<PrefabWrapperLinkedOption, RedundantKeys>>
Returns LinkedOptionProducer
Const linked
Parameters
attrs: Partial<Omit<PrefabWrapperLinkedPartialOption, RedundantKeys>>
Returns LinkedPartialOptionProducer
Const model
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const model
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const number
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const option
Parameters
type: string
attrs: Attributes
Returns OptionProducer
Const partial
Create a partial prefab
-Returns PrefabReference
Const prefab
Parameters
name: string
attr: Attributes
beforeCreate: undefined | BeforeCreate
structure: PrefabReference[]
Returns Prefab
Const property
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const reconfigure
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const show
Parameters
key: string
comparator: "EQ"
value: string | boolean
Returns undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
Const show
Parameters
key: string
Returns undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
Const size
Parameters
label: string
attrs: Attributes
Returns OptionProducer
Const sizes
Parameters
label: string
attrs: Attributes
Returns OptionProducer
Const static
Parameters
value: string
Returns StaticValue
Const style
Parameters
type: string
__namedParameters: RequiredStyleAttrs
Returns StyleDefinition
Const style
Parameters
name: string
attrs: StyleReferenceAttrs
Returns StyleReference
Const text
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const theme
Parameters
value: string
Returns ThemeColorReference
Const toggle
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const variable
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const wrapper
Returns PrefabReference
Const prefab
Parameters
name: string
attr: Attributes
beforeCreate: undefined | BeforeCreate
structure: PrefabReference[]
Returns Prefab
Const property
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const reconfigure
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const show
Parameters
key: string
comparator: "EQ"
value: string | boolean
Returns undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
Const show
Parameters
key: string
Returns undefined | { comparator: "EQ"; option: string; type: "SHOW" | "HIDE"; value: string | boolean }
Const size
Parameters
label: string
attrs: Attributes
Returns OptionProducer
Const sizes
Parameters
label: string
attrs: Attributes
Returns OptionProducer
Const static
Parameters
value: string
Returns StaticValue
Const style
Parameters
type: string
__namedParameters: RequiredStyleAttrs
Returns StyleDefinition
Const style
Parameters
name: string
attrs: StyleReferenceAttrs
Returns StyleReference
Const text
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const theme
Parameters
value: string
Returns ThemeColorReference
Const toggle
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const variable
Parameters
label: string
attrs: Attributes = {}
Returns OptionProducer
Const wrapper
Create a wrapper prefab
Parameters
attrs: WrapperAttrs
descendants: PrefabReference[]
Returns PrefabReference
Generated using TypeDoc