@journeyapps/reactor-mod
Enumerations
Classes
Interfaces
AbstractActionParameterOptions
Extended by
Properties
| Property | Type | Description |
|---|---|---|
description? | string | - |
getDefault? | () => any | - |
name | string | - |
required? | boolean | Default true |
AbstractControl
Methods
representAsBtn()
representAsBtn(): Btn;
Returns
representAsComboBoxItems()
representAsComboBoxItems(options?): ComboBoxItem[];
Parameters
| Parameter | Type |
|---|---|
options? | RepresentAsComboBoxItemsEvent |
Returns
representAsControl()
representAsControl(options?): Element;
Parameters
| Parameter | Type |
|---|---|
options? | RepresentAsControlOptions |
Returns
Element
AbstractDialogDirectiveListener
Properties
| Property | Type |
|---|---|
disposed | (event) => any |
AbstractDialogDirectiveOptions
Extended by
Properties
| Property | Type |
|---|---|
markdown? | string |
title? | string |
AbstractInteractiveControlOptions
Extends
Extended by
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
category? | string | - | - |
description? | string | - | - |
key | string | - | AbstractSettingOptions.key |
name? | string | - | - |
serializeID? | string | used for busting the serialization if we have made fundamental changes that are not backwards compatible | AbstractSettingOptions.serializeID |
AbstractMediaOptions
Properties
| Property | Type |
|---|---|
content | AssetContent |
name | string |
type | AbstractMediaType |
uid | string |
AbstractMediaTypeOptions
Properties
| Property | Type |
|---|---|
displayName | string |
extensions | string[] |
icon | ReactorIcon |
mime | string |
AbstractPersistedStoreListener
Extends
Extended by
Properties
| Property | Type | Inherited from |
|---|---|---|
deserialized | () => any | - |
initialized | () => any | AbstractStoreListener.initialized |
AbstractPersistedStoreOptions
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Inherited from |
|---|---|---|
listenToExternalChanges? | boolean | - |
name | string | AbstractStoreOptions.name |
serializer | AbstractSerializer<T> | - |
AbstractPresenterContextSettings
Extended by
Properties
| Property | Type |
|---|---|
groupBy | GroupingOption |
AbstractReactorModuleOptions
Properties
| Property | Type |
|---|---|
name | string |
AbstractReactorPanelFactoryOptions
Properties
| Property | Type | Description |
|---|---|---|
allowManualCreation? | boolean | User can create this panel through configurator or cmd pallet Default true |
category? | string | - |
color? | string | - |
icon | ReactorIcon | - |
icon2? | ReactorIcon | - |
isMultiple | boolean | - |
name | string | - |
padding? | boolean | - |
renderTitlebar? | boolean | Whether the panel renders its titlebar when displayed outside a tab. Default true |
type | string | - |
urlEnabled? | boolean | Panel can be serialized to URL when active Default false |
validators? | ActionValidator<unknown>[] | - |
AbstractSerializerListener
Properties
| Property | Type |
|---|---|
gotExternalChanges | () => any |
AbstractSettingListener
Methods
updated()
updated(): any;
Returns
any
AbstractSettingOptions
Extended by
Properties
| Property | Type | Description |
|---|---|---|
key | string | - |
serializeID? | string | used for busting the serialization if we have made fundamental changes that are not backwards compatible |
AbstractStoreListener
Extended by
AbstractPersistedStoreListenerComboBoxStoreListenerDialogListenerBatchStoreListenerThemeStoreListenerGuideStoreListenerComboBoxStore2ListenerActionStoreListener
Properties
| Property | Type |
|---|---|
initialized | () => any |
AbstractStoreOptions
Extended by
Properties
| Property | Type |
|---|---|
name | string |
AbstractTreePresenterContextListener
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends any | any |
Properties
| Property | Type | Inherited from |
|---|---|---|
disposed? | () => any | PresenterContextListener.disposed |
stateChanged? | () => any | PresenterContextListener.stateChanged |
treeGenerated? | (event) => any | - |
AbstractValueControlListener
Type Parameters
| Type Parameter |
|---|
Value |
Properties
| Property | Type |
|---|---|
optionsUpdated? | () => any |
valueChanged | (value) => any |
AbstractValueControlOptions
Extended by
Type Parameters
| Type Parameter |
|---|
Value |
Properties
| Property | Type |
|---|---|
initialValue | Value |
ActionButtonControlOptions
Type Parameters
| Type Parameter |
|---|
T extends Action |
Properties
| Property | Type |
|---|---|
action | T |
getEventData? | () => Partial<EventType<T>> |
ActionComboBoxItem
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends Action | Action |
Properties
| Property | Type | Inherited from |
|---|---|---|
action? | (event) => Promise<any> | ComboBoxItem.action |
actionObject | T | - |
badge? | { action?: (event) => any; background: string; foreground: string; label: string; } | ComboBoxItem.badge |
badge.action? | (event) => any | - |
badge.background | string | - |
badge.foreground | string | - |
badge.label | string | - |
children? | ComboBoxItem[] | ComboBoxItem.children |
color? | string | ComboBoxItem.color |
disabled? | boolean | ComboBoxItem.disabled |
download? | { name: string; url: string; } | ComboBoxItem.download |
download.name | string | - |
download.url | string | - |
forwardRef? | RefObject<HTMLDivElement> | ComboBoxItem.forwardRef |
group? | string | ComboBoxItem.group |
icon? | ReactorIcon | ComboBoxItem.icon |
key | string | ComboBoxItem.key |
link? | string | ComboBoxItem.link |
right? | Element | ComboBoxItem.right |
title | string | ComboBoxItem.title |
titleMatch? | SearchEventMatch | ComboBoxItem.titleMatch |
validator? | Validator | ComboBoxItem.validator |
ActionEvent
Extended by
Properties
| Property | Type |
|---|---|
canceled? | boolean |
fireBehaviorChecks? | boolean |
getStatus? | () => VisorLoadingDirective |
id | string |
position? | MousePosition |
source | ActionSource |
ActionGenerics
Extended by
Properties
| Property | Type |
|---|---|
EVENT | ActionEvent |
OPTIONS | ActionOptions |
ActionHeaderButtonWidgetProps
Properties
| Property | Type |
|---|---|
action | Action |
remove | () => any |
vertical | boolean |
ActionListener
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends ActionEvent | ActionEvent |
Properties
| Property | Type |
|---|---|
cancelled | (event) => void |
didFire | (event) => void |
willFire | (event) => Promise<void> |
ActionOptions
Extended by
Properties
| Property | Type | Description |
|---|---|---|
aliases? | string[] | Complete alternative names used to discover this action. |
behavior? | ActionMacroBehavior | - |
category? | { entityType?: string; grouping?: string; } | - |
category.entityType? | string | - |
category.grouping? | string | - |
exemptFromExclusiveExecutionLock? | boolean | - |
hideFromCmdPallet? | boolean | - |
hotkeys? | ShortcutChord[] | - |
icon | ReactorIcon | - |
id | string | - |
name | string | - |
rollbackMechanic? | ActionRollbackMechanic | - |
tags? | string[] | Searchable terms describing this action. The action behavior is included automatically. |
validators? | ActionValidator<unknown>[] | - |
ActionStoreListener
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
actionFired? | (event) => void | - |
actionWillFire? | (event) => Promise<any> | - |
initialized | () => any | AbstractStoreListener.initialized |
ActionStoreOptions
Properties
| Property | Type |
|---|---|
comboBoxStore2 | ComboBoxStore2 |
AddModelsOptions
Properties
| Property | Type |
|---|---|
exclude? | WorkspaceModel |
hint? | WorkspaceHint |
parent? | WorkspaceCollectionModel |
AnchoredOverlayBounds
Properties
| Property | Type |
|---|---|
bottom? | number |
height | number |
left | number |
right? | number |
top | number |
width | number |
AnchoredOverlayOptions
Properties
| Property | Type |
|---|---|
bounds | AnchoredOverlayBounds |
clickThrough | boolean |
id? | string |
placement | AnchoredOverlayPlacement |
render | (context) => ReactNode |
source | string |
AnchoredOverlayRecordListener
Properties
| Property | Type |
|---|---|
hidden | () => any |
AnchoredOverlayRenderContext
Properties
| Property | Type |
|---|---|
above | boolean |
placement | AnchoredOverlayPlacement |
ArrayInputGenerics
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Overrides |
|---|---|---|
LISTENER | ArrayInputListener | FormInputGenerics.LISTENER |
OPTIONS | ArrayInputOptions<T> | FormInputGenerics.OPTIONS |
VALUE | T[] | FormInputGenerics.VALUE |
ArrayInputListener
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
errorChanged | (event) => any | FormInputListener.errorChanged |
loadingChanged | () => any | - |
optionsUpdated | () => any | FormInputListener.optionsUpdated |
removed | () => any | FormInputListener.removed |
valueChanged | (event) => any | FormInputListener.valueChanged |
visibilityChanged | () => any | FormInputListener.visibilityChanged |
ArrayInputOptions
Extends
FormInputOptions<T[]>
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
desc? | string | - | FormInputOptions.desc |
disabled? | boolean | - | FormInputOptions.disabled |
generate | () => FormInput | - | - |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | FormInputOptions.hideError |
label | string | - | FormInputOptions.label |
name? | string | - | FormInputOptions.name |
placeholder? | string | - | FormInputOptions.placeholder |
required? | boolean | - | FormInputOptions.required |
size? | Size | - | FormInputOptions.size |
tooltip? | string | Expressed as markdown | FormInputOptions.tooltip |
value? | T[] | - | FormInputOptions.value |
visible? | boolean | - | FormInputOptions.visible |
ArrayInputWidgetProps
Properties
| Property | Type |
|---|---|
input | ArrayInput<any> |
ArraySetInputGenerics
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Overrides |
|---|---|---|
LISTENER | ArraySetInputListener | FormInputGenerics.LISTENER |
OPTIONS | ArraySetInputOptions<T> | FormInputGenerics.OPTIONS |
VALUE | { [key: string]: T; } | FormInputGenerics.VALUE |
ArraySetInputListener
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
errorChanged | (event) => any | FormInputListener.errorChanged |
loadingChanged | () => any | - |
optionsUpdated | () => any | FormInputListener.optionsUpdated |
removed | () => any | FormInputListener.removed |
valueChanged | (event) => any | FormInputListener.valueChanged |
visibilityChanged | () => any | FormInputListener.visibilityChanged |
ArraySetInputOptions
Extends
FormInputOptions<{ [key:string]:T; }>
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
addbutton? | Partial<Btn> | - | - |
desc? | string | - | FormInputOptions.desc |
disabled? | boolean | - | FormInputOptions.disabled |
entries | ComboBoxItem[] | - | - |
generate | (key) => FormInput | - | - |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | FormInputOptions.hideError |
label | string | - | FormInputOptions.label |
layout? | { scrollLength: number; } | - | - |
layout.scrollLength | number | - | - |
name? | string | - | FormInputOptions.name |
placeholder? | string | - | FormInputOptions.placeholder |
required? | boolean | - | FormInputOptions.required |
size? | Size | - | FormInputOptions.size |
tooltip? | string | Expressed as markdown | FormInputOptions.tooltip |
value? | { [key: string]: T; } | - | FormInputOptions.value |
visible? | boolean | - | FormInputOptions.visible |
ArraySetInputWidgetProps
Properties
| Property | Type |
|---|---|
input | ArraySetInput<any> |
AttentionWrapperWidgetProps
Extends
UseAttentionProps<V,T>
Type Parameters
| Type Parameter | Default type |
|---|---|
V extends object | object |
T extends ComponentSelection<V> | ComponentSelection<V> |
Properties
| Property | Type | Inherited from |
|---|---|---|
activated | (selected) => Element | - |
boundsMutator? | (bounds) => MutableRect | UseAttentionProps.boundsMutator |
forwardRef? | RefObject<HTMLElement> | UseAttentionProps.forwardRef |
ready? | boolean | UseAttentionProps.ready |
selection? | V | UseAttentionProps.selection |
type | string | UseAttentionProps.type |
BaseActionSelectionParameters
Properties
| Property | Type |
|---|---|
additional? | ParameterizedAction<Partial<ParameterizedActionGenerics>, ParameterizedActionGenerics & Partial<ParameterizedActionGenerics>>[] |
event? | MousePosition |
exclude? | string[] |
source | ActionSource |
BaseComboBoxDirectiveOptions
Extends
ComboBoxDirectiveOptions
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ComboBoxItem | ComboBoxItem |
Properties
| Property | Type | Inherited from |
|---|---|---|
centerOnMobile? | boolean | ComboBoxDirectiveOptions.centerOnMobile |
event? | MousePosition | ComboBoxDirectiveOptions.event |
hideSearch? | boolean | - |
items | T[] | - |
searchPlaceholder? | string | ComboBoxDirectiveOptions.searchPlaceholder |
sort? | boolean | - |
subtitle? | string | ComboBoxDirectiveOptions.subtitle |
title? | string | ComboBoxDirectiveOptions.title |
BaseComboBoxDirectiveWidgetProps
Properties
| Property | Type |
|---|---|
directive | BaseComboBoxDirective |
BaseInlineTreePresenterComponentOptions
Extends
Extended by
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Inherited from |
|---|---|---|
allowedGroupingSettings? | { complexName?: boolean; labels?: string[]; tags?: boolean; } | GroupBySettingOptions.allowedGroupingSettings |
allowedGroupingSettings.complexName? | boolean | - |
allowedGroupingSettings.labels? | string[] | - |
allowedGroupingSettings.tags? | boolean | - |
augmentTreeNodeProps? | (entity, hover) => Partial<TreeWidgetProps> | - |
augmentTreeProps? | (entity, hover) => Partial<TreeLeafWidgetProps> | - |
defaultGroupingSetting? | GroupingOption | GroupBySettingOptions.defaultGroupingSetting |
label? | string | EntityTreePresenterComponentOptions.label |
loadChildrenAsNodesAreOpened? | boolean | EntityTreePresenterComponentOptions.loadChildrenAsNodesAreOpened |
maxTags? | number | EntityTreePresenterComponentOptions.maxTags |
metadataDisplayOptions? | MetadataDisplayOptions | EntityTreePresenterComponentOptions.metadataDisplayOptions |
searchScope? | SearchableTreeSearchScope | EntityTreePresenterComponentOptions.searchScope |
tagDisplayMode? | TagDisplayMode | EntityTreePresenterComponentOptions.tagDisplayMode |
BatchStoreListener
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
finishedFiringBatchActions | () => any | - |
initialized | () => any | AbstractStoreListener.initialized |
willFireBatchActions | () => any | - |
BatchStoreOptions
Properties
| Property | Type |
|---|---|
actionStore | ActionStore |
comboBoxStore | ComboBoxStore2 |
dialogStore | DialogStore |
system | System |
visorStore | VisorStore |
BodyWidgetProps
Properties
| Property | Type |
|---|---|
additionalFooterContent? | Element |
additionalFooterRightBtns? | Btn[] |
additionalLayers? | LayerDirective[] |
additionalLeftHeaderButtons? | Btn[] |
additionalRightHeaderContent? | Element |
lock? | boolean |
logo | string |
logoClicked | (event) => any |
wrapFooter? | (getFooter) => Element |
BooleanControlOptions
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
category? | string | - | AbstractInteractiveControlOptions.category |
changed? | (checked) => any | - | - |
checked | boolean | - | - |
description? | string | - | AbstractInteractiveControlOptions.description |
key | string | - | AbstractInteractiveControlOptions.key |
name? | string | - | AbstractInteractiveControlOptions.name |
serializeID? | string | used for busting the serialization if we have made fundamental changes that are not backwards compatible | AbstractInteractiveControlOptions.serializeID |
BooleanControlWidgetProps
Properties
| Property | Type |
|---|---|
checkbox? | boolean |
control | BooleanControl |
disabled? | boolean |
label? | string |
size? | Size |
BooleanInputOptions
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
desc? | string | - | FormInputOptions.desc |
disabled? | boolean | - | FormInputOptions.disabled |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | FormInputOptions.hideError |
label | string | - | FormInputOptions.label |
name? | string | - | FormInputOptions.name |
placeholder? | string | - | FormInputOptions.placeholder |
renderWithLabel? | boolean | - | - |
required? | boolean | - | FormInputOptions.required |
size? | Size | - | FormInputOptions.size |
tooltip? | string | Expressed as markdown | FormInputOptions.tooltip |
value? | any | - | FormInputOptions.value |
visible? | boolean | - | FormInputOptions.visible |
BooleanInputWrapperWidgetProps
Properties
| Property | Type |
|---|---|
input | BooleanInput |
BorderLayoutWidgetProps
Properties
| Property | Type |
|---|---|
bottom? | Element |
className? | any |
top? | Element |
BreadCrumbTabSelectionWidgetProps
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
badgeProvider? | (key) => TabBadgeDirective | TabSelectionWidgetProps.badgeProvider |
className? | any | TabSelectionWidgetProps.className |
compact? | boolean | TabSelectionWidgetProps.compact |
limitSelectionProgression | boolean | - |
selected | string | TabSelectionWidgetProps.selected |
selectedBoundsUpdated? | (rect) => any | TabSelectionWidgetProps.selectedBoundsUpdated |
size? | Size | TabSelectionWidgetProps.size |
tabRightClick? | (event, tab) => any | TabSelectionWidgetProps.tabRightClick |
tabs | TabDirective[] | TabSelectionWidgetProps.tabs |
tabSelected | (key) => any | TabSelectionWidgetProps.tabSelected |
vertical? | boolean | TabSelectionWidgetProps.vertical |
BreadCrumbWidgetProps
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
backgroundColor | string | - |
compact? | boolean | TabItemWidgetProps.compact |
customContent? | Element | TabItemWidgetProps.customContent |
disabled? | boolean | TabItemWidgetProps.disabled |
forwardRef | RefObject<HTMLDivElement> | TabItemWidgetProps.forwardRef |
label | string | TabItemWidgetProps.label |
onMouseEnter? | (event) => any | TabItemWidgetProps.onMouseEnter |
onMouseLeave? | (event) => any | TabItemWidgetProps.onMouseLeave |
selected | boolean | TabItemWidgetProps.selected |
size? | Size | TabItemWidgetProps.size |
tabRightClick | (event) => any | TabItemWidgetProps.tabRightClick |
tabSelected | (event) => any | TabItemWidgetProps.tabSelected |
vertical? | boolean | TabItemWidgetProps.vertical |
Btn
Extends
Extended by
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
action? | ButtonAction | - | - | - |
disabled? | boolean | - | - | - |
forwardRef? | RefObject<HTMLDivElement> | - | - | - |
highlight? | boolean | - | - | - |
icon? | ReactorIcon | - | - | - |
label? | string | - | - | - |
submitButton? | boolean | - | - | - |
tooltip? | string | - | TooltipProps.tooltip | - |
tooltipDelay? | number | Hover delay in milliseconds before showing the tooltip. Defaults to zero. | - | TooltipProps.tooltipDelay |
tooltipPos? | TooltipPosition | - | - | TooltipProps.tooltipPos |
tooltipState? | SHOW | - | - | TooltipProps.tooltipState |
validator? | Validator | - | - | - |
ButtonComponentSelection
Properties
| Property | Type |
|---|---|
label | string |
ButtonControlOptions
Properties
| Property | Type |
|---|---|
btn | Btn | (() => Btn) |
CardWidgetProps
Properties
| Property | Type |
|---|---|
btns? | PanelBtn[] |
className? | any |
color? | string |
depth? | SurfaceDepth |
loader? | { color?: string; meta?: ReadOnlyMetadataWidgetProps[]; percentage: number; } |
loader.color? | string |
loader.meta? | ReadOnlyMetadataWidgetProps[] |
loader.percentage | number |
sections | { content: () => Element; grow?: boolean; key: string; }[] |
selected? | boolean |
size? | Size |
subHeading? | string | Element |
subHeadingColor? | string |
title | string | Element |
CascadingSearchEngineComboBoxDirectiveOptions
Extends
ComboBoxDirectiveOptions
Type Parameters
| Type Parameter |
|---|
T extends ComboBoxItem |
Properties
| Property | Type | Inherited from |
|---|---|---|
centerOnMobile? | boolean | ComboBoxDirectiveOptions.centerOnMobile |
directives | ComboBoxDirective<T, ComboBoxDirectiveOptions<T>>[] | - |
event? | MousePosition | ComboBoxDirectiveOptions.event |
passValueToNextDirective | (item, nextEngine) => any | - |
searchPlaceholder? | string | ComboBoxDirectiveOptions.searchPlaceholder |
subtitle? | string | ComboBoxDirectiveOptions.subtitle |
title? | string | ComboBoxDirectiveOptions.title |
CascadingSearchEngineComboBoxDirectiveWidgetProps
Properties
| Property | Type |
|---|---|
directive | CascadingSearchEngineComboBoxDirective |
CheckboxLabelWidgetProps
Extends
Properties
| Property | Type | Overrides | Inherited from |
|---|---|---|---|
checked | boolean | - | CheckboxWidgetProps.checked |
className? | any | CheckboxWidgetProps.className | - |
disabled? | boolean | - | - |
label | string | - | - |
onChange | (checked) => any | - | CheckboxWidgetProps.onChange |
size? | Size | - | CheckboxWidgetProps.size |
CheckboxWidgetProps
Extended by
Properties
| Property | Type |
|---|---|
checked | boolean |
className? | any |
onChange | (checked) => any |
size? | Size |
CMDPalletGenerateResultWidgetEvent
Properties
| Property | Type |
|---|---|
key | string |
mouseClicked | (event) => any |
mouseEntered | () => any |
ref | RefObject<HTMLDivElement> |
selected | boolean |
CMDPalletSearchEngineCategory
Properties
| Property | Type |
|---|---|
engines | CMDPalletSearchEngine<CommandPalletSearchResultEntry>[] |
hotkeys | ShortcutChord[] |
name | string |
CMDPalletSearchEngineResultOptions
Properties
| Property | Type |
|---|---|
buttons? | Btn[] |
showMore? | () => any |
showMoreText? | string |
ColorDefinition
Properties
| Property | Type |
|---|---|
category | string |
categoryLabel | string |
key | string |
label | string |
ColorPickerWidgetProps
Properties
| Property | Type |
|---|---|
color | string |
colorChanged | (color) => any |
ColorPickerWidgetState
Properties
| Property | Type |
|---|---|
openColor | string |
show | boolean |
ColorPickerWithFieldWidgetProps
Properties
| Property | Type |
|---|---|
color | string |
colorChanged | (color) => any |
ColorPickerWithFieldWidgetState
Properties
| Property | Type |
|---|---|
color | string |
propColor | string |
ColumnsFormModelOptions
Properties
| Property | Type |
|---|---|
columnSpacing? | number |
columnWidths? | number[] |
mode? | ColumnsFormModelRenderMode |
ComboBoxCheckedItem
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
action? | (event) => Promise<any> | ComboBoxItem.action |
badge? | { action?: (event) => any; background: string; foreground: string; label: string; } | ComboBoxItem.badge |
badge.action? | (event) => any | - |
badge.background | string | - |
badge.foreground | string | - |
badge.label | string | - |
checked? | boolean | - |
children? | ComboBoxItem[] | ComboBoxItem.children |
color? | string | ComboBoxItem.color |
disabled? | boolean | ComboBoxItem.disabled |
download? | { name: string; url: string; } | ComboBoxItem.download |
download.name | string | - |
download.url | string | - |
forwardRef? | RefObject<HTMLDivElement> | ComboBoxItem.forwardRef |
group? | string | ComboBoxItem.group |
icon? | ReactorIcon | ComboBoxItem.icon |
key | string | ComboBoxItem.key |
link? | string | ComboBoxItem.link |
right? | Element | ComboBoxItem.right |
title | string | ComboBoxItem.title |
titleMatch? | SearchEventMatch | ComboBoxItem.titleMatch |
validator? | Validator | ComboBoxItem.validator |
ComboBoxItem
Extended by
Properties
| Property | Type |
|---|---|
action? | (event) => Promise<any> |
badge? | { action?: (event) => any; background: string; foreground: string; label: string; } |
badge.action? | (event) => any |
badge.background | string |
badge.foreground | string |
badge.label | string |
children? | ComboBoxItem[] |
color? | string |
disabled? | boolean |
download? | { name: string; url: string; } |
download.name | string |
download.url | string |
forwardRef? | RefObject<HTMLDivElement> |
group? | string |
icon? | ReactorIcon |
key | string |
link? | string |
right? | Element |
title | string |
titleMatch? | SearchEventMatch |
validator? | Validator |
ComboBoxItemSelectedEvent
Properties
| Property | Type |
|---|---|
items | ComboBoxItem[] |
preventDefault | () => any |
ComboBoxOptions
Properties
| Property | Type |
|---|---|
title? | string |
title2? | string |
ComboBoxSearchEngine
Extends
SearchEngineInterface<T>
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ComboBoxSearchEngineResultEntry | ComboBoxSearchEngineResultEntry |
Methods
doSearch()
doSearch(event): SearchResult<T>;
Parameters
| Parameter | Type |
|---|---|
event | SearchEvent |
Returns
SearchResult<T>
Inherited from
SearchEngineInterface.doSearch
ComboBoxSearchEngineResultEntry
Extends
SearchResultEntry.ComboBoxItem
Properties
| Property | Type | Inherited from |
|---|---|---|
action? | (event) => Promise<any> | ComboBoxItem.action |
badge? | { action?: (event) => any; background: string; foreground: string; label: string; } | ComboBoxItem.badge |
badge.action? | (event) => any | - |
badge.background | string | - |
badge.foreground | string | - |
badge.label | string | - |
children? | ComboBoxItem[] | ComboBoxItem.children |
color? | string | ComboBoxItem.color |
disabled? | boolean | ComboBoxItem.disabled |
download? | { name: string; url: string; } | ComboBoxItem.download |
download.name | string | - |
download.url | string | - |
forwardRef? | RefObject<HTMLDivElement> | ComboBoxItem.forwardRef |
group? | string | ComboBoxItem.group |
icon? | ReactorIcon | ComboBoxItem.icon |
key | string | ComboBoxItem.key |
link? | string | ComboBoxItem.link |
right? | Element | ComboBoxItem.right |
title | string | ComboBoxItem.title |
titleMatch? | SearchEventMatch | ComboBoxItem.titleMatch |
validator? | Validator | ComboBoxItem.validator |
ComboBoxStore2Listener
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
directiveAdded | (directive) => any | - |
initialized | () => any | AbstractStoreListener.initialized |
ComboBoxStoreListener
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
initialized | () => any | AbstractStoreListener.initialized |
itemsSelected? | (event) => any | - |
itemsShown? | () => any | - |
ComboBoxWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
hovered? | (selected, dimensions?) => any |
initialSelected? | string |
items | ComboBoxItem[] |
maxHeight? | number |
placeholder? | string |
selected | (selected, event) => any |
ComboSearchBoxWidgetProps
Properties
| Property | Type |
|---|---|
hint? | string |
initialSelected? | string |
items | ComboBoxItem[] |
loading? | boolean |
scaleInOnMobile? | boolean |
searchChanged | (search) => any |
selected | (selected, event) => any |
title? | string |
CommandPalletCategoryWidgetProps
Properties
| Property | Type |
|---|---|
btns? | Btn[] |
close | () => any |
loading | boolean |
name | string |
showMore | string |
showMoreAction | () => any |
CommandPalletEntryWidgetProps
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
color | string | PartialEntryProps.color |
disabled? | boolean | PartialEntryProps.disabled |
forwardRef? | RefObject<HTMLDivElement> | - |
icon | ReactorIcon | PartialEntryProps.icon |
mouseClicked? | (event) => any | - |
mouseEntered? | () => any | - |
primary | string | PartialEntryProps.primary |
secondary? | string | PartialEntryProps.secondary |
selected? | boolean | PartialEntryProps.selected |
CommandPalletSearchEngineOptions
Properties
| Property | Type |
|---|---|
displayName | string |
limit? | number | false |
priority? | number |
CommandPalletSearchResultEntry
Extends
SearchResultEntry
Properties
| Property | Type | Inherited from |
|---|---|---|
engine | CMDPalletSearchEngine | - |
getWidget | (event) => Element | - |
immediatelyClose? | boolean | - |
key | string | SearchResultEntry.key |
CommandPalletWidgetProps
Properties
| Property | Type |
|---|---|
close? | () => any |
mobile? | boolean |
searchChanged | (search, tab) => any |
tabs | TabDirective[] |
tabSelected | string |
wheelScroll | () => any |
CommandPalletWidgetState
Properties
| Property | Type |
|---|---|
search | string |
selected | string |
ComponentSelectionListener
Properties
| Property | Type |
|---|---|
deactivated | () => any |
ComponentSelectionOptions
Type Parameters
| Type Parameter |
|---|
I |
Properties
| Property | Type |
|---|---|
identifier? | I |
type | string |
ComposableComboBoxDirectiveOptions
Extends
ComboBoxDirectiveOptions
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ComboBoxItem | ComboBoxItem |
Properties
| Property | Type | Inherited from |
|---|---|---|
centerOnMobile? | boolean | ComboBoxDirectiveOptions.centerOnMobile |
directives | ComboBoxDirective<T, ComboBoxDirectiveOptions<T>>[] | - |
event? | MousePosition | ComboBoxDirectiveOptions.event |
searchPlaceholder? | string | ComboBoxDirectiveOptions.searchPlaceholder |
subtitle? | string | ComboBoxDirectiveOptions.subtitle |
title? | string | ComboBoxDirectiveOptions.title |
ComposableComboBoxDirectiveWidgetProps
Properties
| Property | Type |
|---|---|
directive | ComposableComboBoxDirective |
ConfirmDialogDirective
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
disableDescriptionOpacity? | boolean | - | DialogDirective.disableDescriptionOpacity |
id | string | - | DialogDirective.id |
markdown? | string | - | DialogDirective.markdown |
menuItems? | ComboBoxItem[] | - | DialogDirective.menuItems |
menuItemSelected? | (selected) => any | - | DialogDirective.menuItemSelected |
message? | string | - | DialogDirective.message |
noBtn? | Partial<Btn> | - | - |
preventDismiss? | boolean | Prevent dismissing dialog by clicking on the backdrop. | DialogDirective.preventDismiss |
resolve | (val?) => any | - | DialogDirective.resolve |
title | string | - | DialogDirective.title |
type | DialogType | - | DialogDirective.type |
yesBtn? | Partial<Btn> | - | - |
ConfirmDialogOptions
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
disableDescriptionOpacity? | boolean | - | DialogDirective.disableDescriptionOpacity |
markdown? | string | - | DialogDirective.markdown |
menuItems? | ComboBoxItem[] | - | DialogDirective.menuItems |
menuItemSelected? | (selected) => any | - | DialogDirective.menuItemSelected |
message? | string | - | DialogDirective.message |
noBtn? | Partial<Btn> | - | - |
preventDismiss? | boolean | Prevent dismissing dialog by clicking on the backdrop. | DialogDirective.preventDismiss |
title | string | - | DialogDirective.title |
yesBtn? | Partial<Btn> | - | - |
ContextMenuTriggerWidgetProps
Properties
| Property | Type |
|---|---|
children | ReactNode |
className? | string |
disabled? | boolean |
onClick? | (event) => any |
onContextMenu? | (position) => any |
ControlledListWidgetProps
Properties
| Property | Type |
|---|---|
hovered? | (item) => any |
initialSelected? | string |
items | ListItem[] |
selected | (item, event) => any |
useKeyboard | boolean |
ControlledSearchWidgetProps
Extends
Omit<SearchWidgetProps,"search">
Properties
| Property | Type | Overrides | Inherited from |
|---|---|---|---|
className? | any | SearchWidgetProps.className | - |
design? | SearchWidgetDesign | - | SearchWidgetProps.design |
focusOnMount? | boolean | - | SearchWidgetProps.focusOnMount |
historyContext? | string | - | SearchWidgetProps.historyContext |
icon? | ReactorIcon | - | SearchWidgetProps.icon |
initialValue? | string | - | - |
inputRef? | RefObject<HTMLInputElement> | - | SearchWidgetProps.inputRef |
loading? | boolean | - | SearchWidgetProps.loading |
placeholder? | string | - | SearchWidgetProps.placeholder |
rounded? | boolean | - | SearchWidgetProps.rounded |
searchChanged | (search) => any | SearchWidgetProps.searchChanged | - |
size? | Size | - | SearchWidgetProps.size |
ControlledSearchWidgetState
Properties
| Property | Type |
|---|---|
value | string |
CoreRenderTreeEvent
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends TreeEntityInterface | TreeEntityInterface |
Properties
| Property | Type |
|---|---|
depth | number |
entity | T |
CoreRenderTreeLeafEvent
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends TreeEntity | TreeEntity |
Properties
| Property | Type | Inherited from |
|---|---|---|
depth | number | CoreRenderTreeEvent.depth |
entity | T | CoreRenderTreeEvent.entity |
CoreRenderTreeNodeEvent
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends TreeNode | TreeNode |
Properties
| Property | Type | Inherited from |
|---|---|---|
children | () => any | - |
depth | number | CoreRenderTreeEvent.depth |
entity | T | CoreRenderTreeEvent.entity |
props | Pick<TreeWidgetProps, "onCollapsedChanged" | "collapsed" | "empty" | "emptyMessage"> | - |
CoreTreeWidgetProps
Properties
| Property | Type | Default value | Description |
|---|---|---|---|
depth? | number | undefined | - |
events? | { updated: () => any; } | undefined | - |
events.updated | () => any | undefined | - |
forwardRef? | RefObject<HTMLDivElement> | undefined | - |
hasMatchedChildren? | (matched) => any | undefined | - |
renderTreeLeaf? | (event) => Element | undefined | - |
renderTreeNode? | (event) => Element | undefined | - |
reserveNodeToggleSpace? | boolean | true | Reserve one level of indentation for a node toggle when rendering a leaf. Disable this for inline trees whose leaves should align with their containing content. |
search? | SearchEvent | undefined | - |
searchScope? | SearchableTreeSearchScope | undefined | - |
tree | TreeEntity | undefined | - |
CoupledActionEvent
Extends
EntityActionEvent<TARGET>
Type Parameters
| Type Parameter | Default type |
|---|---|
TARGET | any |
SOURCE | any |
Properties
| Property | Type | Overrides | Inherited from |
|---|---|---|---|
canceled? | boolean | - | EntityActionEvent.canceled |
entities? | { } | - | EntityActionEvent.entities |
fireBehaviorChecks? | boolean | - | EntityActionEvent.fireBehaviorChecks |
getStatus? | () => VisorLoadingDirective | - | EntityActionEvent.getStatus |
id | string | - | EntityActionEvent.id |
params? | { [parameter: string]: any; } | - | EntityActionEvent.params |
position? | MousePosition | - | EntityActionEvent.position |
source | ActionSource | - | EntityActionEvent.source |
sourceEntity | SOURCE | - | - |
targetEntity | TARGET | EntityActionEvent.targetEntity | - |
CoupledActionOptions
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
aliases? | string[] | Complete alternative names used to discover this action. | EntityActionOptions.aliases |
autoSelectIsolatedTarget? | boolean | If the provider can return options immediately, select the first option if there is only one option in the immediate result set | EntityActionOptions.autoSelectIsolatedTarget |
batch? | boolean | Allow the action to run with batch processing. When enabled, the action appears in the right click menu when multiple entities are selected Default false | EntityActionOptions.batch |
batch_concurrency? | number | When running in batch mode, how many items to run concurrently Default 1 | EntityActionOptions.batch_concurrency |
behavior? | ActionMacroBehavior | - | EntityActionOptions.behavior |
category? | { entityType?: string; grouping?: string; } | - | EntityActionOptions.category |
category.entityType? | string | - | - |
category.grouping? | string | - | - |
exemptFromExclusiveExecutionLock? | boolean | - | EntityActionOptions.exemptFromExclusiveExecutionLock |
hideFromCmdPallet? | boolean | - | EntityActionOptions.hideFromCmdPallet |
hotkeys? | ShortcutChord[] | - | EntityActionOptions.hotkeys |
icon | ReactorIcon | - | EntityActionOptions.icon |
id | string | - | EntityActionOptions.id |
initialTargetValue? | () => Promise<any> | - | EntityActionOptions.initialTargetValue |
name | string | - | EntityActionOptions.name |
params? | AbstractActionParameter<AbstractActionParameterOptions, any>[] | - | EntityActionOptions.params |
rollbackMechanic? | ActionRollbackMechanic | - | EntityActionOptions.rollbackMechanic |
source | string | - | - |
tags? | string[] | Searchable terms describing this action. The action behavior is included automatically. | EntityActionOptions.tags |
target | string | - | EntityActionOptions.target |
validators? | ActionValidator<unknown>[] | - | EntityActionOptions.validators |
CronEditorWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
color? | string |
onChange | (value) => any |
value | string[] |
CronEditorWidgetState
Properties
| Property | Type |
|---|---|
settings | Partial<CronEditorWidgetStateSetting> |
value | string[] |
CronEditorWidgetStateSetting
Properties
| Property | Type |
|---|---|
advance | boolean |
CurriedActionOptions
Properties
| Property | Type |
|---|---|
action | ParameterizedAction |
entities? | { [key: string]: any; } |
params? | { [key: string]: any; } |
CustomDialogDirective
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
btns | Omit<Btn, "action">[] | - | - |
buttonStyle? | DialogButtonStyle | - | - |
disableDescriptionOpacity? | boolean | - | DialogDirective.disableDescriptionOpacity |
generateUI | (options) => Element | - | - |
id | string | - | DialogDirective.id |
markdown? | string | - | DialogDirective.markdown |
menuItems? | ComboBoxItem[] | - | DialogDirective.menuItems |
menuItemSelected? | (selected) => any | - | DialogDirective.menuItemSelected |
message? | string | - | DialogDirective.message |
preventDismiss? | boolean | Prevent dismissing dialog by clicking on the backdrop. | DialogDirective.preventDismiss |
resolve | (val?) => any | - | DialogDirective.resolve |
title | string | - | DialogDirective.title |
type | DialogType | - | DialogDirective.type |
CustomDialogOptions
Extends
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
btns? | Omit<Btn, "action">[] | - | - | - |
buttonStyle? | DialogButtonStyle | - | - | - |
disableDescriptionOpacity? | boolean | - | - | DialogDirective.disableDescriptionOpacity |
generateUI | (options) => Element | - | - | - |
markdown? | string | - | - | DialogDirective.markdown |
menuItems? | ComboBoxItem[] | - | - | DialogDirective.menuItems |
menuItemSelected? | (selected) => any | - | - | DialogDirective.menuItemSelected |
message? | string | - | - | DialogDirective.message |
preventDismiss? | boolean | Prevent dismissing dialog by clicking on the backdrop. | DialogDirective.preventDismiss | - |
title | string | - | - | DialogDirective.title |
CustomDialogOptionsEvent
Properties
| Property | Type |
|---|---|
close | () => void |
registerListener | (cb, id?) => any |
DateControlOptions
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
initialValue | Date | AbstractValueControlOptions.initialValue |
type | DateTimePickerType | - |
DateControlWidgetProps
Properties
| Property | Type |
|---|---|
control | DateControl |
DateDisplayWidgetProps
Extends
ComputeDateTimePartsOptions
Properties
DateInputOptions
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
desc? | string | - | FormInputOptions.desc |
disabled? | boolean | - | FormInputOptions.disabled |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | FormInputOptions.hideError |
label | string | - | FormInputOptions.label |
name? | string | - | FormInputOptions.name |
placeholder? | string | - | FormInputOptions.placeholder |
required? | boolean | - | FormInputOptions.required |
size? | Size | - | FormInputOptions.size |
tooltip? | string | Expressed as markdown | FormInputOptions.tooltip |
type | DateTimePickerType | - | - |
value? | any | - | FormInputOptions.value |
visible? | boolean | - | FormInputOptions.visible |
DateRangeSelectorWidgetProps
Properties
| Property | Type |
|---|---|
changed | (start, end) => any |
durations? | Duration<boolean>[] |
end | Date |
start | Date |
transformDurations? | (item, duration) => ComboBoxItem |
DateTimePickerWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
date | Date |
dateChanged | (date) => any |
type? | DateTimePickerType |
validityChanged? | (valid) => any |
DefaultFloatingWindowWidgetProps
Properties
| Property | Type |
|---|---|
content | Element |
engine | WorkspaceEngine |
model | FloatingWindowModel |
titlebar | Element |
DescendantEntityGeneratedOptions
Extended by
Type Parameters
| Type Parameter |
|---|
Descendant |
Properties
| Property | Type |
|---|---|
category? | CategoryInfo |
descendants | Descendant[] |
DescendantEntityProviderComponentOptions
Extended by
Type Parameters
| Type Parameter |
|---|
Parent |
Descendant |
Properties
| Property | Type |
|---|---|
descendantType | string |
generateOptions | (parentEntity) => DescendantEntityGeneratedOptions<Descendant> |
DescendantLoadingEntityGeneratedOptions
Extends
DescendantEntityGeneratedOptions<Descendant>
Type Parameters
| Type Parameter |
|---|
Descendant |
Properties
| Property | Type | Inherited from |
|---|---|---|
category? | CategoryInfo | DescendantEntityGeneratedOptions.category |
descendants | Descendant[] | DescendantEntityGeneratedOptions.descendants |
loading? | () => boolean | - |
refreshDescendants? | (event) => Promise<any> | - |
DescendantLoadingEntityProviderOptions
Extends
DescendantEntityProviderComponentOptions<Parent,Descendant>
Type Parameters
| Type Parameter |
|---|
Parent |
Descendant |
Properties
| Property | Type | Overrides | Inherited from |
|---|---|---|---|
descendantType | string | - | DescendantEntityProviderComponentOptions.descendantType |
generateOptions | (parentEntity) => DescendantLoadingEntityGeneratedOptions<Descendant> | DescendantEntityProviderComponentOptions.generateOptions | - |
DesignerBackgroundWidgetProps
Properties
| Property | Type |
|---|---|
error? | string |
forwardRef? | RefObject<HTMLDivElement> |
DialogDirective
Extended by
Properties
| Property | Type | Description |
|---|---|---|
disableDescriptionOpacity? | boolean | - |
id | string | - |
markdown? | string | - |
menuItems? | ComboBoxItem[] | - |
menuItemSelected? | (selected) => any | - |
message? | string | - |
preventDismiss? | boolean | Prevent dismissing dialog by clicking on the backdrop. |
resolve | (val?) => any | - |
title | string | - |
type | DialogType | - |
DialogHideEvent
Properties
| Property | Type |
|---|---|
btn? | Btn |
directive | DialogDirective |
preventDefault? | () => any |
val? | any |
DialogListener
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
dialogWillHide | (event) => any | - |
initialized | () => any | AbstractStoreListener.initialized |
DialogWidgetProps
Properties
| Property | Type |
|---|---|
btns | Btn[] |
buttonStyle? | DialogButtonStyle |
className? | any |
desc? | string |
disableDescriptionOpacity? | boolean |
markdown? | string |
menuItems? | ComboBoxItem[] |
menuItemSelected? | (selected) => any |
title | string |
DialogWrapperWidgetProps
Properties
| Property | Type |
|---|---|
directive | AbstractDialogDirective |
Dimensions
Properties
| Property | Type |
|---|---|
height | number |
width | number |
x | number |
y | number |
DirectiveLayerOptions
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
alwaysOnTop? | boolean | LayerOptions.alwaysOnTop |
animate? | boolean | LayerOptions.animate |
clickThrough? | boolean | LayerOptions.clickThrough |
layerWillHide | () => boolean | - |
render | (event) => Element | LayerOptions.render |
userCanExit? | boolean | LayerOptions.userCanExit |
DoGetReactorTreeEntitiesOptions
Type Parameters
| Type Parameter |
|---|
Parent |
Descendant |
Properties
| Property | Type |
|---|---|
context | AbstractEntityTreePresenterContext<Descendant> |
descendantOptions | DescendantEntityGeneratedOptions<Descendant> |
entity | Parent |
DualIconWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
color1? | string |
color2? | string |
icon1 | ReactorIcon |
icon2 | ReactorIcon |
EditorPanelSiblingSuggestion
Properties
| Property | Type |
|---|---|
panelTitle | string |
placeholder | PanelPlaceholderWidgetProps |
score | number |
EmptyTableWidgetProps
Properties
| Property | Type |
|---|---|
label? | string |
EncodedDragResult
Properties
| Property | Type |
|---|---|
data | { [key: string]: string; } |
icon | Element |
EncodedEntity
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends { } | { } |
Properties
| Property | Type |
|---|---|
encoded | T |
id | string |
type | string |
version | number |
EntityActionEvent
Extends
ParameterizedActionEvent<DecodedParameters>
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
Target | any |
DecodedParameters | { } |
Properties
| Property | Type | Inherited from |
|---|---|---|
canceled? | boolean | ParameterizedActionEvent.canceled |
entities? | DecodedParameters | ParameterizedActionEvent.entities |
fireBehaviorChecks? | boolean | ParameterizedActionEvent.fireBehaviorChecks |
getStatus? | () => VisorLoadingDirective | ParameterizedActionEvent.getStatus |
id | string | ParameterizedActionEvent.id |
params? | { [parameter: string]: any; } | ParameterizedActionEvent.params |
position? | MousePosition | ParameterizedActionEvent.position |
source | ActionSource | ParameterizedActionEvent.source |
targetEntity | Target | - |
EntityActionOptions
Extends
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
aliases? | string[] | Complete alternative names used to discover this action. | ParameterizedActionOptions.aliases |
autoSelectIsolatedTarget? | boolean | If the provider can return options immediately, select the first option if there is only one option in the immediate result set | - |
batch? | boolean | Allow the action to run with batch processing. When enabled, the action appears in the right click menu when multiple entities are selected Default false | - |
batch_concurrency? | number | When running in batch mode, how many items to run concurrently Default 1 | - |
behavior? | ActionMacroBehavior | - | ParameterizedActionOptions.behavior |
category? | { entityType?: string; grouping?: string; } | - | ParameterizedActionOptions.category |
category.entityType? | string | - | - |
category.grouping? | string | - | - |
exemptFromExclusiveExecutionLock? | boolean | - | ParameterizedActionOptions.exemptFromExclusiveExecutionLock |
hideFromCmdPallet? | boolean | - | ParameterizedActionOptions.hideFromCmdPallet |
hotkeys? | ShortcutChord[] | - | ParameterizedActionOptions.hotkeys |
icon | ReactorIcon | - | ParameterizedActionOptions.icon |
id | string | - | ParameterizedActionOptions.id |
initialTargetValue? | () => Promise<T> | - | - |
name | string | - | ParameterizedActionOptions.name |
params? | AbstractActionParameter<AbstractActionParameterOptions, any>[] | - | ParameterizedActionOptions.params |
rollbackMechanic? | ActionRollbackMechanic | - | ParameterizedActionOptions.rollbackMechanic |
tags? | string[] | Searchable terms describing this action. The action behavior is included automatically. | ParameterizedActionOptions.tags |
target | string | - | - |
validators? | ActionValidator<unknown>[] | - | ParameterizedActionOptions.validators |
EntityButtonWidgetProps
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
allowClearing? | boolean |
className? | any |
emptyMessage? | string |
entity | T |
entityType | string |
onChange | (entity) => any |
parent? | any |
showTypeLabel? | boolean |
EntityCardsCollectionWidgetProps
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
event | RenderCollectionOptions<T> |
presenterContext | EntityCardsPresenterContext<T> |
EntityCardsPresenterComponentOptions
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Properties
| Property | Type |
|---|---|
allowedGroupingSettings? | { complexName?: boolean; labels?: string[]; tags?: boolean; } |
allowedGroupingSettings.complexName? | boolean |
allowedGroupingSettings.labels? | string[] |
allowedGroupingSettings.tags? | boolean |
btns? | (entity) => Btn[] |
defaultGroupingSetting? | GroupingOption |
label? | string |
EntityCardsPresenterSettings
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
groupBy | GroupingOption | AbstractPresenterContextSettings.groupBy |
show-nested | boolean | - |
EntityComboBoxItem
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Inherited from |
|---|---|---|
action? | (event) => Promise<any> | ComboBoxItem.action |
badge? | { action?: (event) => any; background: string; foreground: string; label: string; } | ComboBoxItem.badge |
badge.action? | (event) => any | - |
badge.background | string | - |
badge.foreground | string | - |
badge.label | string | - |
children? | ComboBoxItem[] | ComboBoxItem.children |
color? | string | ComboBoxItem.color |
disabled? | boolean | ComboBoxItem.disabled |
download? | { name: string; url: string; } | ComboBoxItem.download |
download.name | string | - |
download.url | string | - |
entity | T | - |
forwardRef? | RefObject<HTMLDivElement> | ComboBoxItem.forwardRef |
group? | string | ComboBoxItem.group |
icon? | ReactorIcon | ComboBoxItem.icon |
key | string | ComboBoxItem.key |
link? | string | ComboBoxItem.link |
right? | Element | ComboBoxItem.right |
title | string | ComboBoxItem.title |
titleMatch? | SearchEventMatch | ComboBoxItem.titleMatch |
validator? | Validator | ComboBoxItem.validator |
EntityControlOptions
Extends
AbstractValueControlOptions<Entity>
Type Parameters
| Type Parameter |
|---|
Entity extends any |
Properties
| Property | Type | Inherited from |
|---|---|---|
entityType | string | - |
initialValue | Entity | AbstractValueControlOptions.initialValue |
parent? | any | - |
EntityControlWidgetProps
Properties
| Property | Type |
|---|---|
control | EntityControl |
EntityDefinitionErrorOptions
Properties
| Property | Type |
|---|---|
context? | Record<string, unknown> |
definition | EntityDefinition |
message | string |
EntityDefinitionOptions
Properties
| Property | Type |
|---|---|
category | string |
icon | ReactorIcon |
iconColor | string |
label | string |
type | string |
EntityDescriberComponentListener
Properties
| Property | Type |
|---|---|
preferred | () => any |
EntityDescriberComponentOptions
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
describe | (entity) => EntityDescription |
label | string |
EntityDescription
Properties
| Property | Type | Description |
|---|---|---|
complexName? | string | - |
icon? | ReactorIcon | - |
icon2? | ReactorIcon | - |
icon2Color? | string | - |
iconColor? | string | - |
labels? | EntityLabel[] | Optional metadata entries shown by card-style presenters. |
simpleName | string | - |
tags? | string[] | Optional tag chips shown by card-style presenters. |
EntityDocsComponentOptions
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
getDocLink | (entity) => string |
label | string |
EntityEncoderBankOptions
Properties
| Property | Type |
|---|---|
type | string |
EntityEncoderComponentOptions
Extended by
Properties
| Property | Type |
|---|---|
version | number |
EntityHandlerComponentOptions
Extended by
Properties
| Property | Type |
|---|---|
preferred? | boolean |
EntityHeaderButtonWidgetProps
Properties
| Property | Type |
|---|---|
entity | EncodedEntity |
remove | () => any |
vertical | boolean |
EntityInputOptions
Extends
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
desc? | string | - | - | FormInputOptions.desc |
disabled? | boolean | - | - | FormInputOptions.disabled |
entityType | string | - | - | - |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | - | FormInputOptions.hideError |
label | string | - | - | FormInputOptions.label |
name? | string | - | - | FormInputOptions.name |
parent? | any | - | - | - |
placeholder? | string | - | - | FormInputOptions.placeholder |
required? | boolean | - | - | FormInputOptions.required |
size? | Size | - | - | FormInputOptions.size |
tooltip? | string | Expressed as markdown | - | FormInputOptions.tooltip |
value | any | - | FormInputOptions.value | - |
visible? | boolean | - | - | FormInputOptions.visible |
EntityLabel
Extended by
Properties
| Property | Type | Description |
|---|---|---|
active? | boolean | - |
color? | string | - |
colorForeground? | string | - |
icon? | { color: string; name: ReactorIcon; spin?: boolean; } | - |
icon.color | string | - |
icon.name | ReactorIcon | - |
icon.spin? | boolean | - |
id? | string | A stable identifier for renderers and menus when a label may repeat. |
label | string | - |
tooltip? | string | - |
value | string | - |
EntityPanelComponentOptions
Type Parameters
| Type Parameter |
|---|
T extends any |
Properties
| Property | Type | Description |
|---|---|---|
additionalActions? | string[] | - |
defaultPresenter? | string | The label of the default presenter, if null will select the first one |
getEntities | (event) => T[] | - |
icon? | ReactorIcon | - |
iconColor? | string | - |
isLoading? | () => boolean | - |
label? | string | - |
legacyType? | string | - |
EntityPanelModelListener
Extends
WorkspaceModelListener.SelectEntityListener<T>
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends any | any |
Properties
| Property | Type | Inherited from |
|---|---|---|
contextGenerated | (context) => any | - |
selectEntity | (entity) => any | SelectEntityListener.selectEntity |
EntityPanelWidgetProps
Properties
| Property | Type |
|---|---|
model | EntityPanelModel |
EntityPickOptions
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends any | any |
Properties
| Property | Type |
|---|---|
autoSelectedIsolatedEntity? | boolean |
event? | MousePosition |
filter? | (entity) => boolean |
parent? | any |
transformItem? | (entity, item) => EntityComboBoxItem<T> |
EntityPlaceholderWidgetProps
Type Parameters
| Type Parameter |
|---|
T extends WorkspaceModel |
X |
Properties
| Property | Type |
|---|---|
button | Partial<Btn> |
entity | string |
model | T |
patchModel | (entity, model) => Promise<any> |
placeholder | Partial<PanelPlaceholderWidgetProps> |
EntityPresenterComponentOptions
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
allowedGroupingSettings? | { complexName?: boolean; labels?: string[]; tags?: boolean; } | GroupBySettingOptions.allowedGroupingSettings |
allowedGroupingSettings.complexName? | boolean | - |
allowedGroupingSettings.labels? | string[] | - |
allowedGroupingSettings.tags? | boolean | - |
defaultGroupingSetting? | GroupingOption | GroupBySettingOptions.defaultGroupingSetting |
label | string | - |
EntityPresenterListener
Type Parameters
| Type Parameter |
|---|
Context extends AbstractPresenterContext |
Properties
| Property | Type |
|---|---|
contextGenerated? | (context) => void |
EntityReactorNodeOptions
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends any | any |
Properties
| Property | Type |
|---|---|
definition | EntityDefinition |
entity | E |
events? | BaseObserverInterface<SelectEntityListener<E>> |
EntitySearchBankOptions
Properties
| Property | Type |
|---|---|
label | string |
EntitySearchEngineComponentOptions
Extended by
Properties
| Property | Type |
|---|---|
label | string |
EntitySearchResolveOptions
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Properties
| Property | Type |
|---|---|
autoSelectedIsolatedEntity? | boolean |
event? | MousePosition |
filter? | (entity) => boolean |
parent? | any |
transformItem? | (entity, item) => EntityComboBoxItem<T> |
EntitySearchResultEntry
Extends
SearchResultEntry
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Properties
| Property | Type | Inherited from |
|---|---|---|
entity | T | - |
key | string | SearchResultEntry.key |
EntitySettingOptions
Extends
Type Parameters
| Type Parameter |
|---|
I |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
category? | string | - | AbstractInteractiveControlOptions.category |
changed? | (item) => any | - | - |
defaultEntity | I | - | - |
description? | string | - | AbstractInteractiveControlOptions.description |
key | string | - | AbstractInteractiveControlOptions.key |
name? | string | - | AbstractInteractiveControlOptions.name |
serializeID? | string | used for busting the serialization if we have made fundamental changes that are not backwards compatible | AbstractInteractiveControlOptions.serializeID |
type | string | - | - |
EntityThemeOverride
Properties
| Property | Type |
|---|---|
entities | { [entity_type: string]: { iconColor: string; }; } |
name | string |
EntityTreeCollectionWidgetProps
Type Parameters
| Type Parameter |
|---|
T extends any |
Properties
| Property | Type |
|---|---|
event | RenderCollectionOptions<T> |
presenterContext | AbstractEntityTreePresenterContext<T> |
EntityTreePresenterComponentOptions
Extends
Omit<EntityPresenterComponentOptions,"label">.GroupBySettingOptions
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Properties
| Property | Type | Inherited from |
|---|---|---|
allowedGroupingSettings? | { complexName?: boolean; labels?: string[]; tags?: boolean; } | GroupBySettingOptions.allowedGroupingSettings |
allowedGroupingSettings.complexName? | boolean | - |
allowedGroupingSettings.labels? | string[] | - |
allowedGroupingSettings.tags? | boolean | - |
defaultGroupingSetting? | GroupingOption | GroupBySettingOptions.defaultGroupingSetting |
label? | string | - |
loadChildrenAsNodesAreOpened? | boolean | - |
maxTags? | number | - |
metadataDisplayOptions? | MetadataDisplayOptions | - |
searchScope? | SearchableTreeSearchScope | - |
tagDisplayMode? | TagDisplayMode | - |
EntityTreePresenterSettings
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
groupBy | GroupingOption | AbstractPresenterContextSettings.groupBy |
sort | SortDirection | - |
EntityTreePresenterState
Properties
| Property | Type |
|---|---|
trees | TreeSerialized | TreeSerializedV2 |
ExpandZoneWidgetProps
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
dragEvent | (entered) => any | - |
gap_expand? | number | SharedDropZoneProps.gap_expand |
gap_hint? | number | SharedDropZoneProps.gap_hint |
gap_standard? | number | SharedDropZoneProps.gap_standard |
hint | boolean | - |
vertical | boolean | SharedDropZoneProps.vertical |
ExportedWorkspace
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
current | string | WorkspacePrefsSerialized.current |
currentTop? | string | WorkspacePrefsSerialized.currentTop |
models | SerializedWorkspaceEntry[] | WorkspacePrefsSerialized.models |
replace | boolean | - |
type | "workspaces" | WorkspacePrefsSerialized.type |
version? | 1 | 2 | 3 | WorkspacePrefsSerialized.version |
ExposedPresenterSetting
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
component | EntityPresenterComponent | - |
context | AbstractPresenterContext | - |
control | AbstractValueControl | PresenterSetting.control |
icon | ReactorIcon | PresenterSetting.icon |
key | string | PresenterSetting.key |
label | string | PresenterSetting.label |
FileControlWidgetProps
Properties
| Property | Type |
|---|---|
control | FileControl |
FileInputOptions
Extends
FormInputOptions<File>
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
allowPaste? | boolean | - | - |
desc? | string | - | FormInputOptions.desc |
disabled? | boolean | - | FormInputOptions.disabled |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | FormInputOptions.hideError |
label | string | - | FormInputOptions.label |
name? | string | - | FormInputOptions.name |
placeholder? | string | - | FormInputOptions.placeholder |
required? | boolean | - | FormInputOptions.required |
size? | Size | - | FormInputOptions.size |
tooltip? | string | Expressed as markdown | FormInputOptions.tooltip |
value? | File | - | FormInputOptions.value |
visible? | boolean | - | FormInputOptions.visible |
FloatingInspectorPanelWidgetProps
Properties
| Property | Type |
|---|---|
btns | Btn[] |
className? | any |
primaryHeading | string |
secondaryHeading | string |
FloatingInspectorSectionWidgetProps
Properties
| Property | Type |
|---|---|
inline? | boolean |
name | string |
FloatingPanelButtonWidgetProps
Properties
| Property | Type |
|---|---|
btn | Btn |
className? | any |
FloatingPanelWidgetProps
Properties
| Property | Type |
|---|---|
center | boolean |
className? | string |
forwardRef? | RefObject<HTMLDivElement> |
highlight? | boolean |
scaleInOnMobile? | boolean |
FloatingToolbarBtnWidgetProps
Properties
| Property | Type |
|---|---|
btn | Btn |
FloatingToolbarCheckboxWidgetProps
Properties
| Property | Type |
|---|---|
changed | (newValue) => any |
checked | boolean |
name | string |
FloatingToolbarContainerWidgetProps
Properties
| Property | Type |
|---|---|
toolbars | Element[] |
FloatingToolbarWidgetProps
Properties
| Property | Type |
|---|---|
activeChanged? | (active) => any |
defaultActive? | boolean |
name | string |
FloatingToolbarWidgetState
Properties
| Property | Type |
|---|---|
active | boolean |
FooterLoaderWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
color? | string |
mode | LoadingDirectiveState |
percentage? | number |
show | boolean |
FooterWidgetProps
Properties
| Property | Type |
|---|---|
btns? | Btn[] |
FormDialogDirectiveOptions
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends FormModel | FormModel |
Properties
| Property | Type | Inherited from |
|---|---|---|
form | T | - |
handler? | (form) => Promise<any> | - |
markdown? | string | AbstractDialogDirectiveOptions.markdown |
title? | string | AbstractDialogDirectiveOptions.title |
FormErrorDisplayProps
Properties
| Property | Type |
|---|---|
errors | string[] |
warnings | string[] |
FormEvent
Properties
| Property | Type |
|---|---|
input | FormInput |
FormInputGenerics
Extended by
Properties
| Property | Type |
|---|---|
LISTENER | FormInputListener |
OPTIONS | FormInputOptions |
VALUE | any |
FormInputListener
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Properties
| Property | Type |
|---|---|
errorChanged | (event) => any |
optionsUpdated | () => any |
removed | () => any |
valueChanged | (event) => any |
visibilityChanged | () => any |
FormInputOptions
Extended by
BooleanInputOptionsArrayInputOptionsArraySetInputOptionsGroupInputOptionsDateInputOptionsEntityInputOptionsFileInputOptionsNumberInputOptionsSelectInputOptionsMultiSelectInputOptions
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Properties
| Property | Type | Description |
|---|---|---|
desc? | string | - |
disabled? | boolean | - |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. |
label | string | - |
name? | string | - |
placeholder? | string | - |
required? | boolean | - |
size? | Size | - |
tooltip? | string | Expressed as markdown |
value? | T | - |
visible? | boolean | - |
FormInputRenderOptions
Properties
| Property | Type |
|---|---|
inline | boolean |
FormInputWidgetProps
Properties
| Property | Type |
|---|---|
children | () => Element |
input | FormInput |
FormModelListener
Properties
| Property | Type |
|---|---|
errorsChanged | (event) => any |
valueChanged | (event) => any |
GenerateTreeOptions
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
disableCache? | boolean |
events? | BaseObserverInterface<SelectEntityListener<T>> |
GetComboBoxDirectiveOptions
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
filter? | (entity) => boolean |
position | MousePosition |
transformItem? | (entity, item) => EntityComboBoxItem<T> |
GetEntityEvent
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
model | EntityPanelModel |
presenter | EntityPresenterComponent<T> |
GraphThreshold
Properties
| Property | Type |
|---|---|
above | boolean |
key | string |
value | number |
GraphWidgetProps
Properties
| Property | Type |
|---|---|
animate? | boolean |
data | { realtime?: boolean; timestamp: Date; value: number; }[] |
end | Date |
formatDate | (date) => string |
formatValue | (value) => string |
start | Date |
thresholds? | GraphThreshold[] |
yAxis | string |
GroupByEntityOptions
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
describe? | (entity) => { complexName?: string; labels?: EntityLabel[]; tags?: string[]; } |
entities | T[] |
GroupBySettingOptions
Extended by
Properties
| Property | Type |
|---|---|
allowedGroupingSettings? | { complexName?: boolean; labels?: string[]; tags?: boolean; } |
allowedGroupingSettings.complexName? | boolean |
allowedGroupingSettings.labels? | string[] |
allowedGroupingSettings.tags? | boolean |
defaultGroupingSetting? | GroupingOption |
GroupInputGenerics
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Overrides | Inherited from |
|---|---|---|---|
LISTENER | FormInputListener | - | FormInputGenerics.LISTENER |
OPTIONS | GroupInputOptions<T> | FormInputGenerics.OPTIONS | - |
VALUE | T | FormInputGenerics.VALUE | - |
GroupInputOptions
Extends
Type Parameters
| Type Parameter |
|---|
T extends { } |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
desc? | string | - | FormInputOptions.desc |
disabled? | boolean | - | FormInputOptions.disabled |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | FormInputOptions.hideError |
inputs? | FormInput<FormInputGenerics>[] | - | - |
label | string | - | FormInputOptions.label |
layout? | { border: boolean; horizontal: boolean; } | - | - |
layout.border | boolean | - | - |
layout.horizontal | boolean | - | - |
name? | string | - | FormInputOptions.name |
placeholder? | string | - | FormInputOptions.placeholder |
required? | boolean | - | FormInputOptions.required |
size? | Size | - | FormInputOptions.size |
tooltip? | string | Expressed as markdown | FormInputOptions.tooltip |
value? | T | - | FormInputOptions.value |
visible? | boolean | - | FormInputOptions.visible |
GroupWidgetProps
Properties
| Property | Type |
|---|---|
input | GroupInput<any> |
GuideStepListener
Properties
| Property | Type |
|---|---|
completed | () => any |
GuideStepOptions
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends ReactorComponentSelections | ReactorComponentSelections |
Properties
| Property | Type |
|---|---|
activated | (step) => void | (() => any) |
desc? | string |
label | string |
GuideStoreListener
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
guideActivated | (event) => any | - |
initialized | () => any | AbstractStoreListener.initialized |
GuideStoreParams
Properties
| Property | Type |
|---|---|
anchoredOverlayStore | AnchoredOverlayStore |
workspaceStore | WorkspaceStore |
GuideWorkflowListener
Properties
| Property | Type |
|---|---|
activated? | () => any |
complete? | () => any |
deActivated? | () => any |
GuideWorkflowOptions
Properties
| Property | Type |
|---|---|
description | string |
id | string |
label | string |
HeaderButtonWidgetProps
Properties
| Property | Type |
|---|---|
badgeColor? | string |
btn | Btn |
remove | () => any |
vertical | boolean |
HeaderWidgetProps
Properties
| Property | Type | Description |
|---|---|---|
accountButton | Btn | The main account button that represents the avatar |
additionalLogo | string | - |
className? | any | - |
email | string | - |
forwardRef | RefObject<HTMLDivElement> | - |
leftButtons? | Btn[] | Sits next to the workspaces |
logoClicked | (event) => any | - |
metaButtons | Btn[] | Sits next to the account button |
name | string | - |
primaryHeading | Btn | - |
rightContent? | Element | - |
secondaryHeading? | Btn | - |
toolbar | ToolbarPreference | - |
HoverWidgetProps
Properties
| Property | Type |
|---|---|
children | Element |
className? | any |
getOverlay | () => Element |
IBaseReactorTree
Extends
TreeEntityInterface
Properties
| Property | Type | Description |
|---|---|---|
attached | boolean | The entity is part of a rendered tree |
currentSearch? | SearchEvent | The current search value |
visible | boolean | The entity itself is visible |
Methods
addPropGenerator()
addPropGenerator(transformer): () => any;
Parameters
| Parameter | Type |
|---|---|
transformer | ReactorTreePropsTransformer |
Returns
() => any
getProps()
getProps(event): ReactorTreeProps;
Parameters
| Parameter | Type |
|---|---|
event | CoreTreeWidgetProps |
Returns
getSortKey()
getSortKey(): string;
Returns
string
match()
match(event): SearchEventMatch;
Parameters
| Parameter | Type |
|---|---|
event | SearchEvent |
Returns
SearchEventMatch
setAttached()
setAttached(attached): any;
Set whether the leaf is attached or detached from a parent. Attached does not explicitly mean that the leaf is visible though, for that the setVisible method is used
Parameters
| Parameter | Type |
|---|---|
attached | boolean |
Returns
any
setSearch()
setSearch(event): boolean;
Parameters
| Parameter | Type |
|---|---|
event | SearchEvent |
Returns
boolean
setSortKey()
setSortKey(key): void;
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
void
setVisible()
setVisible(visible): any;
Parameters
| Parameter | Type |
|---|---|
visible | boolean |
Returns
any
IconWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
icon | ReactorIcon |
spin? | boolean |
ImageMediaURL
Properties
| Property | Type |
|---|---|
url | string |
Methods
dispose()
dispose(): any;
Returns
any
IndividualSettingsWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
description? | string |
search? | SearchEventMatch |
title | string |
InformativeGuideStepOptions
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
activated | (step) => void | (() => any) | GuideStepOptions.activated |
desc? | string | GuideStepOptions.desc |
fit? | boolean | - |
image? | string | - |
label | string | GuideStepOptions.label |
video? | string | - |
InlineDialogDirectiveOptions
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
buttons? | Btn[] | - |
generateContent | () => Element | - |
markdown? | string | AbstractDialogDirectiveOptions.markdown |
title? | string | AbstractDialogDirectiveOptions.title |
InlineEntityEncoderComponentOptions
Extends
Type Parameters
| Type Parameter |
|---|
Decoded |
Encoded |
Properties
| Property | Type | Inherited from |
|---|---|---|
decode | (e) => Promise<Decoded> | - |
encode | (e) => Encoded | - |
version | number | EntityEncoderComponentOptions.version |
InlineEntityHandlerComponentOptions
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Inherited from |
|---|---|---|
cb | (event) => any | - |
desc | ComboBoxItem | - |
preferred? | boolean | EntityHandlerComponentOptions.preferred |
InlineTreePresenterComponentOptions
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
InputContainerWidgetProps
Properties
| Property | Type |
|---|---|
alignContent? | InputContainerContentAlignment |
className? | any |
desc? | string |
error? | string |
inline? | boolean |
inlineWidth? | number |
label | string |
suggestionWidget? | Element |
tooltip? | string |
warning? | string |
InputDialogDirective
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
cancelBtn? | Partial<Btn> | - | - |
disableDescriptionOpacity? | boolean | - | DialogDirective.disableDescriptionOpacity |
extraTopContent? | () => Element | - | - |
fieldType? | InputDialogType | - | - |
id | string | - | DialogDirective.id |
markdown? | string | - | DialogDirective.markdown |
menuItems? | ComboBoxItem[] | - | DialogDirective.menuItems |
menuItemSelected? | (selected) => any | - | DialogDirective.menuItemSelected |
message? | string | - | DialogDirective.message |
preventDismiss? | boolean | Prevent dismissing dialog by clicking on the backdrop. | DialogDirective.preventDismiss |
resolve | (val?) => any | - | DialogDirective.resolve |
submitBtn? | Partial<Btn> | - | - |
title | string | - | DialogDirective.title |
transformer? | (value) => string | - | - |
type | DialogType | - | DialogDirective.type |
validationMessage? | string | - | - |
validator? | (value) => boolean | - | - |
value | string | - | - |
InputDialogOptions
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
cancelBtn? | Partial<Btn> | - | - |
disableDescriptionOpacity? | boolean | - | DialogDirective.disableDescriptionOpacity |
extraTopContent? | () => Element | - | - |
fieldType? | InputDialogType | - | - |
initialValue? | string | - | - |
markdown? | string | - | DialogDirective.markdown |
menuItems? | ComboBoxItem[] | - | DialogDirective.menuItems |
menuItemSelected? | (selected) => any | - | DialogDirective.menuItemSelected |
message? | string | - | DialogDirective.message |
preventDismiss? | boolean | Prevent dismissing dialog by clicking on the backdrop. | DialogDirective.preventDismiss |
submitBtn? | Partial<Btn> | - | - |
title | string | - | DialogDirective.title |
transformer? | (value) => string | - | - |
validationMessage? | string | - | - |
validator? | (value) => boolean | - | - |
ItemsDirectiveComboWidgetProps
Properties
| Property | Type |
|---|---|
directive | UIItemsDirective |
resolve | (item, event) => any |
KeyboardShortcutPillsWidgetProps
Properties
| Property | Type |
|---|---|
chord | ShortcutChord |
className? | any |
LayerDirectiveWidgetProps
Properties
| Property | Type |
|---|---|
children | () => Element |
gotLayer? | (layer) => any |
options? | Omit<LayerOptions, "render"> |
LayerListener
Properties
| Property | Type |
|---|---|
dispose | () => any |
LayerOptions
Extended by
Properties
| Property | Type |
|---|---|
alwaysOnTop? | boolean |
animate? | boolean |
clickThrough? | boolean |
render | (event) => Element |
userCanExit? | boolean |
LayerRenderEvent
Properties
| Property | Type |
|---|---|
index | number |
layer | Layer |
LayerWidgetProps
Properties
| Property | Type |
|---|---|
animate | boolean |
clickThough | () => boolean |
hide | () => any |
zIndex | number |
ListItem
Properties
| Property | Type |
|---|---|
forwardRef? | RefObject<HTMLDivElement> |
key | string |
render | (event) => Element |
ListItemRenderEvent
Properties
| Property | Type |
|---|---|
hover | () => any |
index | number |
ref | RefObject<HTMLDivElement> |
select | (event) => any |
selected | boolean |
LoadingPanelWidgetProps
Properties
| Property | Type |
|---|---|
children | () => Element |
className? | any |
loading | boolean |
LocalStorageSerializerOptions
Properties
| Property | Type |
|---|---|
key | string |
LoggerEntry
Extended by
Properties
| Property | Type |
|---|---|
children | number |
configuredLevel? | LogLevel |
depth | number |
label | string |
level | LogLevel |
name | string |
parent? | string |
LoggerTreeEntry
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
children | number | LoggerEntry.children |
configuredLevel? | LogLevel | LoggerEntry.configuredLevel |
depth | number | LoggerEntry.depth |
label | string | LoggerEntry.label |
level | LogLevel | LoggerEntry.level |
loggers | LoggerTreeEntry[] | - |
name | string | LoggerEntry.name |
parent? | string | LoggerEntry.parent |
MarkdownWidgetProps
Properties
| Property | Type |
|---|---|
className? | string |
markdown | string |
size? | Size |
MatchesWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
locators | SearchEventLocators |
text | string |
MediaLoader
Properties
| Property | Type |
|---|---|
canLoadMedia | (uid) => boolean |
loadMedia | (uid) => Promise<AbstractMedia<AbstractMediaOptions>> |
MediaTypeMatcher
Properties
| Property | Type |
|---|---|
mime? | string |
path? | string |
MessageDialogOptions
Extends
Extended by
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
disableDescriptionOpacity? | boolean | - | DialogDirective.disableDescriptionOpacity |
markdown? | string | - | DialogDirective.markdown |
menuItems? | ComboBoxItem[] | - | DialogDirective.menuItems |
menuItemSelected? | (selected) => any | - | DialogDirective.menuItemSelected |
message? | string | - | DialogDirective.message |
preventDismiss? | boolean | Prevent dismissing dialog by clicking on the backdrop. | DialogDirective.preventDismiss |
title | string | - | DialogDirective.title |
MetaBarOverflowOptions
Properties
| Property | Type |
|---|---|
changed? | (overflowed) => void |
fallback | ReactNode |
forceOverflow? | boolean |
forwardRef? | RefObject<HTMLElement> |
observe? | boolean |
overflowKey? | string |
MetaBarWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
meta? | ReadOnlyMetadataWidgetProps[] |
overflow? | MetaBarOverflowOptions |
showIcons? | boolean |
MetadataDisplayOption
Properties
| Property | Type |
|---|---|
icon? | boolean |
label? | boolean |
mode | MetadataDisplayMode |
MetadataWidgetProps
Extends
Extended by
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
active? | boolean | - | EntityLabel.active |
className? | any | - | - |
color? | string | - | EntityLabel.color |
colorForeground? | string | - | EntityLabel.colorForeground |
icon? | { color: string; name: ReactorIcon; spin?: boolean; } | - | EntityLabel.icon |
icon.color | string | - | - |
icon.name | ReactorIcon | - | - |
icon.spin? | boolean | - | - |
id? | string | A stable identifier for renderers and menus when a label may repeat. | EntityLabel.id |
label | string | - | EntityLabel.label |
onClick? | MouseEventHandler<any> | - | - |
showIcon? | boolean | - | - |
showLabel? | boolean | - | - |
size? | Size | - | - |
tooltip? | string | - | EntityLabel.tooltip |
value | string | - | EntityLabel.value |
MobileHeaderWidgetProps
Properties
| Property | Type |
|---|---|
logoClicked | (event) => any |
openDrawer | () => void |
MobileNavPillWidgetProps
Properties
| Property | Type |
|---|---|
children | ReactNode |
disabled? | boolean |
onClick | () => void |
onContextMenu? | (position) => any |
selected | boolean |
MobilePanelScreen
Properties
| Property | Type |
|---|---|
factory | ReactorPanelFactory |
id | string |
model | ReactorPanelModel |
title | string |
type | "panel" |
MobilePanelScreenWidgetProps
Properties
| Property | Type |
|---|---|
engine | WorkspaceEngine |
screen | MobilePanelScreen |
showTitle? | boolean |
workspaceStore | WorkspaceStore |
MobileReactorShellProps
Properties
| Property | Type |
|---|---|
locked | boolean |
logoClicked | (event) => any |
workspaceRef | RefObject<HTMLDivElement> |
MobileTabScreen
Properties
| Property | Type |
|---|---|
id | string |
model | ReactorTabFactoryModel |
panels | MobilePanelScreen[] |
title | string |
type | "tabs" |
MobileTabScreenWidgetProps
Properties
| Property | Type |
|---|---|
engine | WorkspaceEngine |
screen | MobileTabScreen |
showPanelTitle? | boolean |
workspaceStore | WorkspaceStore |
MobileWorkspaceDrawerWidgetProps
Properties
| Property | Type |
|---|---|
close | () => void |
MobileWorkspaceWidgetProps
Properties
| Property | Type |
|---|---|
forwardRef | RefObject<HTMLDivElement> |
MousePosition
Properties
| Property | Type |
|---|---|
clientX | number |
clientY | number |
MultiComboBoxDirectiveOptions
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ComboBoxItem | ComboBoxItem |
Properties
| Property | Type | Inherited from |
|---|---|---|
centerOnMobile? | boolean | BaseComboBoxDirectiveOptions.centerOnMobile |
event? | MousePosition | BaseComboBoxDirectiveOptions.event |
hideSearch? | boolean | BaseComboBoxDirectiveOptions.hideSearch |
items | T[] | BaseComboBoxDirectiveOptions.items |
searchPlaceholder? | string | BaseComboBoxDirectiveOptions.searchPlaceholder |
selected? | string[] | - |
sort? | boolean | BaseComboBoxDirectiveOptions.sort |
subtitle? | string | BaseComboBoxDirectiveOptions.subtitle |
title? | string | BaseComboBoxDirectiveOptions.title |
MultiSelectChangeEvent
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends TableRow | TableRow |
Properties
| Property | Type |
|---|---|
rowKeys | string[] |
rows | T[] |
MultiSelectInputOptions
Extends
FormInputOptions<string[]>
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
desc? | string | - | - | FormInputOptions.desc |
disabled? | boolean | - | - | FormInputOptions.disabled |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | - | FormInputOptions.hideError |
label | string | - | - | FormInputOptions.label |
name? | string | - | - | FormInputOptions.name |
options | Record<string, string> | - | - | - |
placeholder? | string | - | - | FormInputOptions.placeholder |
required? | boolean | - | - | FormInputOptions.required |
size? | Size | - | - | FormInputOptions.size |
tooltip? | string | Expressed as markdown | FormInputOptions.tooltip | - |
value? | string[] | - | - | FormInputOptions.value |
visible? | boolean | - | - | FormInputOptions.visible |
MultiSelectInputWidgetProps
Properties
| Property | Type |
|---|---|
input | MultiSelectInput |
MultiSelectSearchableTableWidgetProps
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends TableRow | TableRow |
Properties
| Property | Type | Inherited from |
|---|---|---|
columns | SearchableTableColumn[] | SearchableTableWidgetProps.columns |
emptyLabel? | string | SearchableTableWidgetProps.emptyLabel |
onContextMenu? | (event, row) => any | SearchableTableWidgetProps.onContextMenu |
onSearch? | (searchValue) => any | SearchableTableWidgetProps.onSearch |
onSelectionChange? | (event) => any | - |
renderGroup? | (event) => Partial<TableRowsGroupWidgetProps> | SearchableTableWidgetProps.renderGroup |
rows | T[] | SearchableTableWidgetProps.rows |
selectedRowKeys | string[] | - |
size? | Size | SearchableTableWidgetProps.size |
tableFactory? | ComponentType<any> | SearchableTableWidgetProps.tableFactory |
tableFactoryProps? | Record<string, any> | SearchableTableWidgetProps.tableFactoryProps |
MultiSelectTableProps
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends TableRow | TableRow |
Properties
| Property | Type | Inherited from |
|---|---|---|
allRows? | T[] | - |
columns | TableColumn[] | TableWidgetProps.columns |
emptyLabel? | string | TableWidgetProps.emptyLabel |
onContextMenu? | (event, row) => any | TableWidgetProps.onContextMenu |
onSelectionChange? | (event) => any | - |
renderGroup? | (event) => Partial<TableRowsGroupWidgetProps> | TableWidgetProps.renderGroup |
rows | T[] | TableWidgetProps.rows |
selectedRowKeys | string[] | - |
size? | Size | TableWidgetProps.size |
MutableRect
Properties
| Property | Type |
|---|---|
height | number |
left | number |
top | number |
width | number |
NestedTreeRenderOption
Properties
| Property | Type |
|---|---|
context | AbstractEntityTreePresenterContext |
entities | any[] |
key | string |
label | string |
Notification
Properties
| Property | Type |
|---|---|
btns? | Btn[] |
description | string |
timeoutMs? | number |
title | string |
type? | NotificationType |
validationResult? | NotificationValidationResult |
NotificationDialogHandler
Properties
| Property | Type |
|---|---|
close | () => any |
NotificationDirective
Properties
| Property | Type |
|---|---|
_handle | any |
delete | () => any |
id | string |
notification | Notification |
reset | () => any |
NotificationValidationResult
Properties
| Property | Type |
|---|---|
errors | string[] |
warnings | string[] |
NumberInputOptions
Extends
FormInputOptions<number>
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
desc? | string | - | FormInputOptions.desc |
disabled? | boolean | - | FormInputOptions.disabled |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | FormInputOptions.hideError |
label | string | - | FormInputOptions.label |
max? | number | - | - |
min? | number | - | - |
name? | string | - | FormInputOptions.name |
placeholder? | string | - | FormInputOptions.placeholder |
required? | boolean | - | FormInputOptions.required |
size? | Size | - | FormInputOptions.size |
tooltip? | string | Expressed as markdown | FormInputOptions.tooltip |
validator? | (value) => string | boolean | - | - |
value? | number | - | FormInputOptions.value |
visible? | boolean | - | FormInputOptions.visible |
ObservedSize
Properties
| Property | Type |
|---|---|
height | number |
width | number |
OpenEntityEvent
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
entity | T |
position | MousePosition |
source | ActionSource |
OverflowCollapseWidgetProps
Properties
PaginatedCollectionWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
collection? | PaginatedCollection |
Panel
Properties
| Property | Type |
|---|---|
icon? | IconName |
key | string |
name | string |
PanelBtn
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
action? | ButtonAction | - | Btn.action |
disabled? | boolean | - | Btn.disabled |
forwardRef? | RefObject<HTMLDivElement> | - | Btn.forwardRef |
highlight? | boolean | - | Btn.highlight |
icon? | ReactorIcon | - | Btn.icon |
iconColor? | string | - | - |
label? | string | - | Btn.label |
mode? | PanelButtonMode | - | - |
submitButton? | boolean | - | Btn.submitButton |
tooltip? | string | - | Btn.tooltip |
tooltipDelay? | number | Hover delay in milliseconds before showing the tooltip. Defaults to zero. | Btn.tooltipDelay |
tooltipPos? | TooltipPosition | - | Btn.tooltipPos |
tooltipState? | SHOW | - | Btn.tooltipState |
validator? | Validator | - | Btn.validator |
PanelComponentSelection
Properties
| Property | Type |
|---|---|
panel? | string |
PanelDropdownWidgetProps
Extends
Partial<Btn>
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
action? | ButtonAction | - | Btn.action |
className? | any | - | - |
disabled? | boolean | - | Btn.disabled |
forwardRef? | RefObject<HTMLDivElement> | - | Btn.forwardRef |
highlight? | boolean | - | Btn.highlight |
icon? | ReactorIcon | - | Btn.icon |
items | ComboBoxItem[] | - | - |
label? | string | - | Btn.label |
onChange | (item) => any | - | - |
selected | string | - | - |
submitButton? | boolean | - | Btn.submitButton |
tooltip? | string | - | Btn.tooltip |
tooltipDelay? | number | Hover delay in milliseconds before showing the tooltip. Defaults to zero. | TooltipProps.tooltipDelay |
tooltipPos? | TooltipPosition | - | TooltipProps.tooltipPos |
tooltipState? | SHOW | - | TooltipProps.tooltipState |
validator? | Validator | - | Btn.validator |
PanelPlaceholderWidgetProps
Properties
| Property | Type |
|---|---|
center? | boolean |
children? | Element |
icon | ReactorIcon |
text | string |
PanelTitleToolbarButtonProps
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
action? | ButtonAction | - | Btn.action |
disabled? | boolean | - | Btn.disabled |
enabled? | boolean | - | - |
forwardRef? | RefObject<HTMLDivElement> | - | Btn.forwardRef |
highlight? | boolean | - | Btn.highlight |
icon? | ReactorIcon | - | Btn.icon |
label? | string | - | Btn.label |
showLabel? | boolean | - | - |
submitButton? | boolean | - | Btn.submitButton |
tooltip? | string | - | Btn.tooltip |
tooltipDelay? | number | Hover delay in milliseconds before showing the tooltip. Defaults to zero. | Btn.tooltipDelay |
tooltipPos? | TooltipPosition | - | Btn.tooltipPos |
tooltipState? | SHOW | - | Btn.tooltipState |
validator? | Validator | - | Btn.validator |
PanelTitleToolbarContext
Properties
| Property | Type |
|---|---|
label | string |
onChange | (event) => any |
tracking | boolean |
value? | string |
PanelTitleToolbarWidgetProps
Properties
| Property | Type |
|---|---|
btns? | PanelToolbarButton[] |
context? | | PanelTitleToolbarContext | PanelTitleToolbarContext[] |
PanelTitleWidgetProps
Properties
| Property | Type |
|---|---|
active? | boolean |
btns? | Btn & { highlight?: boolean; }[] |
color? | string |
icon? | ReactorIcon |
icon2? | ReactorIcon |
model | ReactorPanelModel<WorkspaceModelListener> |
name | string |
PanelToolbarButton
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
action? | ButtonAction | - | Btn.action |
disabled? | boolean | - | Btn.disabled |
enabled? | boolean | - | - |
forwardRef? | RefObject<HTMLDivElement> | - | Btn.forwardRef |
highlight? | boolean | - | Btn.highlight |
icon? | ReactorIcon | - | Btn.icon |
label? | string | - | Btn.label |
showLabel? | boolean | - | - |
submitButton? | boolean | - | Btn.submitButton |
tooltip? | string | - | Btn.tooltip |
tooltipDelay? | number | Hover delay in milliseconds before showing the tooltip. Defaults to zero. | Btn.tooltipDelay |
tooltipPos? | TooltipPosition | - | Btn.tooltipPos |
tooltipState? | SHOW | - | Btn.tooltipState |
validator? | Validator | - | Btn.validator |
PanelToolbarWidgetProps
Properties
| Property | Type |
|---|---|
btns? | Btn[] |
className? | any |
meta? | ReadOnlyMetadataWidgetProps[] |
PanelWidgetProps
Properties
| Property | Type |
|---|---|
event | WorkspaceModelFactoryEvent<ReactorPanelModel<WorkspaceModelListener>> |
factory | ReactorPanelFactory |
padding? | boolean |
urlEnabled? | boolean |
PanelWidgetState
Properties
| Property | Type |
|---|---|
error | boolean |
PanelWithFooterWidgetProps
Properties
| Property | Type |
|---|---|
btns | PanelBtn[] |
PanZoomGesture
Properties
| Property | Type | Description |
|---|---|---|
factor | number | Scale multiplier, anchored between the previous and current gesture centers. |
from | PanZoomPoint | - |
to | PanZoomPoint | - |
PanZoomPoint
Properties
| Property | Type |
|---|---|
x | number |
y | number |
ParameterizedActionEvent
Extends
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
Decoded extends { [parameter: string]: any; } | { } |
Properties
| Property | Type | Inherited from |
|---|---|---|
canceled? | boolean | ActionEvent.canceled |
entities? | Decoded | - |
fireBehaviorChecks? | boolean | ActionEvent.fireBehaviorChecks |
getStatus? | () => VisorLoadingDirective | ActionEvent.getStatus |
id | string | ActionEvent.id |
params? | { [parameter: string]: any; } | - |
position? | MousePosition | ActionEvent.position |
source | ActionSource | ActionEvent.source |
ParameterizedActionGenerics
Extends
Properties
| Property | Type | Overrides |
|---|---|---|
EVENT | ParameterizedActionEvent | ActionGenerics.EVENT |
OPTIONS | ParameterizedActionOptions | ActionGenerics.OPTIONS |
ParameterizedActionListener
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends ParameterizedActionEvent | ParameterizedActionEvent |
Properties
| Property | Type | Inherited from |
|---|---|---|
cancelled | (event) => void | ActionListener.cancelled |
didFire | (event) => void | ActionListener.didFire |
willCollectParams? | (event) => any | - |
willFire | (event) => Promise<void> | ActionListener.willFire |
ParameterizedActionOptions
Extends
Extended by
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
aliases? | string[] | Complete alternative names used to discover this action. | ActionOptions.aliases |
behavior? | ActionMacroBehavior | - | ActionOptions.behavior |
category? | { entityType?: string; grouping?: string; } | - | ActionOptions.category |
category.entityType? | string | - | - |
category.grouping? | string | - | - |
exemptFromExclusiveExecutionLock? | boolean | - | ActionOptions.exemptFromExclusiveExecutionLock |
hideFromCmdPallet? | boolean | - | ActionOptions.hideFromCmdPallet |
hotkeys? | ShortcutChord[] | - | ActionOptions.hotkeys |
icon | ReactorIcon | - | ActionOptions.icon |
id | string | - | ActionOptions.id |
name | string | - | ActionOptions.name |
params? | AbstractActionParameter<AbstractActionParameterOptions, any>[] | - | - |
rollbackMechanic? | ActionRollbackMechanic | - | ActionOptions.rollbackMechanic |
tags? | string[] | Searchable terms describing this action. The action behavior is included automatically. | ActionOptions.tags |
validators? | ActionValidator<unknown>[] | - | ActionOptions.validators |
PartialEntryProps
Extended by
Properties
| Property | Type |
|---|---|
color | string |
disabled? | boolean |
icon | ReactorIcon |
primary | string |
secondary? | string |
selected? | boolean |
PillWidgetProps
Properties
| Property | Type |
|---|---|
action? | (event) => any |
className? | any |
color? | string |
label | string |
labelBackground? | string |
labelColor? | string |
meta? | { icon?: ReactorIcon; label?: string; } |
meta.icon? | ReactorIcon |
meta.label? | string |
rightClick? | (event) => any |
tooltip? | string |
PinnableZoneWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
preference | ToolbarPreference |
size | number |
vertical | boolean |
PossibleShortcutAction
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
defaultKeybindings | ShortcutChord[] | PossibleShortcutAction.defaultKeybindings |
handler | ShortcutHandler | ShortcutHandlerAction.handler |
id | string | PossibleShortcutAction.id |
label | string | PossibleShortcutAction.label |
shortcuts | Shortcut<ShortcutHandler<any, ShortcutHandlerOptions>>[] | - |
supportsMultipleShortcuts | boolean | PossibleShortcutAction.supportsMultipleShortcuts |
PreferredSetBankOptions
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
getOption | (item) => SetControlOption<string> |
setting | PreferredSetBankSettingOptions |
PreferredSetBankSettingOptions
Extends
Omit<SetSettingOptions,"options"|"value">
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
category? | string | - | AbstractInteractiveControlOptions.category |
description? | string | - | AbstractInteractiveControlOptions.description |
key | string | - | AbstractSettingOptions.key |
name? | string | - | AbstractInteractiveControlOptions.name |
serializeID? | string | used for busting the serialization if we have made fundamental changes that are not backwards compatible | AbstractSettingOptions.serializeID |
PrefsSerialized
Properties
| Property | Type |
|---|---|
controls | { [key: string]: object; } |
PresenterContextListener
Extended by
Properties
| Property | Type |
|---|---|
disposed? | () => any |
stateChanged? | () => any |
PresenterSetting
Extended by
Properties
| Property | Type |
|---|---|
control | AbstractValueControl |
icon | ReactorIcon |
key | string |
label | string |
ProviderActionParameterOptions
Extends
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
autoSelectIsolatedItem? | boolean | - | - |
description? | string | - | AbstractActionParameterOptions.description |
filter? | (item) => boolean | - | - |
getDefault? | () => any | - | AbstractActionParameterOptions.getDefault |
getDefaultDecoded? | (event) => Promise<any> | - | - |
getInitialDecoded? | (event) => Promise<any> | - | - |
name | string | - | AbstractActionParameterOptions.name |
renderCallout? | RenderCalloutFunction | - | - |
required? | boolean | Default true | AbstractActionParameterOptions.required |
type | string | - | - |
RawBodyWidgetProps
Properties
| Property | Type |
|---|---|
logo | string |
ReactorComponentSelections
Properties
| Property | Type |
|---|---|
btn | (identifier) => ComponentSelection |
checkbox | (identifier) => ComponentSelection |
comboBox | () => ComponentSelection |
comboBoxItem | (name) => ComboBoxComponentSelection |
dialog | () => DialogComponentSelection |
footerBtn | (identifier) => ComponentSelection |
headerBtn | (identifier) => ComponentSelection |
panel | (identifier) => ComponentSelection |
panelMicroBtn | (identifier) => ComponentSelection |
tab | (identifier) => ComponentSelection |
treeLeaf | (identifier) => ComponentSelection |
ReactorDialogWidgetProps
Properties
| Property | Type |
|---|---|
desc? | string |
footer? | Element |
logo? | string |
title? | string |
ReactorEntityDnDWrapperProps
Properties
| Property | Type |
|---|---|
children | (ref) => Element |
definition | EntityDefinition |
entity | any |
node | IBaseReactorTree |
ReactorEntityWrapperWidgetProps
Properties
| Property | Type |
|---|---|
forwardRef | RefObject<HTMLDivElement> |
node | | EntityReactorLeaf | EntityReactorNode<any> |
options | EntityReactorNodeOptions |
ReactorModuleInitEvent
Properties
| Property | Type |
|---|---|
ioc | Container |
ReactorModuleRegisterEvent
Properties
| Property | Type |
|---|---|
ioc | Container |
registerStore | <T>(symbol, store) => T |
ReactorRootWorkspaceModelOptions
Properties
| Property | Type |
|---|---|
debug? | boolean |
engine | WorkspaceEngine |
ReactorSizeProviderProps
Properties
| Property | Type |
|---|---|
children? | ReactNode |
size | Size |
ReactorTooltipWidgetProps
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
children | ReactNode | - | - |
tooltip? | string | - | TooltipProps.tooltip |
tooltipDelay? | number | Hover delay in milliseconds before showing the tooltip. Defaults to zero. | TooltipProps.tooltipDelay |
tooltipPos? | TooltipPosition | - | TooltipProps.tooltipPos |
tooltipState? | SHOW | - | TooltipProps.tooltipState |
ReactorTreeListener
Extends
TreeEntityListener
Extended by
Properties
| Property | Type |
|---|---|
action | (event) => any |
attachedChanged | () => any |
contextAction | (event) => any |
propGeneratorsChanged | () => any |
sortChanged | () => any |
visibilityChanged | () => any |
ReactorTreeNodeListener
Extends
ReactorTreeListener.TreeNodeListener
Properties
| Property | Type | Inherited from |
|---|---|---|
action | (event) => any | ReactorTreeListener.action |
attachedChanged | () => any | ReactorTreeListener.attachedChanged |
childrenSortChanged | () => any | - |
contextAction | (event) => any | ReactorTreeListener.contextAction |
propGeneratorsChanged | () => any | ReactorTreeListener.propGeneratorsChanged |
sortChanged | () => any | ReactorTreeListener.sortChanged |
visibilityChanged | () => any | ReactorTreeListener.visibilityChanged |
ReactorTreeOptions
Properties
| Property | Type |
|---|---|
defaultOpenPolicy? | ReactorTreeNodeDefaultOpenPolicy |
getTreeProps? | (event) => Partial<ReactorTreeProps> |
key? | string |
match? | (event) => SearchEventMatch |
ReactorViewportBreakpoints
Properties
| Property | Type |
|---|---|
mobile | number |
tablet | number |
ReadOnlyMetadataWidgetProps
Extends
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
active? | boolean | - | - | MetadataWidgetProps.active |
className? | any | - | - | MetadataWidgetProps.className |
color? | string | - | - | MetadataWidgetProps.color |
colorForeground? | string | - | - | MetadataWidgetProps.colorForeground |
icon? | { color: string; name: ReactorIcon; spin?: boolean; } | - | - | MetadataWidgetProps.icon |
icon.color | string | - | - | - |
icon.name | ReactorIcon | - | - | - |
icon.spin? | boolean | - | - | - |
id? | string | A stable identifier for renderers and menus when a label may repeat. | - | MetadataWidgetProps.id |
label | string | - | - | MetadataWidgetProps.label |
onClick? | MouseEventHandler<any> | - | - | MetadataWidgetProps.onClick |
showIcon? | boolean | - | MetadataWidgetProps.showIcon | - |
showLabel? | boolean | - | - | MetadataWidgetProps.showLabel |
size? | Size | - | - | MetadataWidgetProps.size |
tooltip? | string | - | - | MetadataWidgetProps.tooltip |
value | string | - | - | MetadataWidgetProps.value |
RegexSearchPayload
Properties
| Property | Type |
|---|---|
options | RegexOptions[] |
regex | string |
RegexSearchWidgetProps
Properties
| Property | Type |
|---|---|
changed | (search) => any |
initialValue? | RegexSearchPayload |
RenderCalloutEvent
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ComboBoxItem | ComboBoxItem |
Properties
| Property | Type |
|---|---|
options | T[] |
search | string |
RenderCardOptions
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
entity | T |
searchEvent? | SearchEvent |
RenderCollectionOptions
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
entities | T[] |
events? | BaseObserverInterface<SelectEntityListener<T>> |
searchEvent? | SearchEvent |
RenderOptions
Properties
| Property | Type |
|---|---|
spacing? | number |
RenderTreeChildOptions
Properties
| Property | Type |
|---|---|
child | any |
depth | number |
event | CoreTreeWidgetProps |
reportMatched | (match) => any |
ReportValueParams
Extended by
Properties
| Property | Type |
|---|---|
color? | string |
icon? | { color: string; name: ReactorIcon; spin?: boolean; } |
icon.color | string |
icon.name | ReactorIcon |
icon.spin? | boolean |
onClick? | MouseEventHandler<any> |
value | string |
RepresentAsCheckboxOptions
Properties
| Property | Type |
|---|---|
disabled? | boolean |
label? | string |
size? | Size |
RepresentAsComboBoxItemsEvent
Properties
| Property | Type |
|---|---|
label? | string |
RepresentAsControlOptions
Properties
| Property | Type |
|---|---|
context? | LayoutContext |
size? | LayoutContextSize |
ResolverGuideStepOptions
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends ReactorComponentSelections | ReactorComponentSelections |
Properties
| Property | Type | Inherited from |
|---|---|---|
activated | (step) => void | (() => any) | GuideStepOptions.activated |
desc? | string | GuideStepOptions.desc |
isResolved | () => boolean | - |
label | string | GuideStepOptions.label |
SearchableCoreTreeWidgetProps
Extends
Omit<CoreTreeWidgetProps,"search">
Properties
| Property | Type | Default value | Description | Inherited from |
|---|---|---|---|---|
depth? | number | undefined | - | CoreTreeWidgetProps.depth |
events? | { updated: () => any; } | undefined | - | CoreTreeWidgetProps.events |
events.updated | () => any | undefined | - | - |
forwardRef? | RefObject<HTMLDivElement> | undefined | - | CoreTreeWidgetProps.forwardRef |
hasMatchedChildren? | (matched) => any | undefined | - | CoreTreeWidgetProps.hasMatchedChildren |
renderTreeLeaf? | (event) => Element | undefined | - | CoreTreeWidgetProps.renderTreeLeaf |
renderTreeNode? | (event) => Element | undefined | - | CoreTreeWidgetProps.renderTreeNode |
reserveNodeToggleSpace? | boolean | true | Reserve one level of indentation for a node toggle when rendering a leaf. Disable this for inline trees whose leaves should align with their containing content. | CoreTreeWidgetProps.reserveNodeToggleSpace |
search? | string | undefined | - | - |
searchScope? | SearchableTreeSearchScope | undefined | - | CoreTreeWidgetProps.searchScope |
tree | TreeEntity | undefined | - | CoreTreeWidgetProps.tree |
SearchablePanelPlaceholderWidgetProps
Properties
| Property | Type |
|---|---|
entityName? | string |
searchEvent | SearchEvent |
SearchablePanelWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
getContent | (event) => any |
historyContext? | string |
SearchableTableColumn
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
accessor? | (cell, row) => string | Element | TableColumn.accessor |
accessorSearch? | (cell, row) => string | - |
display | string | Element | TableColumn.display |
key | string | TableColumn.key |
length? | number | TableColumn.length |
noWrap? | boolean | TableColumn.noWrap |
shrink? | boolean | TableColumn.shrink |
SearchableTableWidgetProps
Extends
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends TableRow | TableRow |
Properties
| Property | Type | Overrides | Inherited from |
|---|---|---|---|
columns | SearchableTableColumn[] | TableWidgetProps.columns | - |
emptyLabel? | string | - | TableWidgetProps.emptyLabel |
onContextMenu? | (event, row) => any | - | TableWidgetProps.onContextMenu |
onSearch? | (searchValue) => any | - | - |
renderGroup? | (event) => Partial<TableRowsGroupWidgetProps> | - | TableWidgetProps.renderGroup |
rows | T[] | - | TableWidgetProps.rows |
size? | Size | - | TableWidgetProps.size |
tableFactory? | ComponentType<any> | - | - |
tableFactoryProps? | Record<string, any> | - | - |
SearchableTableWidgetState
Properties
| Property | Type |
|---|---|
matcher | SearchEventMatcher |
SearchEngineComboBoxDirectiveOptions
Extends
ComboBoxDirectiveOptions
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends SearchResultEntry | - |
T extends ComboBoxItem | ComboBoxItem |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
centerOnMobile? | boolean | - | ComboBoxDirectiveOptions.centerOnMobile |
engine | SearchEngine<SearchResult<E>> | - | - |
event? | MousePosition | - | ComboBoxDirectiveOptions.event |
filter? | (entity) => boolean | - | - |
hideSearchOnMobile? | boolean | - | - |
loadingMessage? | string | Message shown before the first search results arrive. Defaults to "Loading...". | - |
loadingMoreMessage? | string | Message shown while more results load beneath existing items. Defaults to "Loading more...". | - |
searchPlaceholder? | string | - | ComboBoxDirectiveOptions.searchPlaceholder |
subtitle? | string | - | ComboBoxDirectiveOptions.subtitle |
title? | string | - | ComboBoxDirectiveOptions.title |
transformResult | (item) => T | - | - |
SearchEngineComboBoxDirectiveWidgetProps
Properties
| Property | Type |
|---|---|
directive | SearchEngineComboBoxDirective |
SearchEngineSearchEvent
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends object | { } |
Properties
| Property | Type |
|---|---|
parameters? | T |
value | string |
SearchWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
design? | SearchWidgetDesign |
focusOnMount? | boolean |
historyContext? | string |
icon? | ReactorIcon |
inputRef? | RefObject<HTMLInputElement> |
loading? | boolean |
placeholder? | string |
rounded? | boolean |
search | string |
searchChanged | (search) => any |
size? | Size |
SelectEntityListener
Extended by
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
selectEntity | (entity) => any |
SelectIdentifier
Properties
| Property | Type |
|---|---|
label? | string |
panelFactoryType? | string |
type | string |
SelectInputOptions
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends string | string |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
desc? | string | - | - | FormInputOptions.desc |
disabled? | boolean | - | - | FormInputOptions.disabled |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | - | FormInputOptions.hideError |
label | string | - | - | FormInputOptions.label |
name? | string | - | - | FormInputOptions.name |
options | Record<T, string> | - | - | - |
placeholder? | string | - | - | FormInputOptions.placeholder |
required? | boolean | - | - | FormInputOptions.required |
size? | Size | - | - | FormInputOptions.size |
tooltip? | string | Expressed as markdown | FormInputOptions.tooltip | - |
value? | any | - | - | FormInputOptions.value |
visible? | boolean | - | - | FormInputOptions.visible |
SerializedAction
Properties
| Property | Type |
|---|---|
_action | string |
SerializedWorkspaceGroup
Properties
| Property | Type |
|---|---|
children | SerializedWorkspaceModel[] |
id | string |
immutable? | boolean |
lastActiveChildId? | string |
name | string |
SerializedWorkspaceModel
Properties
| Property | Type |
|---|---|
id? | string |
immutable? | boolean |
model? | any |
name | string |
parentId? | string |
preferredOpenActions? | Record<string, string> |
SetControlOption
Type Parameters
| Type Parameter |
|---|
T extends string |
Properties
| Property | Type |
|---|---|
group? | string |
icon? | ReactorIcon |
key | T |
label | string |
SetControlOptions
Extends
Type Parameters
| Type Parameter |
|---|
T extends string |
Properties
| Property | Type | Inherited from |
|---|---|---|
disabled? | boolean | - |
initialValue | T | AbstractValueControlOptions.initialValue |
options | SetControlOption<T>[] | - |
tooltip? | string | - |
SetControlWidgetProps
Properties
| Property | Type |
|---|---|
control | SetControl |
SetSettingOptions
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
category? | string | - | AbstractInteractiveControlOptions.category |
description? | string | - | AbstractInteractiveControlOptions.description |
key | string | - | AbstractInteractiveControlOptions.key |
name? | string | - | AbstractInteractiveControlOptions.name |
options | SetControlOption<string>[] | - | - |
serializeID? | string | used for busting the serialization if we have made fundamental changes that are not backwards compatible | AbstractInteractiveControlOptions.serializeID |
value | string | - | - |
SetupDeleteConfirmationOptions
Properties
| Property | Type |
|---|---|
action | Action |
message? | string |
title? | string |
SharedDropZoneProps
Extended by
Properties
| Property | Type |
|---|---|
gap_expand? | number |
gap_hint? | number |
gap_standard? | number |
vertical | boolean |
ShortcutDialogDirective
Properties
| Property | Type |
|---|---|
action | ShortcutHandlerAction |
gotKeys | (keys) => any |
ShortcutHandlerAction
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ShortcutHandler | ShortcutHandler |
Properties
| Property | Type |
|---|---|
defaultKeybindings | ShortcutChord[] |
handler | T |
id | string |
label | string |
supportsMultipleShortcuts | boolean |
ShortcutHandlerOptions
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
key | string | - | AbstractSettingOptions.key |
serializeID? | string | used for busting the serialization if we have made fundamental changes that are not backwards compatible | AbstractSettingOptions.serializeID |
type | string | - | - |
ShortcutHandlerSerialized
Properties
| Property | Type |
|---|---|
shortcuts? | ShortcutSerialized[] |
shortcutsV2 | { [action_id: string]: ShortcutSerialized[]; } |
ShortcutKey
Properties
| Property | Type |
|---|---|
key? | string |
type | keyType |
ShortcutListener
Properties
| Property | Type |
|---|---|
changed? | () => any |
deleted? | () => any |
ShortcutSerialized
Properties
| Property | Type |
|---|---|
action | string |
primary | ShortcutKey[] |
secondary | ShortcutKey[] |
ShortcutsSerialized
Properties
| Property | Type |
|---|---|
handlers | { [handler: string]: ShortcutHandlerSerialized; } |
type | "shortcuts" |
ShowTokenDialogOptions
Properties
| Property | Type |
|---|---|
expire_seconds? | number |
token | string |
type | TokenDialogType |
SimpleComboBoxDirectiveOptions
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ComboBoxItem | ComboBoxItem |
Properties
| Property | Type | Inherited from |
|---|---|---|
centerOnMobile? | boolean | BaseComboBoxDirectiveOptions.centerOnMobile |
event? | MousePosition | BaseComboBoxDirectiveOptions.event |
hideSearch? | boolean | BaseComboBoxDirectiveOptions.hideSearch |
items | T[] | BaseComboBoxDirectiveOptions.items |
searchPlaceholder? | string | BaseComboBoxDirectiveOptions.searchPlaceholder |
selected? | string | - |
sort? | boolean | BaseComboBoxDirectiveOptions.sort |
subtitle? | string | BaseComboBoxDirectiveOptions.subtitle |
title? | string | BaseComboBoxDirectiveOptions.title |
SimpleComboParameterOptions
Extends
Type Parameters
| Type Parameter |
|---|
T extends ComboBoxItem |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
comboOptions | SimpleComboBoxDirectiveOptions<T> | - | - |
description? | string | - | AbstractActionParameterOptions.description |
getDefault? | () => any | - | AbstractActionParameterOptions.getDefault |
name | string | - | AbstractActionParameterOptions.name |
required? | boolean | Default true | AbstractActionParameterOptions.required |
SimpleEntitySearchEngineComponentOptions
Extends
Extended by
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
filterResultsWithMatcher? | boolean | Defaults to true | - |
getEntities | (event) => Promise<T[]> | - | - |
label | string | - | EntitySearchEngineComponentOptions.label |
SimpleParentEntitySearchEngineOptions
Extends
Type Parameters
| Type Parameter |
|---|
Parent |
Item |
Properties
| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
filterResultsWithMatcher? | boolean | Defaults to true | - | SimpleEntitySearchEngineComponentOptions.filterResultsWithMatcher |
getEntities | (event) => Promise<Item[]> | - | SimpleEntitySearchEngineComponentOptions.getEntities | - |
label | string | - | - | SimpleEntitySearchEngineComponentOptions.label |
type | string | - | - | - |
SlidingPanelDirective
Properties
| Property | Type |
|---|---|
getContent | () => Element |
key | string |
SlidingPanelTitleWidgetProps
Properties
| Property | Type |
|---|---|
back | () => any |
title | string |
SlidingPanelWidgetProps
Properties
| Property | Type |
|---|---|
forwardRef? | RefObject<HTMLDivElement> |
panels | SlidingPanelDirective[] |
selected | string |
width | number |
SlidingPanelWidgetState
SmartDateDisplayWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
date | ReactorDateType |
SmartHeaderWidgetProps
Properties
| Property | Type |
|---|---|
additionalLeftButtons? | Btn[] |
className? | any |
email | string |
forwardRef | RefObject<HTMLDivElement> |
logoClicked | (event) => any |
name | string |
rightContent? | Element |
SmartPanelTitleWidgetProps
Properties
| Property | Type |
|---|---|
btns? | Btn & { highlight?: boolean; }[] |
color | string |
event | WorkspaceModelFactoryEvent<ReactorPanelModel<WorkspaceModelListener>> |
factory | ReactorPanelFactory |
icon | ReactorIcon |
icon2 | ReactorIcon |
name | string |
SmartPositionWidgetProps
Properties
| Property | Type |
|---|---|
animate? | boolean |
centerOnMobile? | boolean |
className? | any |
position? | MousePosition |
SmartTrayTitleWidgetProps
Properties
| Property | Type |
|---|---|
engine | WorkspaceEngine |
model | WorkspaceTrayModel |
SmartWorkspaceWidgetProps
Properties
| Property | Type |
|---|---|
forwardRef | RefObject<HTMLDivElement> |
SmartWorkspaceWidgetState
Properties
| Property | Type |
|---|---|
error | boolean |
StatusCardWidgetProps
Properties
| Property | Type |
|---|---|
btns? | Btn[] |
children? | () => Element |
className? | any |
depth? | SurfaceDepth |
label | TreeWidgetProps |
meta? | MetadataWidgetProps[] |
showStatusIcon? | boolean |
status? | StatusCardState |
StepTooltipWidgetProps
Properties
| Property | Type |
|---|---|
fullWidth? | boolean |
label? | string |
step | GuideStep |
SurfaceWidgetProps
Extends
HTMLAttributes<HTMLDivElement>
Properties
| Property | Type |
|---|---|
depth? | SurfaceDepth |
selected? | boolean |
SwitchLabelWidgetProps
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
checked | boolean | SwitchWidgetProps.checked |
disabled? | boolean | SwitchWidgetProps.disabled |
label | string | - |
onChange | (checked) => void | SwitchWidgetProps.onChange |
size? | Size | SwitchWidgetProps.size |
SwitchWidgetProps
Extended by
Properties
| Property | Type |
|---|---|
checked | boolean |
disabled? | boolean |
onChange | (checked) => void |
size? | Size |
SystemListener
Properties
| Property | Type |
|---|---|
definitionRegistered? | (definition) => any |
storeRegistered? | (store) => any |
SystemOptions
Properties
| Property | Type |
|---|---|
actionStore? | ActionStore |
comboBoxStore2? | ComboBoxStore2 |
logger? | Logger |
TabBadgeDirective
Properties
| Property | Type |
|---|---|
color | string |
content | string |
TabBounds
Properties
| Property | Type |
|---|---|
height | number |
left | number |
top | number |
width | number |
TabDirective
Properties
| Property | Type |
|---|---|
badge? | | TabBadgeDirective | (() => TabBadgeDirective) |
disabled? | boolean |
icon? | ReactorIcon |
key | string |
name | string |
rightContent? | () => ReactNode |
tabContent? | () => Element |
tabMouseEnter? | (event, tab) => any |
tabMouseLeave? | (event, tab) => any |
TabItemWidgetProps
Extended by
Properties
| Property | Type |
|---|---|
compact? | boolean |
customContent? | Element |
disabled? | boolean |
forwardRef | RefObject<HTMLDivElement> |
label | string |
onMouseEnter? | (event) => any |
onMouseLeave? | (event) => any |
selected | boolean |
size? | Size |
tabRightClick | (event) => any |
tabSelected | (event) => any |
vertical? | boolean |
TabKeyboardHelpWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
hideHelperText? | boolean |
TableColumn
Extended by
Properties
| Property | Type |
|---|---|
accessor? | (cell, row) => string | Element |
display | string | Element |
key | string |
length? | number |
noWrap? | boolean |
shrink? | boolean |
TablePillWidgetProps
Properties
| Property | Type |
|---|---|
special? | boolean |
value? | ReactNode |
TableRow
Properties
| Property | Type |
|---|---|
cells | { [key: string]: any; } |
groupKey? | string |
key | string |
selected? | boolean |
TableWidgetProps
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends TableRow | TableRow |
Properties
| Property | Type |
|---|---|
columns | TableColumn[] |
emptyLabel? | string |
onContextMenu? | (event, row) => any |
renderGroup? | (event) => Partial<TableRowsGroupWidgetProps> |
rows | T[] |
size? | Size |
TabListener
Properties
| Property | Type |
|---|---|
tabLeft | () => any |
tabRight | () => any |
TabListWidgetProps
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
badgeProvider? | (key) => TabBadgeDirective | TabSelectionWidgetProps.badgeProvider |
className? | any | TabSelectionWidgetProps.className |
compact? | boolean | TabSelectionWidgetProps.compact |
selected | string | TabSelectionWidgetProps.selected |
selectedBackgroundGenerator? | (bounds?) => Element | - |
selectedBoundsUpdated? | (rect) => any | TabSelectionWidgetProps.selectedBoundsUpdated |
size? | Size | TabSelectionWidgetProps.size |
tabItemGenerator | (tab, ref) => Element | - |
tabRightClick? | (event, tab) => any | TabSelectionWidgetProps.tabRightClick |
tabs | TabDirective[] | TabSelectionWidgetProps.tabs |
tabSelected | (key) => any | TabSelectionWidgetProps.tabSelected |
vertical? | boolean | TabSelectionWidgetProps.vertical |
TabListWidgetState
Properties
| Property | Type |
|---|---|
selectedBounds? | TabBounds |
TabMicroButtonWidgetProps
Properties
| Property | Type |
|---|---|
btn | Btn |
TabSelectionKeyboardWidgetState
Properties
| Property | Type |
|---|---|
id | string |
TabSelectionWidgetProps
Extended by
Properties
| Property | Type |
|---|---|
badgeProvider? | (key) => TabBadgeDirective |
className? | any |
compact? | boolean |
selected | string |
selectedBoundsUpdated? | (rect) => any |
size? | Size |
tabRightClick? | (event, tab) => any |
tabs | TabDirective[] |
tabSelected | (key) => any |
vertical? | boolean |
TabWidgetProps
Properties
| Property | Type |
|---|---|
engine | WorkspaceEngine |
factory | ReactorPanelFactory |
icon | ReactorIcon |
indicator? | { color: string; } |
indicator.color | string |
model | ReactorPanelModel |
selected | boolean |
title | string |
titlePrimary? | string |
TabWidgetWrapperProps
Properties
| Property | Type |
|---|---|
compact? | boolean |
forwardRef | RefObject<HTMLDivElement> |
selected | boolean |
size? | Size |
tab | TabDirective |
tabMouseEnter? | (event) => any |
tabMouseLeave? | (event) => any |
tabRightClick | (event) => any |
tabSelected | () => any |
vertical? | boolean |
TextActionParameterOptions
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
desc? | string | - | - |
description? | string | - | AbstractActionParameterOptions.description |
getDefault? | () => any | - | AbstractActionParameterOptions.getDefault |
label | string | - | - |
name | string | - | AbstractActionParameterOptions.name |
required? | boolean | Default true | AbstractActionParameterOptions.required |
TextInputOptions
Extends
AbstractTextInputOptions
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
desc? | string | - | AbstractTextInputOptions.desc |
disabled? | boolean | - | AbstractTextInputOptions.disabled |
hideError? | boolean | Keep the input invalid while allowing a nested control to render the validation message. | AbstractTextInputOptions.hideError |
inputType? | TextInputType | - | - |
label | string | - | AbstractTextInputOptions.label |
name? | string | - | AbstractTextInputOptions.name |
placeholder? | string | - | AbstractTextInputOptions.placeholder |
required? | boolean | - | AbstractTextInputOptions.required |
size? | Size | - | AbstractTextInputOptions.size |
tooltip? | string | Expressed as markdown | AbstractTextInputOptions.tooltip |
validator? | (value) => string | boolean | - | AbstractTextInputOptions.validator |
value? | string | - | AbstractTextInputOptions.value |
visible? | boolean | - | AbstractTextInputOptions.visible |
ThemeFragmentOptions
Type Parameters
| Type Parameter |
|---|
T extends ThemeFragmentStructure |
Properties
| Property | Type |
|---|---|
structure | T |
ThemeFragmentStructure
Indexable
[category: string]: {
colors: {
[key: string]: string;
};
label: string;
}
ThemeStoreListener
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
initialized | () => any | AbstractStoreListener.initialized |
themeChanged | () => any | - |
ThemeValues
Type Parameters
| Type Parameter |
|---|
T extends ThemeFragmentStructure |
Properties
| Property | Type |
|---|---|
name | string |
values | ThemeColors<T> |
Toolbar
Properties
| Property | Type |
|---|---|
allignment | Alignment |
getWidget | () => Element |
key | string |
ToolbarWidgetProps
Properties
| Property | Type |
|---|---|
hide | () => any |
position | ToolbarPosition |
preferences | ToolbarPreference |
vertical | boolean |
TooltipObjectDirective
Properties
| Property | Type |
|---|---|
gen | (event) => Element |
hint? | ToolTipPositionHint |
TooltipProps
Extended by
Properties
| Property | Type | Description |
|---|---|---|
tooltip? | string | - |
tooltipDelay? | number | Hover delay in milliseconds before showing the tooltip. Defaults to zero. |
tooltipPos? | TooltipPosition | - |
tooltipState? | SHOW | - |
TreeBadgeWidgetProps
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
action? | ButtonAction | - |
background? | string | ValidationIndicator.background |
foreground? | string | ValidationIndicator.foreground |
icon? | ReactorIcon | ValidationIndicator.icon |
tooltip? | string | ValidationIndicator.tooltip |
value? | string | ValidationIndicator.value |
TreeContentWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
depth | number |
TreeItemWidgetProps
Properties
| Property | Type |
|---|---|
draggable? | boolean |
icon | IconName |
name | string |
onClick? | (e) => any |
rightClick? | (event) => any |
selected? | boolean |
TreeLeafWidgetCommonProps
Extended by
Properties
| Property | Type | Default value | Description |
|---|---|---|---|
deactivated? | boolean | undefined | - |
depth? | number | undefined | - |
dropZoneHint? | boolean | undefined | - |
dropZoneHover? | boolean | undefined | - |
forwardRef? | RefObject<HTMLDivElement> | undefined | - |
icon? | ReactorIcon | undefined | - |
icon2? | ReactorIcon | undefined | - |
icon2Color? | string | undefined | - |
iconColor? | string | undefined | - |
iconSpin? | boolean | undefined | - |
label | string | undefined | - |
label2? | string | undefined | - |
labelColor? | string | undefined | - |
matches? | SearchEventMatch | undefined | - |
maxTags? | number | undefined | - |
metadata? | MetadataWidgetProps[] | undefined | - |
metadataDisplayOptions? | MetadataDisplayOptions | undefined | - |
mouseOver? | (event, hover) => any | undefined | - |
normalClick? | (event) => any | undefined | - |
reserveNodeToggleSpace? | boolean | true | Reserve indentation for a node toggle even though this row is a leaf. |
rightChildren? | Element | undefined | - |
rightChildrenWrap? | boolean | undefined | - |
rightClick? | (event) => any | undefined | - |
selected? | boolean | undefined | - |
tagDisplayMode? | TagDisplayMode | undefined | - |
tags? | string[] | undefined | - |
tooltip? | string | undefined | - |
wrap? | boolean | undefined | - |
TreeLeafWidgetProps
Extends
Properties
| Property | Type | Default value | Description | Inherited from |
|---|---|---|---|---|
collapse? | { changed: (collapsed, deep?) => any; collapsed: boolean; enabled?: boolean; } | undefined | - | - |
collapse.changed | (collapsed, deep?) => any | undefined | - | - |
collapse.collapsed | boolean | undefined | - | - |
collapse.enabled? | boolean | undefined | - | - |
deactivated? | boolean | undefined | - | TreeLeafWidgetCommonProps.deactivated |
depth? | number | undefined | - | TreeLeafWidgetCommonProps.depth |
dropZoneHint? | boolean | undefined | - | TreeLeafWidgetCommonProps.dropZoneHint |
dropZoneHover? | boolean | undefined | - | TreeLeafWidgetCommonProps.dropZoneHover |
forwardRef? | RefObject<HTMLDivElement> | undefined | - | TreeLeafWidgetCommonProps.forwardRef |
icon? | ReactorIcon | undefined | - | TreeLeafWidgetCommonProps.icon |
icon2? | ReactorIcon | undefined | - | TreeLeafWidgetCommonProps.icon2 |
icon2Color? | string | undefined | - | TreeLeafWidgetCommonProps.icon2Color |
iconColor? | string | undefined | - | TreeLeafWidgetCommonProps.iconColor |
iconSpin? | boolean | undefined | - | TreeLeafWidgetCommonProps.iconSpin |
label | string | undefined | - | TreeLeafWidgetCommonProps.label |
label2? | string | undefined | - | TreeLeafWidgetCommonProps.label2 |
labelColor? | string | undefined | - | TreeLeafWidgetCommonProps.labelColor |
matches? | SearchEventMatch | undefined | - | TreeLeafWidgetCommonProps.matches |
maxTags? | number | undefined | - | TreeLeafWidgetCommonProps.maxTags |
metadata? | MetadataWidgetProps[] | undefined | - | TreeLeafWidgetCommonProps.metadata |
metadataDisplayOptions? | MetadataDisplayOptions | undefined | - | TreeLeafWidgetCommonProps.metadataDisplayOptions |
mouseOver? | (event, hover) => any | undefined | - | TreeLeafWidgetCommonProps.mouseOver |
normalClick? | (event) => any | undefined | - | TreeLeafWidgetCommonProps.normalClick |
reserveNodeToggleSpace? | boolean | true | Reserve indentation for a node toggle even though this row is a leaf. | TreeLeafWidgetCommonProps.reserveNodeToggleSpace |
rightChildren? | Element | undefined | - | TreeLeafWidgetCommonProps.rightChildren |
rightChildrenWrap? | boolean | undefined | - | TreeLeafWidgetCommonProps.rightChildrenWrap |
rightClick? | (event) => any | undefined | - | TreeLeafWidgetCommonProps.rightClick |
selected? | boolean | undefined | - | TreeLeafWidgetCommonProps.selected |
tagDisplayMode? | TagDisplayMode | undefined | - | TreeLeafWidgetCommonProps.tagDisplayMode |
tags? | string[] | undefined | - | TreeLeafWidgetCommonProps.tags |
tooltip? | string | undefined | - | TreeLeafWidgetCommonProps.tooltip |
wrap? | boolean | undefined | - | TreeLeafWidgetCommonProps.wrap |
TreePresenterGenerationEvent
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
entity | T |
tree | ReactorTreeEntity |
TreeWidgetProps
Extends
Properties
| Property | Type | Default value | Description | Overrides | Inherited from |
|---|---|---|---|---|---|
children? | (depth) => any | undefined | - | - | - |
className? | any | undefined | - | - | - |
collapsed? | boolean | undefined | - | - | - |
deactivated? | boolean | undefined | - | - | TreeLeafWidgetCommonProps.deactivated |
depth? | number | undefined | - | - | TreeLeafWidgetCommonProps.depth |
dropZoneHint? | boolean | undefined | - | - | TreeLeafWidgetCommonProps.dropZoneHint |
dropZoneHover? | boolean | undefined | - | - | TreeLeafWidgetCommonProps.dropZoneHover |
empty? | boolean | undefined | - | - | - |
emptyMessage? | string | undefined | - | - | - |
forwardRef? | RefObject<HTMLDivElement> | undefined | - | - | TreeLeafWidgetCommonProps.forwardRef |
hideOpenIcon? | boolean | undefined | - | - | - |
icon? | ReactorIcon | undefined | - | - | TreeLeafWidgetCommonProps.icon |
icon2? | ReactorIcon | undefined | - | - | TreeLeafWidgetCommonProps.icon2 |
icon2Color? | string | undefined | - | - | TreeLeafWidgetCommonProps.icon2Color |
iconColor? | string | undefined | - | - | TreeLeafWidgetCommonProps.iconColor |
iconSpin? | boolean | undefined | - | - | TreeLeafWidgetCommonProps.iconSpin |
label | string | undefined | - | - | TreeLeafWidgetCommonProps.label |
label2? | string | undefined | - | - | TreeLeafWidgetCommonProps.label2 |
labelColor? | string | undefined | - | - | TreeLeafWidgetCommonProps.labelColor |
loading? | boolean | undefined | - | - | - |
loadingMessage? | string | undefined | - | - | - |
matches? | SearchEventMatch | undefined | - | - | TreeLeafWidgetCommonProps.matches |
maxTags? | number | undefined | - | - | TreeLeafWidgetCommonProps.maxTags |
metadata? | MetadataWidgetProps[] | undefined | - | - | TreeLeafWidgetCommonProps.metadata |
metadataDisplayOptions? | MetadataDisplayOptions | undefined | - | - | TreeLeafWidgetCommonProps.metadataDisplayOptions |
mouseOver? | (event, hover) => any | undefined | - | - | TreeLeafWidgetCommonProps.mouseOver |
normalClick? | (event) => any | undefined | - | - | TreeLeafWidgetCommonProps.normalClick |
onCollapsedChanged? | (collapsed, deep) => any | undefined | - | - | - |
openDefault? | boolean | undefined | - | - | - |
openOnSingleClick? | boolean | undefined | - | - | - |
reserveNodeToggleSpace? | boolean | true | Reserve indentation for a node toggle even though this row is a leaf. | - | TreeLeafWidgetCommonProps.reserveNodeToggleSpace |
rightChildren? | Element | undefined | - | - | TreeLeafWidgetCommonProps.rightChildren |
rightChildrenWrap? | boolean | undefined | - | - | TreeLeafWidgetCommonProps.rightChildrenWrap |
rightClick? | (event) => any | undefined | - | - | TreeLeafWidgetCommonProps.rightClick |
selected? | boolean | undefined | - | - | TreeLeafWidgetCommonProps.selected |
tagDisplayMode? | TagDisplayMode | undefined | - | - | TreeLeafWidgetCommonProps.tagDisplayMode |
tags? | string[] | undefined | - | - | TreeLeafWidgetCommonProps.tags |
tooltip? | string | undefined | - | TreeLeafWidgetCommonProps.tooltip | - |
wrap? | boolean | undefined | - | - | TreeLeafWidgetCommonProps.wrap |
TreeWidgetState
Properties
| Property | Type |
|---|---|
open | boolean |
UIDirective
Extended by
Properties
| Property | Type |
|---|---|
initialValue? | string |
position | MousePosition |
renderCallout? | RenderCalloutFunction |
resolve | (item) => any |
title? | string |
title2? | string |
type | UIDirectiveType |
UIItemsDirective
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ComboBoxItem | ComboBoxItem |
Properties
| Property | Type | Inherited from |
|---|---|---|
buttons? | boolean | - |
initialValue? | string | UIDirective.initialValue |
items | T[] | - |
position | MousePosition | UIDirective.position |
renderCallout? | RenderCalloutFunction | UIDirective.renderCallout |
resolve | (item) => any | UIDirective.resolve |
title? | string | UIDirective.title |
title2? | string | UIDirective.title2 |
type | UIDirectiveType | UIDirective.type |
UISearchEngineDirective
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
engine | ComboBoxSearchEngine | - |
initialValue? | string | UIDirective.initialValue |
position | MousePosition | UIDirective.position |
renderCallout? | RenderCalloutFunction | UIDirective.renderCallout |
resolve | (item) => any | UIDirective.resolve |
title? | string | UIDirective.title |
title2? | string | UIDirective.title2 |
type | UIDirectiveType | UIDirective.type |
UploadImagePreviewWidgetProps
Properties
| Property | Type |
|---|---|
className? | any |
clear | () => any |
media? | ImageMedia |
mimeTypes? | string[] |
onUpload | (media) => void | Promise<void> |
UseAnchoredOverlayOptions
Extends
Omit<AnchoredOverlayOptions,"bounds"|"render">
Properties
| Property | Type | Inherited from |
|---|---|---|
clickThrough | boolean | AnchoredOverlayOptions.clickThrough |
enabled? | boolean | - |
forwardRef? | RefObject<HTMLElement> | - |
id? | string | AnchoredOverlayOptions.id |
placement | AnchoredOverlayPlacement | AnchoredOverlayOptions.placement |
render | (context) => ReactNode | - |
source | string | AnchoredOverlayOptions.source |
UseAttentionProps
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
V extends object | object |
T extends ComponentSelection<V> | ComponentSelection<V> |
Properties
| Property | Type |
|---|---|
boundsMutator? | (bounds) => MutableRect |
forwardRef? | RefObject<HTMLElement> |
ready? | boolean |
selection? | V |
type | string |
UseButtonProps
Properties
| Property | Type |
|---|---|
btn | Btn |
forwardRef? | RefObject<HTMLDivElement> |
UseCopyButtonProps
Properties
| Property | Type |
|---|---|
value | string |
UseDimensionObserverOptions
Properties
| Property | Type |
|---|---|
changed | (dimensions) => any |
element | RefObject<HTMLElement> |
enabled? | boolean |
UseDraggableEntityProps
Properties
| Property | Type |
|---|---|
entity | EncodedEntity |
forwardRef | RefObject<HTMLDivElement> |
UseDraggableRawProps
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
dragStart? | () => any |
encode | () => EncodedDragResult |
forwardRef | RefObject<HTMLDivElement> |
multiple? | boolean |
UseDroppableBetweenZoneOption
Extends
Type Parameters
| Type Parameter |
|---|
T extends AbstractDropZone |
Properties
| Property | Type | Inherited from |
|---|---|---|
children | Element[] | - |
dropzone | T | UseDroppableZoneOptions.dropzone |
forwardRef | RefObject<HTMLDivElement> | UseDroppableZoneOptions.forwardRef |
gap_expand? | number | SharedDropZoneProps.gap_expand |
gap_hint? | number | SharedDropZoneProps.gap_hint |
gap_standard? | number | SharedDropZoneProps.gap_standard |
setIndex | (zone, index) => any | - |
vertical | boolean | SharedDropZoneProps.vertical |
useDroppableEntityOptions
Type Parameters
| Type Parameter |
|---|
T |
Properties
| Property | Type |
|---|---|
dropZoneEntity | any |
forwardRef | RefObject<HTMLDivElement> |
UseDroppableRawOptions
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends { [key: string]: any; } | { } |
Properties
| Property | Type |
|---|---|
accepts | (mimes) => boolean |
dragexit? | () => any |
dragover? | () => any |
dropped? | (event) => any |
forwardRef | RefObject<HTMLDivElement> |
key? | string |
UseDroppableZoneOptions
Extended by
Type Parameters
| Type Parameter |
|---|
T extends AbstractDropZone |
Properties
| Property | Type |
|---|---|
dropzone | T |
forwardRef | RefObject<HTMLDivElement> |
UsePanZoomGesturesOptions
Properties
| Property | Type |
|---|---|
enabled? | boolean |
forwardRef | RefObject<HTMLElement> |
pan | (delta) => void |
zoom | (gesture) => void |
UsePanZoomOptions
Properties
| Property | Type |
|---|---|
forwardRef | RefObject<HTMLElement> |
height | number |
maxScale? | number |
minScale? | number |
width | number |
User
Properties
| Property | Type |
|---|---|
email | string |
name | string |
online | boolean |
UserAction
Properties
| Property | Type |
|---|---|
action_id | string |
end_timestamp | string |
source | ActionSource |
start_timestamp | string |
success | boolean |
trace_id? | string |
UseValidatorProps
Properties
| Property | Type |
|---|---|
validator? | Validator |
UXStoreOptions
Properties
| Property | Type |
|---|---|
comboBoxStore | ComboBoxStore2 |
system | System |
workspaceStore | WorkspaceStore |
ValidationIndicator
Extended by
Properties
| Property | Type |
|---|---|
background? | string |
foreground? | string |
icon? | ReactorIcon |
tooltip? | string |
value? | string |
ValidationResultAllowed
Properties
| Property | Type |
|---|---|
type | ALLOWED |
ValidationResultBlocked
Properties
| Property | Type |
|---|---|
indicator? | ValidationIndicator |
message? | string |
onActivate | () => void | Promise<void> |
type | BLOCKED |
ValidationResultDeferred
Properties
| Property | Type |
|---|---|
message? | string |
type | DEFERRED |
ValidationResultDisabled
Properties
| Property | Type |
|---|---|
message? | string |
type | DISABLED |
ValidationResultHidden
Properties
| Property | Type |
|---|---|
type | HIDDEN |
ValidationResultPending
Properties
| Property | Type |
|---|---|
message? | string |
type | PENDING |
VisibleComponentIdentifier
Type Parameters
| Type Parameter | Default type |
|---|---|
S extends any | any |
T extends ComponentSelection<S> | ComponentSelection<S> |
Properties
| Property | Type |
|---|---|
generate | (selection) => any |
id | string |
selection | S |
type | string |
VisorLoadingMessage
Properties
| Property | Type |
|---|---|
message | string |
timestamp | number |
VisorMetadataInstance
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
color? | string | ReportValueParams.color |
icon? | { color: string; name: ReactorIcon; spin?: boolean; } | ReportValueParams.icon |
icon.color | string | - |
icon.name | ReactorIcon | - |
icon.spin? | boolean | - |
label | string | - |
onClick? | MouseEventHandler<any> | ReportValueParams.onClick |
value | string | ReportValueParams.value |
VisorMetadataOptions
Properties
| Property | Type |
|---|---|
configurationName? | string |
displayDefault | boolean |
displayName | string |
key | string |
VisorWidgetProps
Properties
| Property | Type |
|---|---|
metadata | VisorMetadata[] |
WidgetTrayItemProps
Properties
| Property | Type |
|---|---|
collapsed | boolean |
icon | ReactorIcon |
name | string |
onleft | boolean |
selected | boolean |
WidgetTrayItemState
Properties
| Property | Type |
|---|---|
width | number |
WorkspaceActivation
Properties
| Property | Type |
|---|---|
topWorkspace | WorkspaceModel |
workspace | WorkspaceModel |
WorkspaceContextActionContext
Properties
| Property | Type |
|---|---|
dialogStore | DialogStore |
workspaceStore | WorkspaceStore |
WorkspaceGroupOptions
Properties
| Property | Type |
|---|---|
children | ( | WorkspaceModel | WorkspaceModelOptions)[] |
id? | string |
immutable? | boolean |
lastActiveChildId? | string |
name | string |
priority? | number |
WorkspaceModelCloneOptions
Properties
| Property | Type |
|---|---|
engine | ReactorWorkspaceEngine |
generateRootModel | () => ReactorRootWorkspaceModel |
id | string |
name | string |
WorkspaceModelOptions
Properties
| Property | Type |
|---|---|
id? | string |
immutable? | boolean |
model? | ReactorRootWorkspaceModel |
name | string |
parentId? | string |
preferredOpenActions? | Record<string, string> |
priority? | number |
WorkspacePrefsSerialized
Extended by
Properties
| Property | Type |
|---|---|
current | string |
currentTop? | string |
models | SerializedWorkspaceEntry[] |
type | "workspaces" |
version? | 1 | 2 | 3 |
WorkspaceStoreListener
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
deserialized | () => any | AbstractPersistedStoreListener.deserialized |
initialized | () => any | AbstractPersistedStoreListener.initialized |
reset? | () => any | - |
workspaceActivated | (workspace) => any | - |
workspaceGenerated | (model) => any | - |
Type Aliases
AssetContent
type AssetContent = ArrayBuffer | File | string | Uint8Array;
ButtonAction
type ButtonAction =
| ButtonActionNew
| ButtonActionLegacy;
ButtonActionLegacy
type ButtonActionLegacy = (event, loading?) => any;
Parameters
| Parameter | Type |
|---|---|
event | MousePosition |
loading? | (loading) => any |
Returns
any
ButtonActionNew
type ButtonActionNew = (event) => Promise<any>;
Parameters
| Parameter | Type |
|---|---|
event | MousePosition |
Returns
Promise<any>
CategoryInfo
type CategoryInfo = Omit<TreeWidgetProps, "forwardRef" | "children" | "rightClick"> & {
sortKey?: string;
};
Type Declaration
| Name | Type |
|---|---|
sortKey? | string |
CommonDialogOptions
type CommonDialogOptions = Omit<DialogDirective, "type" | "id" | "resolve">;
ComponentSelectorGenerator
type ComponentSelectorGenerator = (step) => any;
Parameters
| Parameter | Type |
|---|---|
step | GuideStep |
Returns
any
CreateStyled
type CreateStyled<T> = Component<T> & Tags<T>;
Type Parameters
| Type Parameter |
|---|
T |
CreateWorkspaceActionEvent
type CreateWorkspaceActionEvent = ParameterizedActionEvent<{
name: string;
}>;
EventType
type EventType<T> = T extends Action<any, infer TGenerics, any> ? TGenerics["EVENT"] : never;
Type Parameters
| Type Parameter |
|---|
T |
FormErrorRecord
type FormErrorRecord = FormWarningRecord;
FormWarningRecord
type FormWarningRecord = Record<string, string[]>;
GeneratedIDEWorkspace
type GeneratedIDEWorkspace = WorkspaceModel;
GeneratedWorkspaceEntry
type GeneratedWorkspaceEntry = WorkspaceEntry;
GenerateMediaOptions
type GenerateMediaOptions = Omit<AbstractMediaOptions, "type">;
GetTheme
type GetTheme<C> = C extends ThemeFragment<infer T> ? ThemeColors<T> : unknown;
Type Parameters
| Type Parameter |
|---|
C extends ThemeFragment |
GroupingOption
type GroupingOption =
| GroupingOptionValue
| MetadataLabelGroupingOption;
Serializable grouping values, including metadata-label grouping.
IDEWorkspace
type IDEWorkspace = WorkspaceModel;
InputProps
type InputProps = Omit<React.InputHTMLAttributes<HTMLInputElement>, "size"> & {
size?: Size;
};
Type Declaration
| Name | Type |
|---|---|
size? | Size |
ListenerCallback
type ListenerCallback = (btn) => Promise<boolean>;
Parameters
| Parameter | Type |
|---|---|
btn | Btn |
Returns
Promise<boolean>
MetadataDisplayOptions
type MetadataDisplayOptions = Record<string, MetadataDisplayOption>;
MobileScreen
type MobileScreen =
| MobilePanelScreen
| MobileTabScreen;
ReactorCharIcon
type ReactorCharIcon = {
chars?: string;
};
Properties
| Property | Type |
|---|---|
chars? | string |
ReactorIcon
type ReactorIcon =
| ReactorCharIcon
| ReactorUrlIcon
| IconName;
ReactorSizeSource
type ReactorSizeSource =
| Size
| {
$size?: Size;
size?: unknown;
};
ReactorTreeEntity
type ReactorTreeEntity =
| ReactorTreeNode
| ReactorTreeLeaf;
ReactorTreeProps
type ReactorTreeProps = Omit<TreeWidgetProps, "openDefault" | "depth">;
ReactorTreePropsTransformer
type ReactorTreePropsTransformer = (props, depth, mouseOver) => Partial<ReactorTreeProps>;
Parameters
| Parameter | Type |
|---|---|
props | Partial<ReactorTreeProps> |
depth | number |
mouseOver | boolean |
Returns
Partial<ReactorTreeProps>
ReactorUrlIcon
type ReactorUrlIcon = {
url?: string;
};
Properties
| Property | Type |
|---|---|
url? | string |
RegexSearchWidgetState
type RegexSearchWidgetState = RegexSearchPayload;
RenderCalloutFunction
type RenderCalloutFunction<T> = (event) => T;
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ComboBoxItem | ComboBoxItem |
Parameters
| Parameter | Type |
|---|---|
event | RenderCalloutEvent<T> |
Returns
T
RenderTreeChild
type RenderTreeChild = (options) => React.ReactNode;
Parameters
| Parameter | Type |
|---|---|
options | RenderTreeChildOptions |
Returns
React.ReactNode
SelectProps
type SelectProps = Omit<React.SelectHTMLAttributes<HTMLSelectElement>, "size"> & {
size?: Size;
};
Type Declaration
| Name | Type |
|---|---|
size? | Size |
SerializedPresenterContext
type SerializedPresenterContext<State, Settings> = {
controlValues: Settings;
state: State;
};
Type Parameters
| Type Parameter | Default type |
|---|---|
State extends { } | { } |
Settings extends { } | { } |
Properties
| Property | Type |
|---|---|
controlValues | Settings |
state | State |
SerializedWorkspaceEntry
type SerializedWorkspaceEntry =
| SerializedWorkspaceModel
| SerializedWorkspaceGroup;
ShowContextMenuForEntityOptions
type ShowContextMenuForEntityOptions = Pick<SimpleComboBoxDirectiveOptions, "hideSearch"> & {
additionalItems?: ComboBoxItem[];
};
Type Declaration
| Name | Type |
|---|---|
additionalItems? | ComboBoxItem[] |
SimplifiedFormInputType
type SimplifiedFormInputType<T> = FormInput<{
LISTENER: FormInputListener<T>;
OPTIONS: FormInputOptions<T>;
VALUE: T;
}>;
Type Parameters
| Type Parameter |
|---|
T |
SurfaceDepth
type SurfaceDepth = 0 | 1 | 2 | 3;
TabSelectionRefMap
type TabSelectionRefMap = {
[key: string]: RefObject<HTMLDivElement>;
};
Index Signature
[key: string]: RefObject<HTMLDivElement>
TextAreaProps
type TextAreaProps = React.TextareaHTMLAttributes<HTMLTextAreaElement> & {
size?: Size;
};
Type Declaration
| Name | Type |
|---|---|
size? | Size |
ThemeColors
type ThemeColors<T> = { [P in keyof T]: { [C in keyof T[P]["colors"]]: string } };
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends ThemeFragmentStructure | ThemeFragmentStructure |
ToolTipDirective
type ToolTipDirective = string | TooltipObjectDirective;
ValidationResult
type ValidationResult =
| ValidationResultAllowed
| ValidationResultDeferred
| ValidationResultPending
| ValidationResultHidden
| ValidationResultDisabled
| ValidationResultBlocked;
Validator
type Validator = () => ValidationResult;
Returns
WorkspaceEntry
type WorkspaceEntry =
| WorkspaceModel
| WorkspaceGroup;
WorkspaceGenerator
type WorkspaceGenerator =
| {
generateWorkspace: WorkspaceGeneratorCallback;
}
| {
generateAdvancedWorkspace?: WorkspaceGeneratorCallback;
generateSimpleWorkspace?: WorkspaceGeneratorCallback;
};
Variables
ActionHeaderButtonWidget
const ActionHeaderButtonWidget: React.FC<ActionHeaderButtonWidgetProps>;
ArrayInputWidget
const ArrayInputWidget: React.FC<ArrayInputWidgetProps>;
ArraySetInputEntryWidget
const ArraySetInputEntryWidget: React.FC<React.PropsWithChildren<{
input: FormInput;
label: string;
remove: () => any;
}>>;
ArraySetInputWidget
const ArraySetInputWidget: React.FC<ArraySetInputWidgetProps>;
AttentionWrapperWidget
const AttentionWrapperWidget: <V, T>(props) => React.JSX.Element;
Type Parameters
| Type Parameter | Default type |
|---|---|
V extends object | object |
T extends ComponentSelection<V> | ComponentSelection<V> |
Parameters
| Parameter | Type |
|---|---|
props | AttentionWrapperWidgetProps<V, T> |
Returns
React.JSX.Element
BooleanControlWidget
const BooleanControlWidget: React.FC<BooleanControlWidgetProps>;
BooleanInputWrapperWidget
const BooleanInputWrapperWidget: React.FC<BooleanInputWrapperWidgetProps>;
BorderLayoutWidget
const BorderLayoutWidget: React.FC<React.PropsWithChildren<BorderLayoutWidgetProps>>;
BreadCrumbTabSelectionWidget
const BreadCrumbTabSelectionWidget: React.FC<BreadCrumbTabSelectionWidgetProps>;
BreadCrumbWidget
const BreadCrumbWidget: React.FC<BreadCrumbWidgetProps>;
Bunny
const Bunny: ThemeColors<{
button: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
buttonLink: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
buttonPrimary: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
canvas: {
colors: {
background: string;
grid: string;
};
label: string;
};
cards: {
colors: {
foreground: string;
tagBackground: string;
tagLabelBackground: string;
tagLabelForeground: string;
};
label: string;
};
changelog: {
colors: {
codeBackground: string;
codeForeground: string;
};
label: string;
};
combobox: {
colors: {
background: string;
backgroundSelected: string;
border: string;
headerBackground: string;
headerForeground: string;
shadowColor: string;
text: string;
textSelected: string;
};
label: string;
};
dnd: {
colors: {
hintColor: string;
hoverColor: string;
};
label: string;
};
floating: {
colors: {
background: string;
backgroundInactive: string;
border: string;
shadowColor: string;
};
label: string;
};
footer: {
colors: {
background: string;
};
label: string;
};
forms: {
colors: {
checkbox: string;
checkboxChecked: string;
description: string;
groupBorder: string;
groupLabelForeground: string;
inputBackground: string;
inputBorder: string;
inputForeground: string;
toggleHandleColor: string;
toggleOnColor: string;
};
label: string;
};
graphs: {
colors: {
fillStop1: string;
fillStop2: string;
fillStop3: string;
grid: string;
line: string;
thresholdLine: string;
};
label: string;
};
guide: {
colors: {
accent: string;
accentText: string;
tooltipBackground: string;
};
label: string;
};
header: {
colors: {
background: string;
backgroundLogo: string;
backgroundLogoHover: string;
foreground: string;
primary: string;
secondary: string;
};
label: string;
};
icons: {
colors: {
color: string;
dualIconBackground: string;
};
label: string;
};
meta: {
colors: {
background: string;
foreground: string;
};
label: string;
};
mobileNavigation: {
colors: {
background: string;
border: string;
foreground: string;
selectedBackground: string;
selectedForeground: string;
};
label: string;
};
panels: {
colors: {
background: string;
divider: string;
iconBackground: string;
itemIconColorSelected: string;
scrollBar: string;
searchBackground: string;
searchForeground: string;
tabBackgroundSelected: string;
tabForeground: string;
tabForegroundSelected: string;
titleBackground: string;
titleForeground: string;
trayBackground: string;
trayButton: string;
trayButtonSelected: string;
};
label: string;
};
status: {
colors: {
failed: string;
failedForeground: string;
loading: string;
success: string;
};
label: string;
};
surfaces: {
colors: {
depth0Background: string;
depth0Border: string;
depth1Background: string;
depth1Border: string;
depth2Background: string;
depth2Border: string;
depth3Background: string;
depth3Border: string;
selectedBorder: string;
};
label: string;
};
table: {
colors: {
border: string;
columnBackground: string;
columnForeground: string;
even: string;
groupBackground: string;
groupBorder: string;
odd: string;
pills: string;
pillsSpecial: string;
selectedEven: string;
selectedOdd: string;
text: string;
};
label: string;
};
tabs: {
colors: {
selectedAccentSingle: string;
selectedBackground: string;
};
label: string;
};
text: {
colors: {
primary: string;
secondary: string;
};
label: string;
};
tooltips: {
colors: {
background: string;
};
label: string;
};
trees: {
colors: {
labelColor: string;
overflowBackground: string;
selectedBackground: string;
};
label: string;
};
workspace: {
colors: {
background: string;
overlayBackground: string;
overlayBackgroundHover: string;
overlayBorder: string;
overlayBorderHover: string;
overlayDividerColor: string;
overlayDividerHover: string;
};
label: string;
};
workspaceSubMenu: {
colors: {
background: string;
backgroundUnPinned: string;
foreground: string;
};
label: string;
};
}>;
ButtonWidgetIcon
const ButtonWidgetIcon: React.FC<{
className?: any;
icon: ReactorIcon;
loading: boolean;
}>;
CardWidget
const CardWidget: React.FC<CardWidgetProps>;
CascadingSearchEngineComboBoxDirectiveWidget
const CascadingSearchEngineComboBoxDirectiveWidget: React.FC<CascadingSearchEngineComboBoxDirectiveWidgetProps>;
CheckboxLabelWidget
const CheckboxLabelWidget: React.FC<CheckboxLabelWidgetProps>;
CheckboxWidget
const CheckboxWidget: React.FC<CheckboxWidgetProps>;
COMBOBOX_ITEM_H_PADDING
const COMBOBOX_ITEM_H_PADDING: 8 = 8;
ComboBoxWidget
const ComboBoxWidget: React.FC<ComboBoxWidgetProps>;
CommandPalletEntryWidget
const CommandPalletEntryWidget: React.FC<React.PropsWithChildren<CommandPalletEntryWidgetProps>>;
ComposableComboBoxDirectiveWidget
const ComposableComboBoxDirectiveWidget: React.FC<ComposableComboBoxDirectiveWidgetProps>;
ContextMenuTriggerWidget
const ContextMenuTriggerWidget: ForwardRefExoticComponent<ContextMenuTriggerWidgetProps & Omit<HTMLAttributes<HTMLDivElement>, "onClick" | "onContextMenu"> & RefAttributes<HTMLDivElement>>;
ControlledListWidget
const ControlledListWidget: React.FC<ControlledListWidgetProps>;
CoreTreeWidget
const CoreTreeWidget: React.FC<CoreTreeWidgetProps>;
CRON_DEFAULT
const CRON_DEFAULT: string[];
Default value used when initializing
CustomTooltip
const CustomTooltip: React.FC<TooltipContentProps<number, number | string> & {
props: GraphWidgetProps;
}>;
DateControlWidget
const DateControlWidget: React.FC<DateControlWidgetProps>;
DateDisplayWidget
const DateDisplayWidget: React.FC<DateDisplayWidgetProps>;
DateRangeSelectorWidget
const DateRangeSelectorWidget: React.FC<DateRangeSelectorWidgetProps>;
DateTimeButtonWidget
const DateTimeButtonWidget: React.FC<DateTimePickerWidgetProps>;
DateTimePickerWidget
const DateTimePickerWidget: React.FC<DateTimePickerWidgetProps>;
DEFAULT_METADATA_DISPLAY_OPTION
const DEFAULT_METADATA_DISPLAY_OPTION: "_default" = '_default';
DefaultFloatingWindowWidget
const DefaultFloatingWindowWidget: React.FC<DefaultFloatingWindowWidgetProps>;
DialogWrapperWidget
const DialogWrapperWidget: React.FC<DialogWrapperWidgetProps>;
DualIconWidget
const DualIconWidget: React.FC<DualIconWidgetProps>;
EMPTY_REACTOR_PANEL_TYPE
const EMPTY_REACTOR_PANEL_TYPE: "empty" = 'empty';
EmptyTableWidget
const EmptyTableWidget: React.FC<EmptyTableWidgetProps>;
EntityCardsCollectionWidget
const EntityCardsCollectionWidget: <T>(props) => Element;
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
props | EntityCardsCollectionWidgetProps<T> |
Returns
Element
EntityControlWidget
const EntityControlWidget: React.FC<EntityControlWidgetProps>;
EntityHeaderButtonWidget
const EntityHeaderButtonWidget: React.FC<EntityHeaderButtonWidgetProps>;
EntityPanelWidget
const EntityPanelWidget: React.FC<EntityPanelWidgetProps>;
EntityTreeCollectionWidget
const EntityTreeCollectionWidget: <T>(props) => Element;
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
props | EntityTreeCollectionWidgetProps<T> |
Returns
Element
ENV
const ENV: ENV;
ExpandZoneWidget
const ExpandZoneWidget: React.FC<ExpandZoneWidgetProps>;
FileControlWidget
const FileControlWidget: React.FC<FileControlWidgetProps>;
FloatingPanelButtonWidget
const FloatingPanelButtonWidget: React.FC<FloatingPanelButtonWidgetProps>;
FooterLoaderWidget
const FooterLoaderWidget: React.FC<FooterLoaderWidgetProps>;
FormErrorDisplayWidget
const FormErrorDisplayWidget: React.FC<FormErrorDisplayProps>;
FormInputWidget
const FormInputWidget: React.FC<FormInputWidgetProps>;
generateReactorComponentSelections
const generateReactorComponentSelections: ComponentSelectorGenerator;
GraphWidget
const GraphWidget: React.FC<GraphWidgetProps>;
GroupingOption
GroupingOption: {
getMetadataLabel: string;
metadataLabel: `metadata-label:${string}`;
};
Type Declaration
| Name | Type |
|---|---|
getMetadataLabel() | (option) => string |
metadataLabel() | (label) => `metadata-label:${string}` |
GroupWidget
const GroupWidget: React.FC<GroupWidgetProps>;
HoverWidget
const HoverWidget: React.FC<HoverWidgetProps>;
IconWidget
const IconWidget: React.FC<IconWidgetProps>;
IndividualSettingsWidget
const IndividualSettingsWidget: React.FC<React.PropsWithChildren<IndividualSettingsWidgetProps>>;
inject
const inject: ReturnType<typeof createDecorator>;
InnerGraphWidget
const InnerGraphWidget: React.FC<GraphWidgetProps>;
Input
const Input: React.FC<InputProps>;
InputTransformedWidget
const InputTransformedWidget: React.FC<InputTransformedWidgetProps>;
ioc
const ioc: Container;
LAYER_ANIMATION_DURATION
const LAYER_ANIMATION_DURATION: 500 = 500;
LayerDirectiveWidget
const LayerDirectiveWidget: React.FC<LayerDirectiveWidgetProps>;
LayerWidget
const LayerWidget: React.FC<React.PropsWithChildren<LayerWidgetProps>>;
LoadingPanelWidget
const LoadingPanelWidget: React.FC<LoadingPanelWidgetProps>;
MarkdownWidget
const MarkdownWidget: React.FC<MarkdownWidgetProps>;
MatchesWidget
const MatchesWidget: React.FC<MatchesWidgetProps>;
MetaBarWidget
const MetaBarWidget: React.FC<MetaBarWidgetProps>;
MetadataWidget
const MetadataWidget: React.FC<MetadataWidgetProps>;
MobileHeaderWidget
const MobileHeaderWidget: React.FC<MobileHeaderWidgetProps>;
MobileNavPillWidget
const MobileNavPillWidget: React.FC<MobileNavPillWidgetProps>;
MobilePanelScreenWidget
const MobilePanelScreenWidget: React.FC<MobilePanelScreenWidgetProps>;
MobileReactorShell
const MobileReactorShell: React.FC<MobileReactorShellProps>;
MobileTabScreenWidget
const MobileTabScreenWidget: React.FC<MobileTabScreenWidgetProps>;
MobileWorkspaceDrawerWidget
const MobileWorkspaceDrawerWidget: React.FC<MobileWorkspaceDrawerWidgetProps>;
MobileWorkspaceWidget
const MobileWorkspaceWidget: React.FC<MobileWorkspaceWidgetProps>;
MultiSelectInputWidget
const MultiSelectInputWidget: React.FC<MultiSelectInputWidgetProps>;
OverflowCollapseWidget
const OverflowCollapseWidget: React.FC<OverflowCollapseWidgetProps>;
Shows a fallback when its full content does not fit its allocated width.
The full content remains mounted in an absolute measurement layer. This keeps its natural width stable without allowing it to alter the surrounding flex layout while collapsed.
PaginatedCollectionWidget
const PaginatedCollectionWidget: React.FC<React.PropsWithChildren<PaginatedCollectionWidgetProps>>;
PANEL_CONTENT_PADDING
const PANEL_CONTENT_PADDING: 6 = 6;
PanelButtonWidget
const PanelButtonWidget: React.FC<PanelBtn & {
className?: string;
size?: Size;
}>;
PanelTitleToolbarButtonWidget
const PanelTitleToolbarButtonWidget: React.FC<PanelTitleToolbarButtonProps>;
PanelWithFooterWidget
const PanelWithFooterWidget: React.FC<React.PropsWithChildren<PanelWithFooterWidgetProps>>;
PARENT_VARIABLE
const PARENT_VARIABLE: "parent" = 'parent';
PillWidget
const PillWidget: React.FC<PillWidgetProps>;
PinnableZoneWidget
const PinnableZoneWidget: React.FC<PinnableZoneWidgetProps>;
RawBodyWidget
const RawBodyWidget: React.FC<React.PropsWithChildren<RawBodyWidgetProps>>;
RawEntry
const RawEntry: React.FC<PartialEntryProps>;
REACTOR_DEFAULT_LOG_LEVEL
const REACTOR_DEFAULT_LOG_LEVEL: LogLevel;
REACTOR_MOBILE_MEDIA_QUERY
const REACTOR_MOBILE_MEDIA_QUERY: string;
REACTOR_TABLET_MEDIA_QUERY
const REACTOR_TABLET_MEDIA_QUERY: string;
REACTOR_VIEWPORT_BREAKPOINTS
const REACTOR_VIEWPORT_BREAKPOINTS: ReactorViewportBreakpoints;
ReactorDialogWidget
const ReactorDialogWidget: React.FC<React.PropsWithChildren<ReactorDialogWidgetProps>>;
ReactorEntityDnDWrapper
const ReactorEntityDnDWrapper: React.FC<ReactorEntityDnDWrapperProps>;
ReactorEntityWrapperWidget
const ReactorEntityWrapperWidget: React.FC<React.PropsWithChildren<ReactorEntityWrapperWidgetProps>>;
ReactorSizeContext
const ReactorSizeContext: Context<Size>;
ReactorSizeProvider
const ReactorSizeProvider: React.FC<ReactorSizeProviderProps>;
ReactorTooltipWidget
const ReactorTooltipWidget: React.FC<ReactorTooltipWidgetProps>;
ReadOnlyMetadataWidget
const ReadOnlyMetadataWidget: React.FC<ReadOnlyMetadataWidgetProps>;
Scarlet
const Scarlet: ThemeColors<{
button: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
buttonLink: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
buttonPrimary: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
canvas: {
colors: {
background: string;
grid: string;
};
label: string;
};
cards: {
colors: {
foreground: string;
tagBackground: string;
tagLabelBackground: string;
tagLabelForeground: string;
};
label: string;
};
changelog: {
colors: {
codeBackground: string;
codeForeground: string;
};
label: string;
};
combobox: {
colors: {
background: string;
backgroundSelected: string;
border: string;
headerBackground: string;
headerForeground: string;
shadowColor: string;
text: string;
textSelected: string;
};
label: string;
};
dnd: {
colors: {
hintColor: string;
hoverColor: string;
};
label: string;
};
floating: {
colors: {
background: string;
backgroundInactive: string;
border: string;
shadowColor: string;
};
label: string;
};
footer: {
colors: {
background: string;
};
label: string;
};
forms: {
colors: {
checkbox: string;
checkboxChecked: string;
description: string;
groupBorder: string;
groupLabelForeground: string;
inputBackground: string;
inputBorder: string;
inputForeground: string;
toggleHandleColor: string;
toggleOnColor: string;
};
label: string;
};
graphs: {
colors: {
fillStop1: string;
fillStop2: string;
fillStop3: string;
grid: string;
line: string;
thresholdLine: string;
};
label: string;
};
guide: {
colors: {
accent: string;
accentText: string;
tooltipBackground: string;
};
label: string;
};
header: {
colors: {
background: string;
backgroundLogo: string;
backgroundLogoHover: string;
foreground: string;
primary: string;
secondary: string;
};
label: string;
};
icons: {
colors: {
color: string;
dualIconBackground: string;
};
label: string;
};
meta: {
colors: {
background: string;
foreground: string;
};
label: string;
};
mobileNavigation: {
colors: {
background: string;
border: string;
foreground: string;
selectedBackground: string;
selectedForeground: string;
};
label: string;
};
panels: {
colors: {
background: string;
divider: string;
iconBackground: string;
itemIconColorSelected: string;
scrollBar: string;
searchBackground: string;
searchForeground: string;
tabBackgroundSelected: string;
tabForeground: string;
tabForegroundSelected: string;
titleBackground: string;
titleForeground: string;
trayBackground: string;
trayButton: string;
trayButtonSelected: string;
};
label: string;
};
status: {
colors: {
failed: string;
failedForeground: string;
loading: string;
success: string;
};
label: string;
};
surfaces: {
colors: {
depth0Background: string;
depth0Border: string;
depth1Background: string;
depth1Border: string;
depth2Background: string;
depth2Border: string;
depth3Background: string;
depth3Border: string;
selectedBorder: string;
};
label: string;
};
table: {
colors: {
border: string;
columnBackground: string;
columnForeground: string;
even: string;
groupBackground: string;
groupBorder: string;
odd: string;
pills: string;
pillsSpecial: string;
selectedEven: string;
selectedOdd: string;
text: string;
};
label: string;
};
tabs: {
colors: {
selectedAccentSingle: string;
selectedBackground: string;
};
label: string;
};
text: {
colors: {
primary: string;
secondary: string;
};
label: string;
};
tooltips: {
colors: {
background: string;
};
label: string;
};
trees: {
colors: {
labelColor: string;
overflowBackground: string;
selectedBackground: string;
};
label: string;
};
workspace: {
colors: {
background: string;
overlayBackground: string;
overlayBackgroundHover: string;
overlayBorder: string;
overlayBorderHover: string;
overlayDividerColor: string;
overlayDividerHover: string;
};
label: string;
};
workspaceSubMenu: {
colors: {
background: string;
backgroundUnPinned: string;
foreground: string;
};
label: string;
};
}>;
ScrollableDivCss
const ScrollableDivCss: SerializedStyles;
SEARCH_ICON_WIDTH
const SEARCH_ICON_WIDTH: 30 = 30;
SearchableCoreTreeWidget
const SearchableCoreTreeWidget: React.FC<SearchableCoreTreeWidgetProps>;
SearchableCoreTreeWidgetInner
const SearchableCoreTreeWidgetInner: React.FC<SearchableCoreTreeWidgetProps>;
SearchablePanelPlaceholderWidget
const SearchablePanelPlaceholderWidget: React.FC<SearchablePanelPlaceholderWidgetProps>;
SearchablePanelWidget
const SearchablePanelWidget: React.FC<React.PropsWithChildren<SearchablePanelWidgetProps>>;
SearchEngineComboBoxDirectiveWidget
const SearchEngineComboBoxDirectiveWidget: React.FC<SearchEngineComboBoxDirectiveWidgetProps>;
SearchWidget
const SearchWidget: React.FC<SearchWidgetProps>;
Select
const Select: React.FC<SelectProps>;
SetControlWidget
const SetControlWidget: React.FC<SetControlWidgetProps>;
SETTINGS_PANEL_TYPE
const SETTINGS_PANEL_TYPE: "settings" = 'settings';
SimpleComboBoxDirectiveWidget
const SimpleComboBoxDirectiveWidget: React.FC<BaseComboBoxDirectiveWidgetProps>;
SmartDateDisplayWidget
const SmartDateDisplayWidget: React.FC<SmartDateDisplayWidgetProps>;
SmartPositionWidget
const SmartPositionWidget: React.FC<React.PropsWithChildren<SmartPositionWidgetProps>>;
styled
const styled: CreateStyled<ThemeColors<{
button: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
buttonLink: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
buttonPrimary: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
canvas: {
colors: {
background: string;
grid: string;
};
label: string;
};
cards: {
colors: {
foreground: string;
tagBackground: string;
tagLabelBackground: string;
tagLabelForeground: string;
};
label: string;
};
changelog: {
colors: {
codeBackground: string;
codeForeground: string;
};
label: string;
};
combobox: {
colors: {
background: string;
backgroundSelected: string;
border: string;
headerBackground: string;
headerForeground: string;
shadowColor: string;
text: string;
textSelected: string;
};
label: string;
};
dnd: {
colors: {
hintColor: string;
hoverColor: string;
};
label: string;
};
floating: {
colors: {
background: string;
backgroundInactive: string;
border: string;
shadowColor: string;
};
label: string;
};
footer: {
colors: {
background: string;
};
label: string;
};
forms: {
colors: {
checkbox: string;
checkboxChecked: string;
description: string;
groupBorder: string;
groupLabelForeground: string;
inputBackground: string;
inputBorder: string;
inputForeground: string;
toggleHandleColor: string;
toggleOnColor: string;
};
label: string;
};
graphs: {
colors: {
fillStop1: string;
fillStop2: string;
fillStop3: string;
grid: string;
line: string;
thresholdLine: string;
};
label: string;
};
guide: {
colors: {
accent: string;
accentText: string;
tooltipBackground: string;
};
label: string;
};
header: {
colors: {
background: string;
backgroundLogo: string;
backgroundLogoHover: string;
foreground: string;
primary: string;
secondary: string;
};
label: string;
};
icons: {
colors: {
color: string;
dualIconBackground: string;
};
label: string;
};
meta: {
colors: {
background: string;
foreground: string;
};
label: string;
};
mobileNavigation: {
colors: {
background: string;
border: string;
foreground: string;
selectedBackground: string;
selectedForeground: string;
};
label: string;
};
panels: {
colors: {
background: string;
divider: string;
iconBackground: string;
itemIconColorSelected: string;
scrollBar: string;
searchBackground: string;
searchForeground: string;
tabBackgroundSelected: string;
tabForeground: string;
tabForegroundSelected: string;
titleBackground: string;
titleForeground: string;
trayBackground: string;
trayButton: string;
trayButtonSelected: string;
};
label: string;
};
status: {
colors: {
failed: string;
failedForeground: string;
loading: string;
success: string;
};
label: string;
};
surfaces: {
colors: {
depth0Background: string;
depth0Border: string;
depth1Background: string;
depth1Border: string;
depth2Background: string;
depth2Border: string;
depth3Background: string;
depth3Border: string;
selectedBorder: string;
};
label: string;
};
table: {
colors: {
border: string;
columnBackground: string;
columnForeground: string;
even: string;
groupBackground: string;
groupBorder: string;
odd: string;
pills: string;
pillsSpecial: string;
selectedEven: string;
selectedOdd: string;
text: string;
};
label: string;
};
tabs: {
colors: {
selectedAccentSingle: string;
selectedBackground: string;
};
label: string;
};
text: {
colors: {
primary: string;
secondary: string;
};
label: string;
};
tooltips: {
colors: {
background: string;
};
label: string;
};
trees: {
colors: {
labelColor: string;
overflowBackground: string;
selectedBackground: string;
};
label: string;
};
workspace: {
colors: {
background: string;
overlayBackground: string;
overlayBackgroundHover: string;
overlayBorder: string;
overlayBorderHover: string;
overlayDividerColor: string;
overlayDividerHover: string;
};
label: string;
};
workspaceSubMenu: {
colors: {
background: string;
backgroundUnPinned: string;
foreground: string;
};
label: string;
};
}> & {
light: boolean;
}>;
SurfaceWidget
const SurfaceWidget: React.FC<SurfaceWidgetProps>;
Switch
const Switch: React.FC<SwitchWidgetProps>;
SwitchLabelWidget
const SwitchLabelWidget: React.FC<SwitchLabelWidgetProps>;
TAB_BAR_HEIGHT
const TAB_BAR_HEIGHT: 30 = 30;
TableButtonWidget
const TableButtonWidget: React.FC<Btn & {
className?: any;
size?: Size;
}>;
TableWidget
const TableWidget: <T>(props) => Element;
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends TableRow | TableRow |
Parameters
| Parameter | Type |
|---|---|
props | TableWidgetProps<T> |
Returns
Element
TabSelectionWidget
const TabSelectionWidget: React.FC<TabSelectionWidgetProps>;
TabWidget
const TabWidget: React.FC<TabWidgetProps>;
TabWidgetWrapper
const TabWidgetWrapper: React.FC<TabWidgetWrapperProps>;
TextArea
const TextArea: React.FC<TextAreaProps>;
theme
const theme: ThemeFragment<{
button: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
buttonLink: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
buttonPrimary: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
canvas: {
colors: {
background: string;
grid: string;
};
label: string;
};
cards: {
colors: {
foreground: string;
tagBackground: string;
tagLabelBackground: string;
tagLabelForeground: string;
};
label: string;
};
changelog: {
colors: {
codeBackground: string;
codeForeground: string;
};
label: string;
};
combobox: {
colors: {
background: string;
backgroundSelected: string;
border: string;
headerBackground: string;
headerForeground: string;
shadowColor: string;
text: string;
textSelected: string;
};
label: string;
};
dnd: {
colors: {
hintColor: string;
hoverColor: string;
};
label: string;
};
floating: {
colors: {
background: string;
backgroundInactive: string;
border: string;
shadowColor: string;
};
label: string;
};
footer: {
colors: {
background: string;
};
label: string;
};
forms: {
colors: {
checkbox: string;
checkboxChecked: string;
description: string;
groupBorder: string;
groupLabelForeground: string;
inputBackground: string;
inputBorder: string;
inputForeground: string;
toggleHandleColor: string;
toggleOnColor: string;
};
label: string;
};
graphs: {
colors: {
fillStop1: string;
fillStop2: string;
fillStop3: string;
grid: string;
line: string;
thresholdLine: string;
};
label: string;
};
guide: {
colors: {
accent: string;
accentText: string;
tooltipBackground: string;
};
label: string;
};
header: {
colors: {
background: string;
backgroundLogo: string;
backgroundLogoHover: string;
foreground: string;
primary: string;
secondary: string;
};
label: string;
};
icons: {
colors: {
color: string;
dualIconBackground: string;
};
label: string;
};
meta: {
colors: {
background: string;
foreground: string;
};
label: string;
};
mobileNavigation: {
colors: {
background: string;
border: string;
foreground: string;
selectedBackground: string;
selectedForeground: string;
};
label: string;
};
panels: {
colors: {
background: string;
divider: string;
iconBackground: string;
itemIconColorSelected: string;
scrollBar: string;
searchBackground: string;
searchForeground: string;
tabBackgroundSelected: string;
tabForeground: string;
tabForegroundSelected: string;
titleBackground: string;
titleForeground: string;
trayBackground: string;
trayButton: string;
trayButtonSelected: string;
};
label: string;
};
status: {
colors: {
failed: string;
failedForeground: string;
loading: string;
success: string;
};
label: string;
};
surfaces: {
colors: {
depth0Background: string;
depth0Border: string;
depth1Background: string;
depth1Border: string;
depth2Background: string;
depth2Border: string;
depth3Background: string;
depth3Border: string;
selectedBorder: string;
};
label: string;
};
table: {
colors: {
border: string;
columnBackground: string;
columnForeground: string;
even: string;
groupBackground: string;
groupBorder: string;
odd: string;
pills: string;
pillsSpecial: string;
selectedEven: string;
selectedOdd: string;
text: string;
};
label: string;
};
tabs: {
colors: {
selectedAccentSingle: string;
selectedBackground: string;
};
label: string;
};
text: {
colors: {
primary: string;
secondary: string;
};
label: string;
};
tooltips: {
colors: {
background: string;
};
label: string;
};
trees: {
colors: {
labelColor: string;
overflowBackground: string;
selectedBackground: string;
};
label: string;
};
workspace: {
colors: {
background: string;
overlayBackground: string;
overlayBackgroundHover: string;
overlayBorder: string;
overlayBorderHover: string;
overlayDividerColor: string;
overlayDividerHover: string;
};
label: string;
};
workspaceSubMenu: {
colors: {
background: string;
backgroundUnPinned: string;
foreground: string;
};
label: string;
};
}>;
themed
const themed: CreateStyled<ThemeColors<{
button: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
buttonLink: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
buttonPrimary: {
colors: {
background: string;
border: string;
color: string;
colorHover: string;
icon: string;
};
label: string;
};
canvas: {
colors: {
background: string;
grid: string;
};
label: string;
};
cards: {
colors: {
foreground: string;
tagBackground: string;
tagLabelBackground: string;
tagLabelForeground: string;
};
label: string;
};
changelog: {
colors: {
codeBackground: string;
codeForeground: string;
};
label: string;
};
combobox: {
colors: {
background: string;
backgroundSelected: string;
border: string;
headerBackground: string;
headerForeground: string;
shadowColor: string;
text: string;
textSelected: string;
};
label: string;
};
dnd: {
colors: {
hintColor: string;
hoverColor: string;
};
label: string;
};
floating: {
colors: {
background: string;
backgroundInactive: string;
border: string;
shadowColor: string;
};
label: string;
};
footer: {
colors: {
background: string;
};
label: string;
};
forms: {
colors: {
checkbox: string;
checkboxChecked: string;
description: string;
groupBorder: string;
groupLabelForeground: string;
inputBackground: string;
inputBorder: string;
inputForeground: string;
toggleHandleColor: string;
toggleOnColor: string;
};
label: string;
};
graphs: {
colors: {
fillStop1: string;
fillStop2: string;
fillStop3: string;
grid: string;
line: string;
thresholdLine: string;
};
label: string;
};
guide: {
colors: {
accent: string;
accentText: string;
tooltipBackground: string;
};
label: string;
};
header: {
colors: {
background: string;
backgroundLogo: string;
backgroundLogoHover: string;
foreground: string;
primary: string;
secondary: string;
};
label: string;
};
icons: {
colors: {
color: string;
dualIconBackground: string;
};
label: string;
};
meta: {
colors: {
background: string;
foreground: string;
};
label: string;
};
mobileNavigation: {
colors: {
background: string;
border: string;
foreground: string;
selectedBackground: string;
selectedForeground: string;
};
label: string;
};
panels: {
colors: {
background: string;
divider: string;
iconBackground: string;
itemIconColorSelected: string;
scrollBar: string;
searchBackground: string;
searchForeground: string;
tabBackgroundSelected: string;
tabForeground: string;
tabForegroundSelected: string;
titleBackground: string;
titleForeground: string;
trayBackground: string;
trayButton: string;
trayButtonSelected: string;
};
label: string;
};
status: {
colors: {
failed: string;
failedForeground: string;
loading: string;
success: string;
};
label: string;
};
surfaces: {
colors: {
depth0Background: string;
depth0Border: string;
depth1Background: string;
depth1Border: string;
depth2Background: string;
depth2Border: string;
depth3Background: string;
depth3Border: string;
selectedBorder: string;
};
label: string;
};
table: {
colors: {
border: string;
columnBackground: string;
columnForeground: string;
even: string;
groupBackground: string;
groupBorder: string;
odd: string;
pills: string;
pillsSpecial: string;
selectedEven: string;
selectedOdd: string;
text: string;
};
label: string;
};
tabs: {
colors: {
selectedAccentSingle: string;
selectedBackground: string;
};
label: string;
};
text: {
colors: {
primary: string;
secondary: string;
};
label: string;
};
tooltips: {
colors: {
background: string;
};
label: string;
};
trees: {
colors: {
labelColor: string;
overflowBackground: string;
selectedBackground: string;
};
label: string;
};
workspace: {
colors: {
background: string;
overlayBackground: string;
overlayBackgroundHover: string;
overlayBorder: string;
overlayBorderHover: string;
overlayDividerColor: string;
overlayDividerHover: string;
};
label: string;
};
workspaceSubMenu: {
colors: {
background: string;
backgroundUnPinned: string;
foreground: string;
};
label: string;
};
}> & {
light: boolean;
}>;
ToolbarWidget
const ToolbarWidget: React.FC<ToolbarWidgetProps>;
TreeBadgeWidget
const TreeBadgeWidget: React.FC<TreeBadgeWidgetProps>;
TreeContentWidget
const TreeContentWidget: React.FC<React.PropsWithChildren<TreeContentWidgetProps>>;
TreeLeafWidget
const TreeLeafWidget: React.FC<TreeLeafWidgetProps>;
UploadImagePreviewWidget
const UploadImagePreviewWidget: React.FC<UploadImagePreviewWidgetProps>;
Functions
| Function | Description |
|---|---|
| _getScrollableCSS | - |
| activateWithValidation | - |
| createLogger | - |
| DraggableRawWidget | - |
| EntityButtonWidget | - |
| formatLoggerName | - |
| getAnchoredOverlayBounds | - |
| getReactorBorderRadius | - |
| getReactorControlBorderRadius | - |
| getReactorViewportMode | - |
| getScrollableCSS | - |
| isBaseReactorTree | - |
| isSerializedWorkspaceGroup | - |
| isValidationDisabled | - |
| isValidationHidden | - |
| MultiSelectTableWidget | - |
| patch_doGenerateTreeNode | - |
| patch_generateTreeNode | - |
| PatchTree | - |
| resolveButtonTooltip | Resolve button tooltip text after applying validation feedback. |
| resolveReactorLogLevel | - |
| SearchableMultiSelectTableWidget | - |
| serializeChildren | - |
| setupDeleteConfirmation | - |
| setupPrefs | - |
| setupReactorTree | - |
| setupTooltipProps | - |
| showTokenDialog | - |
| size | - |
| StepTooltipWidget | - |
| useAnchoredOverlay | - |
| useAttention | - |
| useButton | - |
| useCopyButton | - |
| useDelay | Manage one delayed callback. Scheduling again replaces the pending callback, and unmounting cancels it. Returned methods are stable across renders. |
| useDimensionObserver | - |
| useDisplayDateOptions | - |
| useDraggableEntity | - |
| useDraggableRaw | - |
| useDroppableBetweenZone | - |
| useDroppableEntity | - |
| useDroppableRaw | - |
| useDroppableZone | - |
| useForceUpdate | - |
| usePanZoom | Maintain bounded pan/zoom state for centered content, composing size observation and gesture handling. Apply transform to content with a centered transform origin inside a viewport using touch-action: none and overflow: hidden. |
| usePanZoomGestures | Emit drag, wheel and pinch gestures in coordinates relative to the viewport center. The target should use touch-action: none. Listeners and pointer capture are released when disabled or unmounted. |
| useReactorSize | - |
| useReactorViewportMode | - |
| useSizeObserver | Observe an element's size, with an initial measurement and automatic cleanup. Use client dimensions for available content space, or bounds for rendered size. |
| useSubmit | - |
| useSurfaceBorderColor | - |
| useSurfaceDepth | - |
| useTheme | Reads a specific Reactor theme fragment and refreshes when the selected theme changes. The fragment argument keeps the result type-safe for module supplied theme fragments. |
| useTreeChildren | - |
| useValidator | - |
| - |
References
default
Renames and re-exports ReactorModule