API
Classes​
Core Interfaces​
Entity properties Interfaces​
- ArrayProperty
- ArrayPropertyValidationSchema
- BaseProperty
- BooleanProperty
- DateProperty
- DatePropertyValidationSchema
- EnumValueConfig
- GeopointProperty
- MapProperty
- NumberProperty
- NumberPropertyValidationSchema
- PropertyDisabledConfig
- PropertyValidationSchema
- ReferenceProperty
- StorageConfig
- StringProperty
- StringPropertyValidationSchema
- UploadedFileContext
Form custom fields Interfaces​
Preview components Interfaces​
Collection components Interfaces​
Hooks and utilities Interfaces​
- AuthController
- BreadcrumbEntry
- BreadcrumbsController
- CollectionFetchProps
- CollectionFetchResult
- EntityFetchProps
- EntityFetchResult
- EntitySidePanelProps
- FireCMSContext
- ModeState
- NavigationFrom
- NavigationFromProps
- ResolvedNavigationCollection
- ResolvedNavigationEntity
- SideDialogPanelProps
- SideDialogsController
- SideEntityController
- SnackbarController
Components Interfaces​
Datasource Interfaces​
Firebase Interfaces​
- FirebaseCMSAppProps
- FirebaseLoginViewProps
- FirebaseStorageSourceProps
- FirestoreDataSourceProps
- InitialiseFirebaseResult
Models Interfaces​
- AdditionalColumnDelegate
- CMSView
- Entity
- EntityCallbacks
- EntityCollection
- EntityCustomViewParams
- EntityOnDeleteProps
- EntityOnSaveProps
- ExportConfig
- ExportMappingFunction
- ExtraActionsParams
- Permissions
- PermissionsBuilderProps
Other Interfaces​
- AsyncPreviewComponentProps
- BreadcrumbUpdaterProps
- ColorChipProps
- DownloadMetadata
- EnumValuesChipProps
- MarkdownProps
- SkeletonComponentProps
- TopNavigationEntry
- UseClipboardProps
- UserConfigurationPersistence
- useClipboardReturnType
Storage Interfaces​
Core Type aliases​
Entity properties Type aliases​
- CMSType
- DataType
- EnumType
- EnumValues
- FileType
- Properties
- PropertiesOrBuilders
- Property
- PropertyBuilder
- PropertyBuilderProps
- PropertyOrBuilder
- ResolvedArrayProperty
- ResolvedBooleanProperty
- ResolvedGeopointProperty
- ResolvedMapProperty
- ResolvedNumberProperty
- ResolvedProperties
- ResolvedProperty
- ResolvedReferenceProperty
- ResolvedStringProperty
- ResolvedTimestampProperty
Preview components Type aliases​
Collection components Type aliases​
Hooks and utilities Type aliases​
- AuthDelegate
- DeleteEntityWithCallbacksProps
- ResolvedNavigationEntry
- SaveEntityWithCallbacksProps
- SnackbarMessageType
Components Type aliases​
- EntityCollectionViewProps
- NavigationRoutesProps
- TableColumnFilter
- TableEnumValues
- TableFilterValues
- TableSize
- TableSort
Datasource Type aliases​
Firebase Type aliases​
Models Type aliases​
- Authenticator
- ChipColor
- CollectionOverrideHandler
- CollectionSize
- EntityCustomView
- EntityLinkBuilder
- EntityStatus
- EntityValues
- FilterCombination
- FilterValues
- LocalEntityCollection
- Locale
- NavigationContext
- PermissionsBuilder
- ResolvedEntityCollection
- SelectionController
- TableWhereFilterOp
- User
- WhereFilterOp
Other Type aliases​
Core Variables​
Form fields Variables​
Form custom fields Variables​
Preview components Variables​
Components Variables​
Other Variables​
Core Functions​
Form fields Functions​
- ArrayEnumSelectBinding
- ArrayOfReferencesFieldBinding
- BlockFieldBinding
- DateTimeFieldBinding
- MapFieldBinding
- MarkdownFieldBinding
- ReadOnlyFieldBinding
- ReferenceFieldBinding
- RepeatFieldBinding
- SelectFieldBinding
- StorageUploadFieldBinding
- TextFieldBinding
Builder Functions​
- buildAdditionalColumnDelegate
- buildCollection
- buildEntityCallbacks
- buildEnumValueConfig
- buildEnumValues
- buildProperties
- buildPropertiesOrBuilder
- buildProperty
Form custom fields Functions​
Preview components Functions​
- ArrayEnumPreview
- ArrayOfMapsPreview
- ArrayOfReferencesPreview
- ArrayOfStorageComponentsPreview
- ArrayOfStringsPreview
- ArrayOneOfPreview
- ArrayPropertyEnumPreview
- ArrayPropertyPreview
- BooleanPreview
- ColorChip
- DatePreview
- EmptyValue
- EnumValuesChip
- ImagePreview
- MapPropertyPreview
- NumberPropertyPreview
- PropertyPreview
- SkeletonComponent
- StringPropertyPreview
- UrlComponentPreview
Hooks and utilities Functions​
- createCMSDefaultTheme
- deleteEntityWithCallbacks
- resolveNavigationFrom
- saveEntityWithCallbacks
- useAuthController
- useBreadcrumbsContext
- useCollectionFetch
- useDataSource
- useEntityFetch
- useFireCMSContext
- useModeState
- useNavigationContext
- useResolvedNavigationFrom
- useSideEntityController
- useSnackbarController
- useStorageSource
Firestore Functions​
Components Functions​
- BreadcrumbUpdater
- EntityForm
- EntityPreview
- ErrorView
- FireCMSHomePage
- NavigationRoutes
- ReferenceDialog
- SideDialogs
- Table
Datasource Functions​
Firebase Functions​
- FirebaseCMSApp
- FirebaseLoginView
- performAlgoliaTextSearch
- useBuildFirebaseAuthDelegate
- useFirebaseStorageSource
- useFirestoreDataSource
- useInitialiseFirebase
Other Functions​
- CustomDialogActions
- DebouncedTextField
- DeleteConfirmationDialog
- ExpandablePanel
- FireCMSLogo
- NotFoundPage
- StorageThumbnailInternal
- SwitchControl
- addInitialSlash
- canCreateEntity
- canDeleteEntity
- canEditEntity
- cmsToFirestoreModel
- editableProperty
- fullPathToCollectionSegments
- getBadgeForWidget
- getCollectionByPath
- getCollectionPathsCombinations
- getColorForProperty
- getDefaultValuesFor
- getFistAdditionalView
- getHashValue
- getIconForProperty
- getIconForView
- getIdIcon
- getLastSegment
- getPropertyInPath
- getReferenceFrom
- getResolvedPropertyInPath
- getValueInPath
- getWidget
- getWidgetId
- hydrateRegExp
- isEmptyObject
- isHidden
- isObject
- isPropertyBuilder
- isReadOnly
- isValidRegExp
- mergeCollections
- mergeDeep
- pick
- randomString
- removeFunctions
- removeInPath
- removeInitialAndTrailingSlashes
- removeInitialSlash
- removeNonEditableProperties
- removeTrailingSlash
- removeUndefined
- renderSkeletonCaptionText
- renderSkeletonIcon
- renderSkeletonImageThumbnail
- renderSkeletonText
- resolveArrayProperty
- resolveCollection
- resolveCollectionAliases
- resolveEnumValues
- resolvePermissions
- resolveProperties
- resolveProperty
- resolvePropertyEnum
- segmentsToStrippedPath
- serializeRegExp
- sortProperties
- stripCollectionPath
- toSnakeCase
- traverseValueProperty
- traverseValuesProperties
- useClipboard
- useDebounce
- useSelectionController
- useSideDialogContext