Props
registerComponent Props
type
'none'
, 'record'
, 'list'
, 'nested-list'
, 'standalone-list'
Define the component type and how the component get its data.
record
- component with the data source is reference to the table selected in page contextlist
- component with a different data source from the page context, but the state property defined in its component would still reference from the table selected in page contextnested-list
- like alist
component, but used to get many to many or one to many data relationstandalone-list
- like alist
component, but the defined state property in this component is going to be reference from the table selected in this component source.
propDefinition
Object
Define the schema
of properties in the component
defaultProps
Object
Define the default value
for registered properties in propDefinition
Component
React Component
Render a custom component that will be shown on apps
Component props
hooks
source
Get detail of selected source table if you are using list
, nested-list
type component, standalone-list
.
pageSource
Get detail of selected source table if you are using record
type component.
properties
Value of the defined properties in propDefinition
instance
Schema of the component
Component props hooks
useTemplate
make a template of the string
value if the it's uses the suggested @
tag. if it's not, it would be trait as a normal string
useActionTrigger
create an action trigger, usually used with a property defined as action
type
sourceHooks
an axios client wrapper used to make request to selected source.
Last updated