@publictypeFieldRules
Import
import {type FieldRules} from 'sanity'Signature
type FieldRules = {
[fieldKey: string]: SchemaValidationValue
}type FieldRules = {
[fieldKey: string]: SchemaValidationValue
}sanity- Components
- Hooks
useClient()useColorSchemeSetValue()@alphauseColorSchemeValue()@alphauseCurrentLocale()useCurrentUser()useDataset()useDateTimeFormat()useDocumentVersionTypeSortedList()@betauseFormValue()useFormattedDuration()useGetFormValue()useListFormat()useNumberFormat()useOnlyHasVersions()@betausePerspective()@betauseProjectId()useReferringDocuments()@betauseSchema()useTranslation()useUnitFormatter()useUserListWithPermissions()@beta
- Functions
buildLegacyTheme()defineArrayMember()@betadefineField()@betadefineLocale()defineLocaleResourceBundle()defineSearchFilter()@alphadefineSearchFilterOperators()@alphadefineSearchOperator()@alphadefineType()@betadocumentIdEquals()getDocumentVariantType()@betaisCrossDatasetReference()@betaisDocumentSchemaType()isImage()isKeyedObject()isPortableTextListBlock()@alphaisPortableTextSpan()@alphaisPortableTextTextBlock()@alphaisSanityDocument()isSlug()isTypedObject()unstable_useObserveDocument()@betauserHasRole()validateDocument()@beta
- Variables
- Interfaces
ArrayDefinitionArrayOfObjectsFormNodeArrayOfPrimitivesFormNodeArrayOptionsArrayRuleArraySchemaTypeAssetAssetSchemaTypeOptionsAssetSourceAssetSourceComponentPropsAssetSourceSpecAuthConfigAuthProviderBaseItemPropsBaseSchemaDefinitionBaseSchemaTypeBaseSchemaTypeOptionsBlockAnnotationDefinitionBlockAnnotationPropsBlockDecoratorDefinitionBlockDecoratorPropsBlockDefinitionBlockListDefinitionBlockListItemPropsBlockMarksDefinitionBlockOptionsBlockPropsBlockRuleBlockStyleDefinitionBlockStylePropsBooleanDefinitionBooleanOptionsBooleanRuleBooleanSchemaTypeCollapseOptionsConditionalPropertyCallbackContextConfigContextCrossDatasetReferenceDefinitionCrossDatasetReferenceSchemaType@betaCrossDatasetReferenceValue@betaCrossDatasetType@betaCurrentUserCustomValidatorDateDefinitionDateOptionsDateRuleDatetimeDefinitionDatetimeOptionsDatetimeRuleDefineSchemaOptions@betaDeprecatedPropertyDeprecationConfigurationDocumentDefinitionDocumentRuleEmailDefinitionEmailOptionsEmailRuleEmptyPropsEnumListPropsFieldDefinitionBaseFieldErrorFieldGroupFieldMemberFieldReferenceFieldSetMemberFileAssetFileDefinitionFileOptionsFileRuleFileSchemaTypeFileValueFile_2FormBuilderProps@alphaFormNodeValidationFormProviderProps@alphaFormattedDurationGeopointDefinitionGeopointOptionsGeopointRuleGeopointValueGetHookCollectionStatePropsHookCollectionActionHookI18nTitledListValueImageAssetImageCropImageDefinitionImageDimensionsImageHotspotImageMetadataImageOptionsImagePaletteImageRuleImageSwatchImageValueImage_2InitialValueResolverContextInitialValueTemplateItemInsertMenuOptions@alphaIntrinsicDefinitionsKeyedObjectLegacyThemePropsLocaleConfigContextLocaleDefinitionLocalePluginOptionsLocaleResourceBundleLocaleResourceRecordLocaleSourceLocaleWeekInfoLocale_2LocalizedValidationMessagesMultiFieldSetNumberDefinitionNumberOptionsNumberRuleNumberSchemaTypeObjectArrayFormNodeObjectDefinitionObjectFieldObjectFormNodeObjectItemPropsObjectOptionsObjectRuleObjectSchemaTypeOperatorButtonValueComponentProps@alphaOperatorInputComponentProps@alphaPerspectiveContextValue@betaPluginOptions@betaPortableTextInputPropsPortableTextListBlock@alphaPortableTextObject@alphaPortableTextSpan@alphaPortableTextTextBlock@alphaPrepareViewOptionsPreviewConfigPreviewValuePrimitiveItemPropsReferenceReferenceBaseOptionsReferenceDefinitionReferenceFilterQueryOptionsReferenceFilterResolverContextReferenceFilterResolverOptionsReferenceRuleReferenceSchemaTypeReleaseDocument@betaRenderPortableTextInputEditablePropsRoleRuleRuleDefSanityCreateOptionsSanityDocumentSanityDocumentLikeSanityFormConfigScheduledPublishingPluginOptionsSchemaSchemaValidationErrorSearchConfigurationSearchOperatorBase@alphaSearchOperatorBuilder@alphaSingleFieldSetSlugSlugDefinitionSlugOptionsSlugRuleSlugSchemaTypeSlugSourceContextSlugValidationContextSlugValueSortOrderingItem@betaSourceSourceClientOptionsStringDefinitionStringOptionsStringRuleStringSchemaTypeStudioThemeTemplateTemplateFieldDefinitionTemplateItemTemplateReferenceTargetTextDefinitionTextOptionsTextRuleTextSchemaTypeTitledListValueToolTranslationPropsTypeAliasDefinitionTypeReferenceTypeTargetTypedObjectUriValidationOptionsUrlDefinitionUrlOptionsUrlRuleUseFormattedDurationOptionsUseListFormatOptionsUseTranslationOptionsUserUserListWithPermissionsOptions@betaValidateDocumentOptions@betaValidationContextValidationErrorValidationMarkerValuelessSearchOperatorBuilder@alphaWeakCrossDatasetReferenceValue@betaWidenInitialValue@betaWidenValidation@betaWorkspace
- Type aliases
ArrayActionName@betaArrayOfEntryArrayOfTypeAssetFromSourceAssetMetadataTypeAutocompleteString@betaBooleanFormNodeComposableOptionConditionalPropertyConditionalPropertyCallbackCrossDatasetReferenceFilterResolver@betaCrossDatasetReferenceFilterSearchOptions@betaCustomValidatorResultDefaultPluginsWorkspaceOptions@betaDefineArrayMemberBase@betaDefineSchemaBase@betaDefineSchemaType@betaDeprecatedSchemaTypeDocumentField@betaDocumentVariantType@betaDuplicateKeysErrorFieldDefinitionFieldGroupDefinitionFieldRulesFieldsetFieldsetDefinitionFormattableMeasurementUnitGeneralPreviewLayoutKeyHotkeysPropsI18nSearchOperatorDescriptionKey@alphaI18nSearchOperatorNameKey@alphaI18nTextRecordImageMetadataTypeImplicitLocaleResourceBundleIncompatibleTypeErrorIndexTupleInitialValuePropertyInitialValueResolverInlineFieldDefinitionIntrinsicArrayOfBase@betaIntrinsicArrayOfDefinitionIntrinsicBase@betaIntrinsicTypeNameItemPropsLocaleNestedResourceLocaleResourceKeyLocalesBundlesOptionLocalesOptionLoginMethodMaybeAllowUnknownProps@betaMaybePreview@betaMissingKeysErrorMixedArrayErrorNarrowPreview@betaNavbarAction@betaNumberFormNodeObjectFieldTypeObjectItemObjectMemberPathSegmentPerspectiveStack@betaPortableTextBlock@alphaPortableTextChild@alphaPortableTextPreviewLayoutKeyPreviewLayoutKeyReferenceFilterOptionsReferenceFilterResolverReferenceFilterSearchOptionsReferenceOptionsReferenceToReferenceValueReleaseId@betaRuleBuilderRuleSpecRuleTypeConstraintSchemaTypeSchemaTypeDefinitionSchemaValidationValueSearchFilterDefinition@betaSearchOperatorButtonValue@alphaSearchOperatorInput@alphaSearchOperatorParams@alphaSearchOperatorType@alphaSearchStrategySearchValueFormatterContext@alphaSelectedPerspective@betaSlugIsUniqueValidatorSlugParentSlugSourceFnSlugifierFnSortOrdering@betaStaticLocaleResourceBundleStrictDefinition@betaStringFormNodeStudioThemeColorSchemeKeySwatchNameTemplateArrayFieldDefinitionTemplateParameterTemplateResolverTranslateComponentMapTypeAnnotationMismatchErrorUndeclaredMembersErrorUnitFormatterUseDateTimeFormatOptionsUseNumberFormatOptionsUseTranslationResponseUseUnitFormatterOptionsValidationBuilderValuelessSearchOperatorParams@alpha
sanity/cli- Functions
- Interfaces
sanity/migrate- Functions
append()at()collectMigrationMutations()create()createIfNotExists()createOrReplace()dec()decodeText()defineMigration()delay()delete_()diffMatchPatch()dryRun()filter()fromDocuments()fromExportArchive()fromExportEndpoint()inc()insert()insertAfter()insertBefore()map()parse()parseJSON()patch()prepend()replace()run()set()setIfMissing()split()stringify()stringifyJSON()take()toArray()toFetchOptionsIterable()transaction()truncate()unset()
- Variables
- Interfaces
- Type aliases
AnyOpArrayOpAsyncIterableMigrationCreateIfNotExistsMutationCreateMutationCreateOrReplaceMutationDecOpDeleteMutationDiffMatchPatchOpDocumentMigrationReturnValueIncOpIndexedSegmentInsertOpJSONParserJsonArrayJsonObjectJsonPrimitiveJsonValueKeyedSegmentMigrateDefinitionMutationNodeMigrationReturnValueNodePatchNodePatchListNumberOpOperationPatchMutationPatchOptionsPathPrimitiveOpRelativePositionReplaceOpSanityDocumentSetIfMissingOpSetOpStringOpTruncateOpUnsetOp
sanity/presentation- Hooks
- Functions
- Variables
- Interfaces
CombinedSearchParamsDocumentLocationDocumentLocationsStateDocumentResolverContextHeaderOptionsIframeLoadedActionIframeRefreshActionIframeReloadActionInspectorTabNavigatorOptionsPresentationParamsPresentationPluginOptionsPresentationSearchParamsPresentationStatePresentationStateParamsPreviewHeaderPropsPreviewPropsStructureDocumentPaneParamsVisualEditingOverlaysToggleAction
- Type aliases
sanity/router- Components
- Hooks
- Variables
- Interfaces
- Type aliases
sanity/structure- Classes
- Variables
- Interfaces
BaseGenericListBaseIntentParamsBaseViewBuildableComponentBuildableGenericListBuildableListChildObservableChildResolverChildResolverOptionsComponentComponentInputComponentViewDefaultDocumentNodeContextDividerDocumentListDocumentListInputDocumentListItemDocumentListItemInputDocumentListOptionsDocumentNodeDocumentOptionsDocumentTypeListInputEditorNodeFormViewGenericListGenericListInputIntentIntentCheckerListListDisplayOptionsListInputListItemListItemDisplayOptionsListItemInputListItemSerializeOptionsMenuItemMenuItemGroupPartialDocumentListPartialDocumentNodeSerializableSerializeOptionsStructureBuilderStructureContextStructureNodeStructureToolOptionsUnserializedListItem
- Type aliases
ChildCollectionCollectionBuilderDefaultDocumentNodeResolverIntentJsonParamsIntentParamsItemChildListItemChildMenuItemActionTypeMenuItemParamsTypePartialDocumentListItemPartialListItemPartialMenuItemSerializePathStructureLocaleResourceKeys@alphaStructureResolverUnserializedListItemChildUserComponentUserViewComponentViewViewBuilder
sanity@3.79.0