@serenity-is/corelib / EntityLocalizerOptions
Interface: EntityLocalizerOptions
Defined in: src/ui/dialogs/entitylocalizer.tsx:7
Options for the EntityLocalizer.
Properties
byId()
byId: (
id) =>Fluent
Defined in: src/ui/dialogs/entitylocalizer.tsx:9
Resolves an element by id within the dialog.
Parameters
id
string
Returns
getButton()
getButton: () =>
Fluent
Defined in: src/ui/dialogs/entitylocalizer.tsx:22
Returns the localization toggle button.
Returns
getEntity()
getEntity: () =>
any
Defined in: src/ui/dialogs/entitylocalizer.tsx:24
Returns the current entity.
Returns
any
getLanguages()
getLanguages: () =>
LanguageList
Defined in: src/ui/dialogs/entitylocalizer.tsx:26
Returns the list of available languages.
Returns
getPropertyGrid()
getPropertyGrid: () =>
Fluent
Defined in: src/ui/dialogs/entitylocalizer.tsx:28
Returns the property grid element.
Returns
getToolButtons()
getToolButtons: () =>
HTMLElement[]
Defined in: src/ui/dialogs/entitylocalizer.tsx:30
Returns the toolbar button elements.
Returns
HTMLElement[]
idPrefix
idPrefix:
string
Defined in: src/ui/dialogs/entitylocalizer.tsx:11
Id prefix used for generated elements.
isNew()
isNew: () =>
boolean
Defined in: src/ui/dialogs/entitylocalizer.tsx:13
Whether the entity is new (no id).
Returns
boolean
mapSourceItem()?
optionalmapSourceItem: (item) =>PropertyItem
Defined in: src/ui/dialogs/entitylocalizer.tsx:20
Maps a source property item to the item used in the localization grid. The default
returns the item as is. Return an item with localizable: false to skip it, or a copy
with modified permissions / insertable / updatable flags to customize editability
(e.g. require a translation specific permission).
Parameters
item
Returns
pgOptions
pgOptions:
PropertyGridOptions
Defined in: src/ui/dialogs/entitylocalizer.tsx:32
Options for the localization property grid.
retrieveLocalizations()
retrieveLocalizations: () =>
PromiseLike<{[languageId:string]:any; }>
Defined in: src/ui/dialogs/entitylocalizer.tsx:34
Retrieves existing localizations for the entity.
Returns
PromiseLike<{[languageId: string]: any; }>
validateForm()
validateForm: () =>
boolean
Defined in: src/ui/dialogs/entitylocalizer.tsx:36
Validates the main form before switching modes.
Returns
boolean