Skip to main content

useFileField

Reads the value of a file field with a single file. For fields with multiple: true, use useFilesField.

function useFileField(props: {field: string}): ValueFile | null

Arguments

PropertyTypeDescription
fieldstringThe name of the field.

Returns

The uploaded file as ValueFile, or null if no file was uploaded. If the field contains multiple files, the first file.

Example

src/widgets/example/Example.tsx
import React from 'react'
import {useFileField} from '@modbros/dashboard-sdk'

export default function Example() {
const image = useFileField({field: 'image'})

if (!image) {
return null
}

return <img src={image.src} alt={image.filename} style={{width: '100%', height: '100%', objectFit: 'contain'}}/>
}