@animech-public/chonky
Version:
A File Browser component for React
104 lines (103 loc) • 4.11 kB
TypeScript
import { ChangeSelectionPayload, EndDragNDropPayload, KeyboardClickFilePayload, MouseClickFilePayload, MoveFilesPayload, OpenFileContextMenuPayload, OpenFilesPayload, RenameFilePayload, StartDragNDropPayload, StartRenamingFilePayload, EndRenamingFilePayload } from '../types/action-payloads.types';
import { ChonkyIconName } from '../types/icons.types';
export declare const EssentialActions: {
/**
* Action that is dispatched when the user clicks on a file entry using their mouse.
* Both single clicks and double clicks trigger this action.
*/
MouseClickFile: import("tsdef").WritableProps<{
readonly id: "mouse_click_file";
readonly __payloadType: MouseClickFilePayload;
}>;
/**
* Action that is dispatched when the user "clicks" on a file using their keyboard.
* Using Space and Enter keys counts as clicking.
*/
KeyboardClickFile: import("tsdef").WritableProps<{
readonly id: "keyboard_click_file";
readonly __payloadType: KeyboardClickFilePayload;
}>;
/**
* Action that is dispatched when user starts dragging some file.
*/
StartDragNDrop: import("tsdef").WritableProps<{
readonly id: "start_drag_n_drop";
readonly __payloadType: StartDragNDropPayload;
}>;
/**
* Action that is dispatched when user either cancels the drag & drop interaction,
* or drops a file somewhere.
*/
EndDragNDrop: import("tsdef").WritableProps<{
readonly id: "end_drag_n_drop";
readonly __payloadType: EndDragNDropPayload;
}>;
/**
* Action that is dispatched when user moves files from one folder to another,
* usually by dragging & dropping some files into the folder.
*/
MoveFiles: import("tsdef").WritableProps<{
readonly id: "move_files";
readonly __payloadType: MoveFilesPayload;
}>;
/**
* Action that is dispatched after user finishes renaming a file,
* usually by pressing Enter or the input field loses focus.
*/
RenameFile: import("tsdef").WritableProps<{
readonly id: "rename_file";
readonly __payloadType: RenameFilePayload;
}>;
/**
* Action that is dispatched when user starts renaming a file,
* usually by clicking on the file name of a single selected file.
*/
StartRenamingFile: import("tsdef").WritableProps<{
readonly id: "start_renaming_file";
readonly __payloadType: StartRenamingFilePayload;
}>;
/**
* Action that is dispatched when user either cancels the renaming,
* or save the new target name.
*/
EndRenamingFile: import("tsdef").WritableProps<{
readonly id: "end_renaming_file";
readonly __payloadType: EndRenamingFilePayload;
}>;
/**
* Action that is dispatched when the selection changes for any reason.
*/
ChangeSelection: import("tsdef").WritableProps<{
readonly id: "change_selection";
readonly __payloadType: ChangeSelectionPayload;
}>;
/**
* Action that is dispatched when user wants to open some files. This action is
* often triggered by other actions.
*/
OpenFiles: import("tsdef").WritableProps<{
readonly id: "open_files";
readonly __payloadType: OpenFilesPayload;
}>;
/**
* Action that is triggered when user wants to go up a directory.
*/
OpenParentFolder: import("tsdef").WritableProps<{
readonly id: "open_parent_folder";
readonly button: {
readonly name: "Go up a directory";
readonly toolbar: true;
readonly contextMenu: false;
readonly icon: ChonkyIconName.openParentFolder;
readonly iconOnly: true;
};
}>;
/**
* Action that is dispatched when user opens the context menu, either by right click
* on something or using the context menu button on their keyboard.
*/
OpenFileContextMenu: import("tsdef").WritableProps<{
readonly id: "open_file_context_menu";
readonly __payloadType: OpenFileContextMenuPayload;
}>;
};