@conciergus/chat - v0.3.1
Preparing search index...
hooks
ConciergusGenerativeUIHookReturn
Interface ConciergusGenerativeUIHookReturn
interface
ConciergusGenerativeUIHookReturn
{
config
:
ConciergusStreamConfig
;
updateConfig
:
(
updates
:
Partial
<
ConciergusStreamConfig
>
)
=>
void
;
generateUI
:
(
prompt
:
string
,
options
?:
{
type
?:
"component"
|
"layout"
|
"form"
|
"chart"
;
framework
?:
"react"
|
"vue"
|
"angular"
;
styling
?:
"tailwind"
|
"css"
|
"styled-components"
;
complexity
?:
"medium"
|
"simple"
|
"complex"
;
}
,
)
=>
Promise
<
GeneratedComponent
>
;
generatedComponents
:
GeneratedComponent
[]
;
getComponent
:
(
id
:
string
)
=>
GeneratedComponent
;
updateComponent
:
(
id
:
string
,
updates
:
Partial
<
GeneratedComponent
>
)
=>
void
;
removeComponent
:
(
id
:
string
)
=>
void
;
clearComponents
:
()
=>
void
;
isGenerating
:
boolean
;
currentGeneration
:
Partial
<
GeneratedComponent
>
;
validateComponent
:
(
component
:
GeneratedComponent
,
)
=>
{
isValid
:
boolean
;
issues
:
string
[]
;
suggestions
:
string
[]
}
;
sanitizeComponent
:
(
component
:
GeneratedComponent
)
=>
GeneratedComponent
;
getAvailableTemplates
:
()
=>
{
id
:
string
;
name
:
string
;
description
:
string
;
type
:
string
;
}
[]
;
applyTemplate
:
(
templateId
:
string
,
customization
?:
Record
<
string
,
any
>
,
)
=>
Promise
<
GeneratedComponent
>
;
onGenerationStart
:
(
callback
:
()
=>
void
)
=>
void
;
onGenerationUpdate
:
(
callback
:
(
partial
:
Partial
<
GeneratedComponent
>
)
=>
void
,
)
=>
void
;
onGenerationComplete
:
(
callback
:
(
component
:
GeneratedComponent
)
=>
void
,
)
=>
void
;
onGenerationError
:
(
callback
:
(
error
:
Error
)
=>
void
)
=>
void
;
}
Index
Properties
config
update
Config
generate
UI
generated
Components
get
Component
update
Component
remove
Component
clear
Components
is
Generating
current
Generation
validate
Component
sanitize
Component
get
Available
Templates
apply
Template
on
Generation
Start
on
Generation
Update
on
Generation
Complete
on
Generation
Error
Properties
config
config
:
ConciergusStreamConfig
update
Config
updateConfig
:
(
updates
:
Partial
<
ConciergusStreamConfig
>
)
=>
void
generate
UI
generateUI
:
(
prompt
:
string
,
options
?:
{
type
?:
"component"
|
"layout"
|
"form"
|
"chart"
;
framework
?:
"react"
|
"vue"
|
"angular"
;
styling
?:
"tailwind"
|
"css"
|
"styled-components"
;
complexity
?:
"medium"
|
"simple"
|
"complex"
;
}
,
)
=>
Promise
<
GeneratedComponent
>
generated
Components
generatedComponents
:
GeneratedComponent
[]
get
Component
getComponent
:
(
id
:
string
)
=>
GeneratedComponent
update
Component
updateComponent
:
(
id
:
string
,
updates
:
Partial
<
GeneratedComponent
>
)
=>
void
remove
Component
removeComponent
:
(
id
:
string
)
=>
void
clear
Components
clearComponents
:
()
=>
void
is
Generating
isGenerating
:
boolean
current
Generation
currentGeneration
:
Partial
<
GeneratedComponent
>
validate
Component
validateComponent
:
(
component
:
GeneratedComponent
,
)
=>
{
isValid
:
boolean
;
issues
:
string
[]
;
suggestions
:
string
[]
}
sanitize
Component
sanitizeComponent
:
(
component
:
GeneratedComponent
)
=>
GeneratedComponent
get
Available
Templates
getAvailableTemplates
:
()
=>
{
id
:
string
;
name
:
string
;
description
:
string
;
type
:
string
;
}
[]
apply
Template
applyTemplate
:
(
templateId
:
string
,
customization
?:
Record
<
string
,
any
>
,
)
=>
Promise
<
GeneratedComponent
>
on
Generation
Start
onGenerationStart
:
(
callback
:
()
=>
void
)
=>
void
on
Generation
Update
onGenerationUpdate
:
(
callback
:
(
partial
:
Partial
<
GeneratedComponent
>
)
=>
void
,
)
=>
void
on
Generation
Complete
onGenerationComplete
:
(
callback
:
(
component
:
GeneratedComponent
)
=>
void
,
)
=>
void
on
Generation
Error
onGenerationError
:
(
callback
:
(
error
:
Error
)
=>
void
)
=>
void
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
config
update
Config
generate
UI
generated
Components
get
Component
update
Component
remove
Component
clear
Components
is
Generating
current
Generation
validate
Component
sanitize
Component
get
Available
Templates
apply
Template
on
Generation
Start
on
Generation
Update
on
Generation
Complete
on
Generation
Error
@conciergus/chat - v0.3.1
Loading...