@serenity-is/corelib
Serenity Core Library (@serenity-is/corelib)
This is the package containing core TypeScript classes and functions used in Serenity applications.
This should be installed by default in your projects created from Serene or StartSharp template:
{
"dependencies": {
// ...
"@serenity-is/corelib": "./node_modules/.dotnet/serenity.corelib"
}
}
If you have "./node_modules/.dotnet/serenity.corelib" in the version value, it means you are using this library directly via the Serenity.Corelib NuGet package reference in your project file instead of NPM. This is recommended to avoid version inconsistencies.
If you have a version number for this package in package.json, it should be equal or as close as possible to Serenity NuGet package versions in your project file.
Namespaces
- AggregateFormatting
- Aggregators
- AggregatorTypeRegistry
- Attributes
- Authorization
- Criteria
- Decorators
- DialogExtensions
- DialogTexts
- EditorUtils
- ErrorHandling
- FilterOperators
- Fluent
- GridSelectAllButtonHelper
- GridUtils
- JSX
- LayoutTimer
- LazyLoadHelper
LT- PropertyItemColumnConverter
- ReflectionOptionsSetter
- ScriptData
- SlickFormatting
- SlickHelper
- SlickTreeHelper
- SubDialogHelper
- TabsExtensions
- UploadHelper
- ValidationHelper
Enumerations
- CaptureOperationType
- ColumnSelection
- CriteriaOperator
- PropertyGridMode
- RetrieveColumnSelection
- SummaryType
- TypeMemberKind
Classes
- AdvancedFilteringAttribute
- AutoNumeric
- BaseDialog
- BaseEditorFiltering
- BaseFiltering
- BasePanel
- BooleanEditor
- BooleanFiltering
- BooleanFormatter
- CascadedWidgetLink
- CheckboxFormatter
- CheckLookupEditor
- CheckTreeEditor
- ClassicRouter
- CloseButtonAttribute
- ColumnPickerDialog
- ColumnsBase
- Combobox
- ComboboxEditor
- Component
- CriteriaBuilder
- CustomAttribute
- DataGrid
- DateEditor
- DateFiltering
- DateFormatter
- DateTimeEditor
- DateTimeFiltering
- DateTimeFormatter
- DateYearEditor
- DecimalEditor
- DecimalFiltering
- Dialog
- EditorAttribute
- EditorFiltering
- EditorWidget
- ElementAttribute
- EmailAddressEditor
- EmailEditor
- EntityDialog
- EntityGrid
- EntityLocalizer
- EnumEditor
- EnumFiltering
- EnumFormatter
- EnumKeyAttribute
- FileDownloadFormatter
- FileUploadEditor
- FilterDialog
- FilterDisplayBar
- FilterFieldSelect
- FilterOperatorSelect
- FilterPanel
- FilterStore
- FilterWidgetBase
- FormatterBase
- GridRadioSelectionMixin
- GridRowSelectionMixin
- HtmlContentEditor
- HtmlNoteContentEditor
- HtmlReportContentEditor
- IBooleanValue
- IDialog
- IDoubleValue
- IEditDialog
- IFiltering
- IGetEditValue
- IInitializeColumn
- ImageUploadEditor
- IntegerEditor
- IntegerFiltering
- IQuickFiltering
- IReadOnly
- ISetEditValue
- ISlickFormatter
- IStringValue
- IValidateRequired
- Lookup
- LookupEditor
- LookupEditorBase
- LookupFiltering
- MaskedEditor
- MaximizableAttribute
- MinuteFormatter
- MultipleFileUploadEditor
- MultipleImageUploadEditor
- NumberFormatter
- OptionAttribute
- PanelAttribute
- PasswordEditor
- PrefixedContext
- PropertyDialog
- PropertyGrid
- PropertyPanel
- QuickFilterBar
- QuickSearchInput
- RadioButtonEditor
- Recaptcha
- RemoteView
- ResizableAttribute
- Select2
- SelectEditor
- ServiceLookupEditor
- ServiceLookupEditorBase
- ServiceLookupFiltering
- SlickPager
- StaticPanelAttribute
- StringEditor
- StringFiltering
- TextAreaEditor
- TimeEditor
- TimeEditorBase
- TimeSpanEditor
- Toastr
- Toolbar
- Tooltip
- TreeGridMixin
- UIDialogMaximizer
- Uploader
- URLEditor
- UrlFormatter
- Validator
- Widget
Interfaces
- ArgsGroupToggle
- ArgsPagingInfo
- ArgsRecalcRows
- ArgsRemoteView
- ArgsRowCountChanged
- ArgsRowsChanged
- ArgsRowsOrCountChanged
- AutoNumericOptions
- AutoRegisterArgs
- BasicClassList
- CheckLookupEditorOptions
- CheckTreeItem
- CKEditorConfig
- ColumnPickerDialogOptions
- ComboboxCommonOptions
- ComboboxEditorOptions
- ComboboxFilterOptions
- ComboboxInplaceAddOptions
- ComboboxItem
- ComboboxOptions
- ComboboxSearchQuery
- ComboboxSearchResult
- ComponentClass
- Computed
- ConfirmDialogOptions
- CreateWidgetParams
- CustomDomAttributes
- DataChangeInfo
- DataGridEvent
- DataGridFilteringEvent
- DataGridPersistenceEvent
- DataGridProcessEvent
- DataGridSubmitEvent
- DateEditorOptions
- DateFormat
- DateTimeEditorOptions
- DateYearEditorOptions
- DebouncedFunction
- DecimalEditorOptions
- DeleteRequest
- DeleteResponse
- DialogButton
- DialogOptions
- EffectOptions
- ElementAttributes
- EmailEditorOptions
- EntityLocalizerOptions
- EnumEditorOptions
- FileUploadConstraints
- FileUploadEditorOptions
- FilterFieldSelectOptions
- FilterLine
- FilterOperator
- Fluent
- Formatter
- GridPersistenceFlags
- GridRadioSelectionMixinOptions
- GridRowSelectionMixinOptions
- GroupInfo
- HandleRouteEvent
- HtmlContentEditorOptions
- HTMLElementTags
- IAggregator
- IAggregatorConstructor
- IClassicRouter
- IDataGrid
- IFrameDialogOptions
- ImageUploadEditorOptions
- InitGlobalMappingsOptions
- IntegerEditorOptions
- IRemoteView
- IRowDefinition
- ListRequest
- ListResponse
- Locale
- LookupEditorOptions
- LookupOptions
- MaskedEditorOptions
- MathMLElementTags
- MessageDialogOptions
- MultipleFileUploadEditorOptions
- NumberFormat
- PagerOptions
- PagingInfo
- PagingOptions
- PersistedGridColumn
- PersistedGridSettings
- PostToServiceOptions
- PostToUrlOptions
- PropBinding
- PropertyGridOptions
- PropertyItem
- PropertyItemsData
- PropHook
- QuickFilter
- QuickFilterArgs
- QuickFilterBarOptions
- QuickFilterItemData
- QuickSearchArgs
- QuickSearchField
- QuickSearchInputOptions
- RadioButtonEditorOptions
- RecaptchaOptions
- RemoteViewOptions
- RequestErrorInfo
- RetrieveRequest
- RetrieveResponse
- SaveRequest
- SaveResponse
- Select2AjaxOptions
- Select2Item
- Select2Options
- Select2QueryOptions
- Select2Result
- SelectEditorOptions
- ServiceError
- ServiceLookupEditorOptions
- ServiceOptions
- ServiceRequest
- ServiceResponse
- SettingStorage
- Signal
- SignalLike
- SignalOptions
- SummaryOptions
- SVGElementTags
- TextAreaEditorOptions
- TimeEditorBaseOptions
- TimeEditorOptions
- TimeSpanEditorOptions
- TiptapModule
- TiptapToolbarHiddenOption
- ToolbarOptions
- ToolButton
- ToolButtonProps
- TooltipOptions
- TransformInclude
- TreeGridMixinOptions
- TypeMember
- UIDialogMaximizerProps
- UndeleteRequest
- UndeleteResponse
- UploadedFile
- UploaderBatch
- UploaderErrorData
- UploaderOptions
- UploaderRequest
- UploaderSuccessData
- UploadInputOptions
- UploadResponse
- UserDefinition
- ValidatableElement
- ValidationErrorItem
- ValidationErrorMap
- ValidationRulesMap
- ValidatorOptions
Type Aliases
- AnyIconClass
- AttributeSpecifier
- AutoRegisterHandler
- CancellableViewCallback
- ClassName
- ClassNames
- ClassTypeInfo
- ColumnPickerChangeArgs
- ComboboxFormatResult
- ComboboxType
- ComponentChild
- ComponentChildren
- ComponentType
- Constructor
- DataGridChangeEvent
- DataGridInitEvent
- DialogProviderType
- DialogType
Dictionary- EditorAddon
- EditorProps
- EditorType
- EditorTypeInfo
- EffectDisposer
- ExcludeMethods
- fabIconKey
- faIconKey
- Format
- FormatterType
- FormatterTypeInfo
- FunctionComponent
- GroupByElement
- GroupByResult
- Grouping
- HtmlContentEditorProvider
- IconClassName
- IdPrefixType
- InterfaceType
- InterfaceTypeInfo
- JSXElement
- KnownIconClass
- LanguageList
- NotifyMap
- PropertyFieldElement
- PropValue
- Ref
- RefCallback
- RefObject
- RemoteViewAjaxCallback
- RemoteViewFilter
- RemoteViewProcessCallback
- RemoveIndex
- RenderableContent
- SaveInitiator
- Select2Element
- Select2FormatResult
- ShadowRootContainer
- SignalOrValue
- SNoInfer
- StringLiteral
- StyleAttributes
- StyleProperties
- StylePropertiesBase
- TextColor
- ToastContainerOptions
- ToastrOptions
- TranslateTextsOptions
- TranslateTextsResult
- Type
- TypeInfo
- UIFieldItem
- UIFieldSet
- UtilityColor
- ValidateEventDelegate
- ValidationErrorList
- ValidationProvider
- ValidationRules
- ValidationValue
- WidgetProps
Variables
- addValidationRule
alertattrEncode- batch
- CheckTreeEditorTexts
- ColumnPickerDialogTexts
- computed
- Config
confirm- Culture
- DataGridTexts
- DataValidationTexts
- DateTimeEditorTexts
- defaultNotifyOptions
- DialogTypeRegistry
- EditorTypeRegistry
- effect
- EntityDialogTexts
- EntityGridTexts
- Enum
- EnumTypeRegistry
- FileUploadTexts
- FilterableAttribute
- FilteringTypeRegistry
- FilterPanelTexts
format- FormatterTypeRegistry
- FormValidationTexts
- getColumnsDataAsync
- getFormDataAsync
getTypeRegistry- HtmlContentEditorTexts
- ImageCheckResultTexts
information- initPropHookSymbol
- Invariant
- isAddRowSymbol
isArraylocaleFormat- MathMLNamespace
- nsSerenity
- omitAllGridPersistenceFlags
- PagerTexts
- PropertyGridTexts
- QuickSearchTexts
- removeValidationRule
- Router
- scriptDataHooks
- SelectEditorTexts
- SerenityNS
- signal
- skipEditLinkFormatPurposes
success- SVGNamespace
TemplatedDialogTemplatedPanelTemplatedWidgettext- TranslationConfig
turkishLocaleCompare- untracked
warning
Functions
- addClass
- addCustomAttribute
- addDisposingListener
- addEmptyOption
- addLocalText
- addOption
- addTypeMember
- alertDialog
any- appendToNode
- applyChangesToolButton
- associateWidget
- bgColor
- bindThis
- blockUI
- blockUndo
- cancelDialogButton
- canLoadScriptData
- cast
centerDialog- className
- classTypeInfo
- clearKeys
- clearOptions
- cloneToolButton
coalesce- confirmDialog
count- createElement
- createRef
- Criteria
- cssEscape
- currentLifecycleRoot
- currentNamespaceURI
- deassociateWidget
- debounce
- deepClone
- deleteToolButton
- derivedSignal
- dispatchDisposingEvent
- EditLink
- editorTypeInfo
- editToolButton
endsWith- ensureScriptDataSync
- ensureTypeInfo
- executeEverytimeWhenVisible
- executeOnceWhenVisible
extend- fabIcon
- faIcon
- fetchScriptData
- fieldsProxy
- findElementWithRelativeId
first- Fluent
- formatDate
- formatDayHourAndMin
- formatISODateTimeUTC
- formatNumber
- formatterTypeInfo
- Fragment
- getActiveRequests
- getBaseType
- getColumns
- getColumnsAsync
- getColumnsData
- getColumnsScript
- getCookie
- getCustomAttribute
- getCustomAttributes
- getElementReadOnly
- getForm
- getFormAsync
- getFormData
- getFormScript
- getGlobalObject
- getGlobalTypeRegistry
- getInstanceType
- getjQuery
- getLookup
- getLookupAsync
- getNested
- getRemoteData
- getRemoteDataAsync
- getReturnUrl
- getScriptData
- getScriptDataHash
- getServiceOptions
- getType
- getTypeFullName
- getTypeMembers
- getTypeNameProp
- getTypes
- getTypeShortName
- getWidgetFrom
- getWidgetName
- gridPageInit
GridPageInit- groupBy
- handleScriptDataError
- hasBSModal
- hasCustomAttribute
- hasUIDialog
- htmlEncode
- iconClassName
- iframeDialog
indexOf- informationDialog
- inHTMLNamespace
- initFlatpickrLocale
- initFormType
- initFullHeightGridPage
- initGlobalMappings
- initNProgress
- inMathMLNamespace
- inNamespaceURI
insert- inSVGNamespace
- interfaceTypeInfo
- invokeDisposingListeners
- isArrayLike
- isAssignableFrom
- isBS3
- isBS5Plus
isEmptyOrNull- isEnum
- isInstanceOfType
- isMobileView
- isPromiseLike
- isSafeReturnUrl
- isSameOrigin
- isSignalLike
isTrimmedEmptyisValue- jQueryPatch
- jsx
- keyOf
- layoutFillHeight
- layoutFillHeightValue
- localizationToolButton
- localText
- newBodyDiv
- noDialogButton
- notifyError
- notifyInfo
- notifySuccess
- notifyWarning
- observeSignal
- okDialogButton
- omitUndefined
- outerHtml
padLeft- panelPageInit
PanelPageInit- parseCriteria
- parseDate
- parseDayHourAndMin
- parseDecimal
- parseHourAndMin
- parseInteger
- parseISODateTime
- parseQueryString
- peekScriptData
- peekTypeInfo
- positionToastContainer
- postToService
- postToUrl
- PropertyCategories
- PropertyCategory
- PropertyCategoryTitle
- PropertyField
- PropertyFieldCaption
- PropertyFieldEditor
- PropertyFieldLineBreak
- PropertyTabItem
- PropertyTabList
- PropertyTabPane
- PropertyTabPanes
- PropertyTabs
- proxyTexts
- registerClass
- registerEditor
- registerEnum
- registerFormatter
- registerInterface
- registerType
- reloadLookup
- reloadLookupAsync
- removeClass
- removeDisposingListener
replaceAll- requestFinished
- requestStarting
- resetApplicationPath
- resetCspNonce
- resetCultureSettings
- resolveServiceUrl
- resolveUrl
- round
- safeCast
- sanitizeHtml
- sanitizeUrl
- saveAndCloseToolButton
- serviceCall
- serviceRequest
- setElementReadOnly
setEquality- setRef
- setRegisteredScripts
- setScriptData
- setTypeNameProp
- ShadowRootNode
single- splitDateString
startsWith- stringFormat
- stringFormatLocale
- stripDiacritics
- successDialog
- textColor
- today
- toggleClass
- toGrouping
- toId
- ToolbarButton
- toSingleLine
- triggerLayoutOnShow
trimtrimEndtrimStart- trimToEmpty
- trimToNull
- trunc
tryFirst- tryGetText
- tryGetWidget
turkishLocaleToLowerturkishLocaleToUpper- uiAndBSButtonNoConflict
- undeleteToolButton
- useClassList
- useIdPrefix
- useImperativeHandle
- usePropBinding
- useSignal
- useText
- useUpdatableComputed
- validateOptions
- validatorAbortHandler
- warningDialog
- yesDialogButton
- zeroPad
References
h
Renames and re-exports createElement
jsxs
Renames and re-exports jsx
useRef
Renames and re-exports createRef