SolidFile class

A comprehensive file management widget combining file browser and upload functionality.

Inheritance

Constructors

SolidFile({Key? key, required String basePath, String? currentPath, String? friendlyFolderName, bool showBackButton = true, String backButtonText = 'Back to Home Folder', bool? forceWideScreen, double? browserHeight, VoidCallback? onBackPressed, dynamic onFileSelected(String fileName, String filePath)?, dynamic onFileDownload(String fileName, String filePath)?, dynamic onFileDelete(String fileName, String filePath)?, dynamic onDirectoryChanged(String path)?, VoidCallback? onClosePreview, dynamic onImportCsv(String fileName, String filePath)?, bool showUpload = true, SolidFileUploadConfig? uploadConfig, SolidFileUploadCallbacks? uploadCallbacks, SolidFileUploadState? uploadState, GlobalKey<SolidFileBrowserState>? browserKey, bool autoConfig = true})
const
SolidFile.withConfig({Key? key, required SolidFileConfig config, required SolidFileCallbacks callbacks, required SolidFileState state, GlobalKey<SolidFileBrowserState>? browserKey})
Legacy constructor for backward compatibility.

Properties

autoConfig bool
Whether to automatically configure upload settings based on path. Defaults to true for convenience.
final
backButtonText String
Text for the back button.
final
basePath String
Base path for file operations.
final
browserHeight double?
Custom height for the file browser.
final
browserKey GlobalKey<SolidFileBrowserState>?
Global key for the file browser.
final
currentPath String?
Current path in the file browser.
final
forceWideScreen bool?
Whether to use wide screen layout.
final
friendlyFolderName String?
Friendly name for the current folder.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onBackPressed VoidCallback?
Callback when back button is pressed.
final
onClosePreview VoidCallback?
Callback when preview is closed by user.
final
onDirectoryChanged → dynamic Function(String path)?
Callback when directory changes.
final
onFileDelete → dynamic Function(String fileName, String filePath)?
Callback when a file should be deleted.
final
onFileDownload → dynamic Function(String fileName, String filePath)?
Callback when a file should be downloaded.
final
onFileSelected → dynamic Function(String fileName, String filePath)?
Callback when a file is selected.
final
onImportCsv → dynamic Function(String fileName, String filePath)?
Callback for CSV import.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showBackButton bool
Whether to show the back button.
final
showUpload bool
Whether to show upload functionality.
final
uploadCallbacks SolidFileUploadCallbacks?
Upload callbacks.
final
uploadConfig SolidFileUploadConfig?
Upload configuration. If null, will be auto-generated based on currentPath.
final
uploadState SolidFileUploadState?
Upload state.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<SolidFile>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited