jc-media-field

The schema defines the following properties:

instanceId (string, required)

when (Expression | boolean)

options (Options, required)

Sub Schemas

The schema defines the following additional types:

Options (Media picker field options)

Properties of the Options object:

imageQuality (number | string)

Image quality after compression (from 0 to 100, where 100 is the best quality). On iOS, values larger than 80 don't produce a noticeable quality increase in most images, while a value of 80 will reduce the file size by about half or less compared to a value of 100. Default: 100 (Android)/ 80 (iOS)

The object must be any of the following types:

imageQuality (string)

maximumFileSize (number | none | string)

Maximum file size in bytes. Set to 'none' to disable size check. Default value is 6MB.

The object must be any of the following types:

maximumFileSize (string)

Default: "=6 * 1024 * 1024"

imageCropping (object)

Image cropping options

Properties of the imageCropping object:

isEnabled (boolean | string)

Image cropping enabled?

The object must be any of the following types:

isEnabled (string)

Default: true

isFreeStyleCropEnabled (boolean | string)

The object must be any of the following types:

isFreeStyleCropEnabled (string)

Default: true

width (number | string)

Width of result image after cropping

The object must be any of the following types:

width (string)

height (number | string)

Height of result image after cropping

The object must be any of the following types:

height (string)

label (string | Expression | TextWithFormat | TextLocale, required)

Label is displayed as placeholder when no value.

icon (icon-name | string)

Trailing icon.

The object must be any of the following types:

icon (icon-name)

icon (string)

helperText (string | Expression | TextWithFormat | TextLocale)

Helper text is displayed only when there is no errorText.

errorText (string | Expression | TextWithFormat | TextLocale)

Text displayed when field's value is not valid. When not empty it displays isNegative style as well.

style (Date Picker Style)

More of them can be true. It will be evaluated based on priority.

Properties of the style object:

isDisabled (boolean | string)

Change style to disabled. User can't do anything with field when disabled.

The object must be any of the following types:

isDisabled (string)

isBusy (boolean | string)

Displays spinner on right side of text field. It removes icon if any.

The object must be any of the following types:

isBusy (string)

isPositive (boolean | string)

Displays success icon on right side of text field.

The object must be any of the following types:

isPositive (string)

isRequired (boolean | string)

True when the field is required. Useful when you use it in form submission.

The object must be any of the following types:

isRequired (string)

isOptionalLabelHidden (boolean | string)

If the field is optional you can turn off the "(optional)" label if you want.

The object must be any of the following types:

isOptionalLabelHidden (string)

isIgnored (boolean | string)

When true, the field will be ignored when submitting the form.

The object must be any of the following types:

isIgnored (string)

isHidden (boolean | string)

If true it will be hidden to user.

The object must be any of the following types:

isHidden (string)

initialValue (string | string[] | string)

Initial value of the relevant field. You can use this to preset value, so user doesn't need to add anything and use this "default".

The object must be any of the following types:

initialValue (string | string[])

The object must be any of the following types:

initialValue (string[])

The object is an array with all elements of the type string.

initialValue (string)

value (string | string[] | string)

The value to show for the field. Text field is a controlled component, which means the internal value will be forced to match this value prop if provided. In most cases, you don't need to use this.

The object must be any of the following types:

value (string | string[])

The object must be any of the following types:

value (string[])

The object is an array with all elements of the type string.

value (string)

onChange (keg-action-in-background)

Action Keg component that will be triggered when value is changed

color (object[])

Changing color of field based on conditions. First evaluated to true will be used.

The object is an array with all elements of the type object.

The array object has the following properties:

isMultiple (boolean | string)

Allow multiple file selection

The object must be any of the following types:

isMultiple (string)

Default: false

mediaType (image | any | string, required)

The object must be any of the following types:

mediaType (string)

Default: "image"