Search

Find components, guides, and documentation

Input File: API Table

class: FileHandle

Fields

NamePrivacyTypeDefaultDescriptionInherited From
failedProppublicArray<string>[]
systemFilepublicsystemFile
_acceptCriteriaprotected_acceptCriteria

Methods

NamePrivacyDescriptionParametersReturnInherited From
createDownloadUrlpublicfile: SystemFile
uploadFileStatuspublic
_getFileNameExtensionprotectedfileName: stringstring

class: LionInputFile, lion-input-file

Fields

NamePrivacyTypeDefaultDescriptionInherited From
acceptpublicstring''
buttonLabelpublicstring''The label of the button
enableDropZonepublicbooleanfalse
isDraggingpublicboolean
maxFileSizepublicnumberMAX_FILE_SIZE
modelValuepublicarray[]Overrides the inherited accessor with a typed pair instead of a class field: a field would be emitted as a property and every consumer that type-checks the declarations reports “TS2610: ‘modelValue’ is defined as an accessor … but is overridden here as an instance property”. Keeps the published InputFile[] type and adds no runtime behaviour.
multiplepublicbooleanfalse
operationModepublic
slotspublic
typepublicstring'file'
uploadOnSelectpublicbooleanfalse
uploadResponsepublicUploadResponse[][]
_acceptCriteriaprotected
_buttonNodeprotected
_feedbackConditionMetaprotectedLionField
_fileListNodeprotectedLionSelectedFileList
_focusableNodeprotectedLionField
_initialButtonLabelprotectedstring''
_inputNodeprotectedHTMLInputElement
_isDragAndDropSupportedprotected
_selectedFilesMetaDataprotectedInputFile[][]

Methods

NamePrivacyDescriptionParametersReturnInherited From
clearpublicClears modelValue. Interaction states are not cleared (use resetInteractionState for this)LionField
formatterpublicv: InputFile[]string
onLocaleUpdatedpublic
parserpublicInputFile[]
resetpublicResets modelValue to initial value. Interaction states are clearedLionField
resetInteractionStatepublicLionField
_dispatchFileListChangeEventprotectednewFiles: InputFile[]
_dropZoneTemplateprotectedTemplateResult
_handleErroredFilesprotectedfileObj: InputFile
_handleErrorsprotected
_inputGroupAfterTemplateprotectedTemplateResult
_inputGroupInputTemplateprotectedTemplateResult
_isEmptyprotectedHelper method for the mutually exclusive Required Validator
_onChangeprotectedDispatches custom bubble eventev: Event=LionField
_onClickprotectedClear _inputNode.value to make sure onChange is called even for duplicate filesev: Event
_onRemoveFileprotectedev: CustomEvent
_processDroppedFilesprotectedev: DragEvent
_processFilesprotectedRuns on drag or change eventselectedFiles: InputFile[]
_reflectBackOnprotectedEvery time .formattedValue is attempted to sync to the view value (on change/blur and on modelValue change), this condition is checked. In case of the input-file we don’t want this sync to happen, since the view value is already correct.boolean
_removeFileprotectedremovedFile: InputFile
_showFeedbackConditionForprotectedtype: string, meta: object
_updateUploadButtonDescriptionprotectedDescription for screen readers connected to the button about how many files have been updated

Events

NameTypeDescriptionInherited From
file-list-changedCustomEvent
file-removedCustomEvent
user-input-changedEventLionField

Attributes

NameFieldInherited From
acceptaccept
multiplemultiple
button-labelbuttonLabel
max-file-sizemaxFileSize
enable-drop-zoneenableDropZone
upload-on-selectuploadOnSelect
is-draggingisDragging
uploadResponseuploadResponse
_selectedFilesMetaData_selectedFilesMetaData

Slots

NameDescription
file-select-button[private] The button to open the file dialog
selected-file-list[private] The list of selected files

class: LionSelectedFileList, lion-selected-file-list

Fields

NamePrivacyTypeDefaultDescriptionInherited From
fileListpublicInputFile[][]
multiplepublicbooleanfalse

Methods

NamePrivacyDescriptionParametersReturnInherited From
_enhanceLightDomA11yprotected
_listItemAfterTemplateprotectedfile: InputFile, fileUuid: stringTemplateResult
_listItemBeforeTemplateprotectedfile: InputFileTemplateResult|typeof nothing
_removeButtonContentTemplateprotectedTemplateResult
_removeFileprotectedremovedFile: InputFile
_selectedListItemTemplateprotectedfile: InputFileTemplateResult
_validationFeedbackTemplateprotectedvalidationFeedback: Array<FeedbackMessage>, fileUuid: stringTemplateResult

Events

NameTypeDescriptionInherited From
file-remove-requestedCustomEvent

Attributes

NameFieldInherited From
fileListfileList
multiplemultiple