@firecms/core API
@firecms/core
@firecms/core
Section titled “@firecms/core”Classes
Section titled “Classes”Interfaces
Section titled “Interfaces”- ArrayContainerProps
- AsyncPreviewComponentProps
- DataSourceDelegate
- DownloadMetadata
- EnumValuesChipProps
- ImageCompression
- NavigateOptions
- NavigationEntry
- NavigationGroupMapping
- PluginFormActionProps
- PluginGenericProps
- PluginHomePageAdditionalCardsProps
- PropertiesToColumnsParams
- PropertyTableCellProps
- SearchIconsProps
- SkeletonPropertyComponentProps
- StorageListResult
- StorageReference
- UseClipboardProps
- useClipboardReturnType
- UserConfigurationPersistence
- UseTableSearchHelperParams
Type Aliases
Section titled “Type Aliases”- AdditionalFieldDelegateProps
- AnalyticsController
- ArrayEntryBuilder
- ArrayEntryParams
- ArrayValuesCount
- BuildNavigationContextProps
- CellRendererParams
- CMSAnalyticsEvent
- CustomizationController
- DataSourceTableControllerProps
- DefaultAppBarProps
- EntityAction
- EntityActionClickProps
- EntityCollectionTableController
- EntityCollectionViewActionsProps
- EntityFormProps
- EntityOverrides
- EntityPreviewContainerProps
- EntityPreviewProps
- EntityTableController
- FetchCollectionDelegateProps
- FilterCombinationValidProps
- IconViewProps
- InferCollectionType
- InternalUserManagement
- ListenCollectionDelegateProps
- ModifyCollectionProps
- NavigationBlocker
- NavigationCardProps
- NavigationResult
- OnRowClickParams
- PluginFieldBuilderParams
- PropertyConfig
- PropertyConfigId
- ReferencePreviewProps
- ReferenceWidgetProps
- Role
- SaveEntityDelegateProps
- SelectableTableProps
- SelectedCellProps
- SideDialogController
- SmallNavigationCardProps
Variables
Section titled “Variables”- ADMIN_GROUP_NAME
- AppContext
- AuthControllerContext
- COLLECTION_GROUP_PARENT_ID
- COLLECTION_PATH_SEPARATOR
- copyEntityAction
- DEFAULT_FIELD_CONFIGS
- DEFAULT_GROUP_NAME
- defaultDateFormat
- deleteEntityAction
- DRAWER_WIDTH
- editEntityAction
- EntityPreviewContainer
- IconForView
- iconsSearch
- iconSynonyms
- ModeControllerContext
- ModeControllerProvider
- NAVIGATION_ADMIN_GROUP_NAME
- NAVIGATION_DEFAULT_GROUP_NAME
- NavigationCard
- pick
- PropertyTableCell
- SelectableTableContext
- SnackbarProvider
Functions
Section titled “Functions”- addInitialSlash
- AppBar
- applyPermissionsFunctionIfEmpty
- ArrayContainer
- ArrayContainerItem
- ArrayItemOptions
- buildEnumLabel
- buildIdColumn
- canCreateEntity
- canDeleteEntity
- canEditEntity
- ConfirmationDialog
- DefaultAppBar
- DefaultHomePage
- Drawer
- DrawerLogo
- DrawerNavigationItem
- EntityCollectionViewActions
- EntityForm
- EntityPreview
- EntityView
- enumToObjectEntries
- FieldCaption
- FieldHelperText
- FireCMSLogo
- FireCMSRouter
- flattenObject
- FormEntry
- FormLayout
- fullPathToCollectionSegments
- getArrayResolvedProperties
- getArrayValuesCount
- getBracketNotation
- getCollectionByPathOrId
- getCollectionPathsCombinations
- getColorForProperty
- getColorScheme
- getColumnKeysForProperty
- getDefaultFieldConfig
- getDefaultFieldId
- getDefaultPropertiesOrder
- getDefaultValueFor
- getDefaultValueForDataType
- getDefaultValuesFor
- getEntityImagePreviewPropertyKey
- getEntityPreviewKeys
- getEntityTitlePropertyKey
- getFieldConfig
- getFieldId
- getFormFieldKeys
- getHashValue
- getIcon
- getIconForProperty
- getIconForWidget
- getIdIcon
- getLabelOrConfigFrom
- getLastSegment
- getLocalChangesBackup
- getPropertiesWithPropertiesOrder
- getPropertyInPath
- getRandomId
- getReferenceFrom
- getResolvedPropertyInPath
- getValueInPath
- hydrateRegExp
- isDefaultFieldConfigId
- isEmptyObject
- isEnumValueDisabled
- isHidden
- isObject
- isPropertyBuilder
- isReadOnly
- isReferenceProperty
- isValidRegExp
- joinCollectionLists
- KeyValuePreview
- makePropertiesEditable
- makePropertiesNonEditable
- MarkdownEditorFieldBinding
- mergeCallbacks
- mergeCollection
- mergeDeep
- mergeEntityActions
- navigateToEntity
- NavigationGroup
- NotFoundPage
- plural
- printChanged
- propertiesToColumns
- PropertyConfigBadge
- PropertyIdCopyTooltip
- PropertyIdCopyTooltipContent
- randomColor
- randomString
- ReferenceWidget
- removeFunctions
- removeInitialAndTrailingSlashes
- removeInitialSlash
- removeInPath
- removeNulls
- removePropsIfExisting
- removeTrailingSlash
- removeUndefined
- renderSkeletonCaptionText
- renderSkeletonIcon
- renderSkeletonImageThumbnail
- renderSkeletonText
- resolveArrayProperty
- resolveCollection
- resolveCollectionPathIds
- resolveDefaultSelectedView
- resolvedSelectedEntityView
- resolveEntityAction
- resolveEntityView
- resolveEnumValues
- resolvePermissions
- resolveProperties
- resolveProperty
- resolvePropertyEnum
- resolveStorageFilenameString
- resolveStoragePathString
- SearchIconsView
- segmentsToStrippedPath
- serializeRegExp
- singular
- slugify
- SmallNavigationCard
- sortProperties
- StorageThumbnailInternal
- StorageUploadFieldBinding
- stripCollectionPath
- toKebabCase
- toSnakeCase
- traverseValueProperty
- traverseValuesProperties
- unslugify
- useApp
- useBrowserTitleAndIcon
- useBuildLocalConfigurationPersistence
- useBuildModeController
- useBuildNavigationController
- useClipboard
- useCollapsedGroups
- useColumnIds
- useDataSourceTableController
- useDebouncedCallback
- useDebouncedData
- useLargeLayout
- useSelectableTableController
- useSelectionController
- useSideDialogContext
- useTableSearchHelper
- useTraceUpdate
- useValidateAuthenticator
- yupToFormErrors
Builder
Section titled “Builder”- buildAdditionalFieldDelegate
- buildCollection
- buildEntityCallbacks
- buildEnumValueConfig
- buildEnumValues
- buildFieldConfig
- buildProperties
- buildPropertiesOrBuilder
- buildProperty
Collection components
Section titled “Collection components”- OnCellValueChangeParams
- EntityCollectionTableProps
- OnCellValueChange
- OnColumnResizeParams
- OnVirtualTableColumnResizeParams
- UniqueFieldValidator
- EntityCollectionRowActions
Components
Section titled “Components”- EntityViewProps
- ErrorViewProps
- ReferenceSelectionInnerProps
- VirtualTableColumn
- VirtualTableProps
- EntityCollectionViewProps
- NavigationRoutesProps
- VirtualTableFilterValues
- VirtualTableSort
- EntityCollectionView
- NavigationRoutes
- VirtualTable
- EntityCollectionTable
- ErrorView
- NavigationCardBinding
- ReferenceSelectionTable
- SelectableTable
- SideDialogs
Datasource
Section titled “Datasource”- DataSource
- DeleteEntityProps
- FetchCollectionProps
- FetchEntityProps
- SaveEntityProps
- ListenCollectionProps
- ListenEntityProps
- sanitizeData
- updateDateAutoValues
Entity properties
Section titled “Entity properties”- ArrayProperty
- ArrayPropertyValidationSchema
- BaseProperty
- BooleanProperty
- DateProperty
- DatePropertyValidationSchema
- GeopointProperty
- MapProperty
- NumberProperty
- NumberPropertyValidationSchema
- PropertyDisabledConfig
- PropertyValidationSchema
- ReferenceProperty
- StringProperty
- StringPropertyValidationSchema
- UploadedFileContext
- CMSType
- DataType
- EnumType
- EnumValueConfig
- EnumValues
- FileType
- PreviewType
- Properties
- PropertiesOrBuilders
- Property
- PropertyBuilder
- PropertyBuilderProps
- PropertyOrBuilder
- ResolvedArrayProperty
- ResolvedBooleanProperty
- ResolvedGeopointProperty
- ResolvedMapProperty
- ResolvedNumberProperty
- ResolvedProperties
- ResolvedProperty
- ResolvedReferenceProperty
- ResolvedStringProperty
- ResolvedTimestampProperty
- StorageConfig
Form custom fields
Section titled “Form custom fields”- FieldProps
- FormContext
- PropertyFieldBindingProps
- LabelWithIcon
- PropertyFieldBinding
- LabelWithIconAndTooltip
Form fields
Section titled “Form fields”- ArrayCustomShapedFieldBinding
- ArrayOfReferencesFieldBinding
- BlockFieldBinding
- DateTimeFieldBinding
- KeyValueFieldBinding
- MapFieldBinding
- MultiSelectFieldBinding
- ReadOnlyFieldBinding
- ReferenceAsStringFieldBinding
- ReferenceFieldBinding
- RepeatFieldBinding
- SelectFieldBinding
- SwitchFieldBinding
- TextFieldBinding
Hooks and utilities
Section titled “Hooks and utilities”- CollectionFetchProps
- CollectionFetchResult
- EntityFetchProps
- EntityFetchResult
- EntitySidePanelProps
- ModeController
- NavigationFrom
- NavigationFromProps
- ResolvedNavigationCollection
- ResolvedNavigationEntity
- SideDialogPanelProps
- SideDialogsController
- SideEntityController
- SnackbarController
- AuthController
- Authenticator
- DeleteEntityWithCallbacksProps
- FireCMSContext
- ResolvedNavigationEntry
- SaveEntityWithCallbacksProps
- SnackbarMessageType
- deleteEntityWithCallbacks
- resolveNavigationFrom
- saveEntityWithCallbacks
- useAuthController
- useCollectionFetch
- useCustomizationController
- useDataSource
- useDialogsController
- useEntityFetch
- useFireCMSContext
- useInternalUserManagementController
- useModeController
- useNavigationController
- useReferenceDialog
- useResolvedNavigationFrom
- useSideDialogsController
- useSideEntityController
- useSnackbarController
- useStorageSource
Models
Section titled “Models”- AdditionalFieldDelegate
- CMSView
- CollectionActionsProps
- DownloadConfig
- Entity
- EntityCollection
- EntityCustomViewParams
- EntityIdUpdateProps
- EntityOnDeleteProps
- EntityOnFetchProps
- EntityOnSaveProps
- ExportConfig
- ExportMappingFunction
- Permissions
- PermissionsBuilderProps
- PluginHomePageActionsProps
- StorageSource
- UploadFileProps
- UploadFileResult
- CMSViewsBuilder
- CollectionSize
- DefaultSelectedViewBuilder
- DefaultSelectedViewParams
- EntityCallbacks
- EntityCollectionsBuilder
- EntityCustomView
- EntityLinkBuilder
- EntityOnPreSaveProps
- EntityOnSaveFailureProps
- EntityStatus
- EntityValues
- FilterCombination
- FilterValues
- FireCMSProps
- Locale
- NavigationController
- PartialEntityCollection
- PermissionsBuilder
- ResolvedEntityCollection
- SelectionController
- User
- VirtualTableWhereFilterOp
- WhereFilterOp
Preview components
Section titled “Preview components”- ImagePreviewProps
- PropertyPreviewProps
- PreviewSize
- AsyncPreviewComponent
- PropertyPreview
- StorageThumbnail
- ArrayEnumPreview
- ArrayOfMapsPreview
- ArrayOfReferencesPreview
- ArrayOfStorageComponentsPreview
- ArrayOfStringsPreview
- ArrayOneOfPreview
- ArrayPropertyEnumPreview
- ArrayPropertyPreview
- BooleanPreview
- DatePreview
- EmptyValue
- EnumValuesChip
- ImagePreview
- MapPropertyPreview
- NumberPropertyPreview
- ReferencePreview
- SkeletonPropertyComponent
- StringPropertyPreview
- UrlComponentPreview
- UserPreview
