Skip to main content
The DromoUploader component is the primary way to integrate Dromo into your React application. It accepts the following props:
string
required
Your Dromo front-end license key, which can be found in the Dromo dashboard.
Field[]
required
An array of Field objects which comprise your import schema.
Settings
required
Settings object to change the behavior of the Dromo importer.
User
required
User metadata object to associate with the import.
string
The ID of a pre-existing schema created in Schema Studio. If provided, the fields, settings (except importIdentifier and developmentMode), and hooks props will be ignored in favor of the saved schema’s configuration. See Usage with saved schemas.
RowHook[]
An array of row hook functions.
BulkRowHook[]
An array of bulk row hook functions.
BatchRowHook[]
An array of initialization-only batch row hook functions. Each function receives a bounded slice of rows and its one-based batch number.
RowDeleteHook[]
An array of row delete hook functions called when users remove rows.
object[]
An array of column hook objects. Each object has two entries:
string
required
The field key of the field this column hook should run on.
ColumnHookFn
required
The column hook function.
object[]
An array of step hook objects. Each object has two entries:
'UPLOAD_STEP' | 'REVIEW_STEP' | 'REVIEW_STEP_POST_HOOKS' | 'REVIEW_STEP_PRE_SUBMIT'
required
The type of step hook.
StepHookFn
required
A function matching the signature for the specified step hook type.
CustomStepConfig[]
An array of custom step configurations inserted into the import flow.
{ extensions: string[], parseFile: ParseFileFn }[]
An array of custom file parser configurations.
BeforeFinishCallbackFn
A beforeFinish callback function called immediately before completing the import to check results.
OnResultsCallbackFn
An onResults callback function called with the results after the user finishes the import.
() => void
Called if the user leaves the Dromo Uploader before completing the import.
(event: IUserEvent) => void
Called when the user interacts with a tracked control in the importer. See the onUserEvent reference for event payloads.
boolean
(Available in version >= 2.0.9) If provided, determines whether the Dromo importer modal should open. See Controlling the Modal Programmatically.
boolean
Overrides the developmentMode setting if a schemaId is also provided. Defaults to false.
string
Overrides the importIdentifier setting if a schemaId is also provided.
Record<string, string | number | boolean | null>
Sets the importMetadata for this import when a schemaId is provided. Without a saved schema, pass importMetadata inside settings instead.