The string property can be used with many form fields, from simple text fields, to select fields, markdown or file uploads (the storage key, or the url gets saved).
You can specify a
StorageMeta configuration. It is used to
indicate that this string refers to a path in Google Cloud Storage.
mediaTypeMedia type of this reference, used for displaying the preview.
storagePathAbsolute path in your bucket. You can specify it directly or use a callback
acceptedFilesFile MIME types that can be uploaded to this reference.
metadataSpecific metadata set in your uploaded file.
fileNameYou can specify a fileName callback if you need to customize the name of the file
storeUrlWhen set to
true, this flag indicates that the download URL of the file will be saved in Firestore instead of the Cloud storage path. Note that the generated URL may use a token that, if disabled, may make the URL unusable and lose the original reference to Cloud Storage, so it is not encouraged to use this flag. Defaults to false.
If the value of this property is a URL, you can set this flag
true to add a link, or one of the supported media types to render a preview.
You can use the enum values providing a map of possible
exclusive values the property can take, mapped to the label that it is
displayed in the dropdown. You can use a simple object with the format
label, or with the format
EnumValueConfig if you
need extra customization, (like disabling specific options or assigning
colors). If you need to ensure the order of the elements, you can pass
Map instead of a plain object.
Is this string property long enough, so it should be displayed
in a multiple line field. Defaults to false. If set to
true, the number
of lines adapts to the content.
Should this string property be displayed as a markdown field.
true, the field is rendered as a text editors that supports markdown
highlight syntax. It also includes a preview of the result.
Should this string be rendered as a tag instead of just text.
requiredShould this field be compulsory.
requiredMessageMessage to be displayed as a validation error.
uniqueThe value of this field must be unique in this collection.
uniqueInArrayIf you set it to
true, the user will only be allowed to have the value of that property once in the parent
ArrayProperty. It works on direct children properties or on first level children of a
MapProperty(if set as the
.ofproperty of the
lengthSet a required length for the string value.
minSet a minimum length limit for the string value.
maxSet a maximum length limit for the string value.
matchesProvide an arbitrary regex to match the value against.
urlValidates the value as a valid URL via a regex.
trimTransforms string values by removing leading and trailing whitespace.
lowercaseTransforms the string value to lowercase.
uppercaseTransforms the string value to uppercase.
Based on your configuration the form field widgets that are created are:
TextFieldgeneric text field
StorageUploadFieldthe property has a storage configuration.
MarkdownField.the property has a markdown configuration.
enumValuesare set in the string config, this field renders a select where each option is a colored chip.