File Upload Form Control
👉 Upload files API should return array of objects as shown below.
// Upload file should return this type of response.
[{
"originalName": "photo1.jpeg",
"uploadPath": "/dev/profiles"
}, {
"originalName": "photo2.jpeg",
"uploadPath": "/dev/profiles"
}];
👉 Download file API should return base64 of file. This API will also be used for file preview.
👉 Remove file API should remove file from storage. It will receive below type of object.
Example
let dbMasterConfig: T.IDBMasterConfig = {
form: {
fields: [
[{
label: 'Profile Photo',
control: T.EDBMasterFormControl.file_upload,
path: 'profile_photo',
fileUploadSettings: {
// :userPath = it will be replaced with admin user path by master page automatically.
// :beHostPort = it will be replaced with API Maker backend's protocol and host and port automatically. ex : https://example.com
uploadApiUrl: ':beHostPort/api/custom-api/:userPath/upload-file-test?category=profile_photo',
downloadApiUrl: ':beHostPort/api/custom-api/:userPath/download-file-test?category=profile_photo',
removeApiUrl: ':beHostPort/api/custom-api/:userPath/remove-file-test?category=profile_photo',
multiple: true,
fileLimit: 3,
}
}]
]
}
};
Interface Documentation
/**
* Form field configuration for UI controls.
* Defines the appearance, behavior, and validation of individual form inputs.
*/
export interface IDBMasterConfigFormField {
/**
* Unique identifier for programmatic element access.
* Useful for dynamic field manipulation.
*/
hiddenId?: string;
/** Display label for the form field. */
label?: string;
/**
* Help text displayed below the control.
* Supports HTML formatting for rich content.
*/
helpText?: string;
/**
* Database field path where the control value is stored.
* Supports nested paths using dot notation.
* @example 'name', 'address.city', 'user.contact.email'
*/
path?: string;
/** Type of UI control to render. */
control?: EDBMasterFormControl;
/**
* CSS classes for the parent div wrapping the control.
* @default 'col-lg mt-4 col-md-{calculated based on columns.length}'
*/
cssClassDiv?: string;
/**
* Auto-focus this control when form opens.
* @default false
*/
autofocus?: boolean;
/**
* Disable the control or use expression to conditionally disable.
* When a string is provided, it's evaluated as JavaScript.
* @example true | false | "formData.type === 'readonly'"
*/
disabled?: boolean | string;
/**
* Control visibility or use expression to conditionally show/hide.
* When a string is provided, it's evaluated as JavaScript.
* @default true
* @example true | false | "formData.userRole === 'admin'"
*/
visible?: boolean | string;
/**
* Nested form fields for complex layouts.
* Enables hierarchical form structures within this field.
*/
fields?: IDBMasterConfigFormField[][];
/** Validation rules for this field. */
validations?: Pick<IPropertyValidation, 'required'> & {
/**
* Dynamic required validation function.
* Evaluated when form data changes to determine if field is required.
* Note: When present, this takes precedence over static 'required' property.
* @example "formData.type === 'individual' ? true : false"
*/
requiredFun?: string;
};
/** Custom validation error messages. */
validationErrors?: {
/** Custom error message for required field validation. */
required?: string;
};
/**
* File upload control configuration.
* Upload single or multiple files with validation and preview.
*
* **Key Features:**
* - Single or multiple file selection
* - File type restrictions (accept)
* - File size validation
* - File count limits
* - Auto-upload or manual upload
* - Upload/download/remove API integration
*
* **API Requirements:**
* - Upload API should accept files in "files" form data field
* - Upload API must return: `[{ originalName: string, uploadPath: string }]`
* - Download API should return file content in base64 format
*
* @example
* // Single image upload
* fileUploadSettings: {
* uploadApiUrl: '/api/upload',
* downloadApiUrl: '/api/download',
* removeApiUrl: '/api/remove',
* accept: 'image/*',
* maxFileSize: 5000000, // 5MB
* multiple: false,
* auto: true
* }
*
* @example
* // Multiple document upload with limit
* fileUploadSettings: {
* uploadApiUrl: '/api/upload-docs',
* accept: '.pdf,.doc,.docx',
* multiple: true,
* fileLimit: 5,
* maxFileSize: 10000000, // 10MB
* auto: false
* }
*/
fileUploadSettings?: {
/** Give style object in angular style. */
style?: any;
/** custom CSS class to assign to control */
cssClass?: string,
/** Default : false, When enabled, upload begins automatically after selection is completed. */
auto?: boolean;
/**
* API URL which will be used to upload files.<br/>
* API should return array of objects in below format.<br/>
* You can have other properties and below properties are required.
* [{
* originalName: string,
* uploadPath: string,
* }]
* API Maker's custom API will accept files in "files" form data field.
*
* */
uploadApiUrl: string;
/** API URL which returns content of file in base64 format. */
downloadApiUrl?: string;
removeApiUrl?: string;
/** Allow to select multiple files or not */
multiple?: boolean;
/** ex : image/* */
accept?: string;
/** Maximum file size allowed in bytes. Default : 10000000 (10MB) */
maxFileSize?: number;
/** Maximum number of files that can be uploaded. */
fileLimit?: number;
/** Internal use property to show/hide upload button on UI control. */
_showUploadButton?: boolean;
/** internal use only */
_fileSelectEvent?: any;
/** Advisory information to display in a tooltip on hover. */
tooltip?: string;
/** Type of CSS position. */
tooltipPosition?: 'left' | 'top' | 'bottom' | 'right';
tooltipStyleClass?: string;
};
}
/**
* Validation rules for schema properties and form fields.
* Define constraints that values must satisfy before being saved.
*/
export interface IPropertyValidation {
/**
* Field is mandatory and must have a non-null, non-empty value.
* Applicable to all data types.
*/
required?: boolean;
/**
* Minimum allowed value.
* Applicable to: number, date
*/
min?: number;
/**
* Maximum allowed value.
* Applicable to: number, date
*/
max?: number;
/**
* Minimum string/array length.
* Applicable to: string, array
*/
minLength?: number;
/**
* Maximum string/array length.
* Applicable to: string, array
*/
maxLength?: number;
/**
* Value must be unique across all records.
* @deprecated API Maker maintains uniqueness internally.
* Avoid using on tables with frequent updates due to performance impact.
*/
unique?: boolean;
/**
* Validate email address format.
* Applicable to: string
*/
email?: boolean;
/**
* Custom validation function.
* Return true if valid, false or error message if invalid.
*/
validatorFun?: Function;
/**
* Enumeration constraint - value must be from this array.
* @example ['active', 'inactive', 'pending']
*/
enum?: any[];
}
export enum EDBMasterFileUploadAppendTo {
visible = 'visible',
disabled = 'disabled',
}
/**
* Available form control types for UI generation.
* Each control type has specific settings and behavior.
*/
export enum EDBMasterFormControl {
/** Single-line text input. */
input = 'input',
/** Numeric input with spinner buttons and formatting. */
inputNumber = 'inputNumber',
/** Text input with pattern-based masking (phone, SSN, etc.). */
inputMask = 'inputMask',
/** One-time password multi-character input. */
inputOtp = 'inputOtp',
/** Password input with visibility toggle and strength meter. */
password = 'password',
/** Date and/or time picker with calendar popup. */
date_picker = 'date_picker',
/** Multi-line text input. */
textarea = 'textarea',
/** Rich text WYSIWYG editor. */
editor = 'editor',
/** Binary checkbox (true/false). */
checkbox = 'checkbox',
/** Radio button group for single selection. */
radio = 'radio',
/** Color picker with multiple format support. */
color_picker = 'color_picker',
/** Dropdown select with single selection. */
dropdown = 'dropdown',
/** Autocomplete with type-ahead search. */
auto_complete = 'auto_complete',
/** Multi-select dropdown with chip display. */
multi_select = 'multi_select',
/** File upload with validation. */
file_upload = 'file_upload',
/** Nested data grid for one-to-many relationships. */
grid = 'grid',
/** Visual separator line. */
divider = 'divider',
/** Star-based rating input. */
rating = 'rating',
/** Circular dial for numeric input. */
knob = 'knob',
/** Collapsible accordion panels (field container). */
accordion = 'accordion',
/** Tabbed view for organizing fields (field container). */
tab_view = 'tab_view',
/** Clickable button with custom actions. */
button = 'button',
/** Image display with preview. */
image = 'image',
/** Custom HTML content. */
customHTML = 'customHTML',
}
export enum EDBMasterCustomActionButtonAppendTo {
click = 'click',
}