Documentation
¶
Index ¶
- Variables
- func InitialModel(dir string, firstUseCheck, hasTrashCheck bool) model
- func LoadAllDefaultConfig(content embed.FS)
- func LoadInitial_PrerenderedVariables()
- func LoadPrerenderedVariables()
- func LoadThemeConfig()
- func LogAndExit(msg string, values ...any)
- type ConfigType
- type HotkeysType
- type ThemeType
Constants ¶
This section is empty.
Variables ¶
View Source
var ( HotkeysTomlString string ConfigTomlString string DefaultThemeString string )
Variables for holding default configurations of each settings
View Source
var LastTimeCursorMove = [2]int{int(time.Now().UnixMicro()), 0}
View Source
var ListeningMessage = true
Functions ¶
func InitialModel ¶
Initialize and return model with default configs
func LoadAllDefaultConfig ¶
Load all default configurations from superfile_config folder into global configurations variables
func LoadInitial_PrerenderedVariables ¶ added in v1.2.1
func LoadInitial_PrerenderedVariables()
No dependencies
func LoadPrerenderedVariables ¶ added in v1.2.1
func LoadPrerenderedVariables()
Dependecies LoadThemeConfig() in style.go should be finished loadConfigFile() in config_types.go should be finished InitIcon() in config package in function.go should be finished
func LoadThemeConfig ¶
func LoadThemeConfig()
func LogAndExit ¶ added in v1.2.1
Todo : Eventually we want to remove all such usage that can result in app exiting abruptly
Types ¶
type ConfigType ¶
type ConfigType struct {
Theme string `toml:"theme" comment:"More details are at https://superfile.netlify.app/configure/superfile-config/\nchange your theme"`
Editor string `toml:"editor" comment:"\nThe editor files will be opened with. (Leave blank to use the EDITOR environment variable)."`
DirEditor string `toml:"dir_editor" comment:"\nThe editor directories will be opened with. (Leave blank to use the default editors)."`
AutoCheckUpdate bool `toml:"auto_check_update" comment:"\nAuto check for update"`
CdOnQuit bool `` /* 146-byte string literal not displayed */
DefaultOpenFilePreview bool `toml:"default_open_file_preview" comment:"\nWhether to open file preview automatically every time superfile is opened."`
ShowImagePreview bool `toml:"show_image_preview" comment:"\nWhether to show image preview."`
DefaultDirectory string `toml:"default_directory" comment:"\nThe path of the first file panel when superfile is opened."`
FileSizeUseSI bool `` /* 131-byte string literal not displayed */
DefaultSortType int `toml:"default_sort_type" comment:"\nDefault sort type (0: Name, 1: Size, 2: Date Modified)."`
SortOrderReversed bool `toml:"sort_order_reversed" comment:"\nDefault sort order (false: Ascending, true: Descending)."`
CaseSensitiveSort bool `toml:"case_sensitive_sort" comment:"\nCase sensitive sort by name (captal \"B\" comes before \"a\" if true)."`
Debug bool `toml:"debug" comment:"\nWhether to enable debug mode."`
Nerdfont bool `` /* 147-byte string literal not displayed */
TransparentBackground bool `` /* 137-byte string literal not displayed */
FilePreviewWidth int `` /* 227-byte string literal not displayed */
CodePreviewer string `` /* 153-byte string literal not displayed */
SidebarWidth int `` /* 199-byte string literal not displayed */
BorderTop string `toml:"border_top" comment:"\nBorder style"`
BorderBottom string `toml:"border_bottom"`
BorderLeft string `toml:"border_left"`
BorderRight string `toml:"border_right"`
BorderTopLeft string `toml:"border_top_left"`
BorderTopRight string `toml:"border_top_right"`
BorderBottomLeft string `toml:"border_bottom_left"`
BorderBottomRight string `toml:"border_bottom_right"`
BorderMiddleLeft string `toml:"border_middle_left"`
BorderMiddleRight string `toml:"border_middle_right"`
Metadata bool `` /* 142-byte string literal not displayed */
EnableMD5Checksum bool `toml:"enable_md5_checksum" comment:"Enable MD5 checksum generation for files"`
}
Configuration settings
var Config ConfigType
type HotkeysType ¶
type HotkeysType struct {
Confirm []string `` /* 175-byte string literal not displayed */
Quit []string `toml:"quit"`
// movement
ListUp []string `toml:"list_up" comment:"movement"`
ListDown []string `toml:"list_down"`
PageUp []string `toml:"page_up"`
PageDown []string `toml:"page_down"`
CloseFilePanel []string `toml:"close_file_panel" comment:"file panel control"`
CreateNewFilePanel []string `toml:"create_new_file_panel"`
NextFilePanel []string `toml:"next_file_panel"`
PreviousFilePanel []string `toml:"previous_file_panel"`
ToggleFilePreviewPanel []string `toml:"toggle_file_preview_panel"`
OpenSortOptionsMenu []string `toml:"open_sort_options_menu"`
ToggleReverseSort []string `toml:"toggle_reverse_sort"`
FocusOnProcessBar []string `toml:"focus_on_process_bar" comment:"change focus"`
FocusOnSidebar []string `toml:"focus_on_sidebar"`
FocusOnMetaData []string `toml:"focus_on_metadata"`
FilePanelItemCreate []string `toml:"file_panel_item_create" comment:"create file/directory and rename "`
FilePanelItemRename []string `toml:"file_panel_item_rename"`
CopyItems []string `toml:"copy_items" comment:"file operate"`
PasteItems []string `toml:"paste_items"`
CutItems []string `toml:"cut_items"`
DeleteItems []string `toml:"delete_items"`
ExtractFile []string `toml:"extract_file" comment:"compress and extract"`
CompressFile []string `toml:"compress_file"`
OpenFileWithEditor []string `toml:"open_file_with_editor" comment:"editor"`
OpenCurrentDirectoryWithEditor []string `toml:"open_current_directory_with_editor"`
PinnedDirectory []string `toml:"pinned_directory" comment:"other"`
ToggleDotFile []string `toml:"toggle_dot_file"`
ChangePanelMode []string `toml:"change_panel_mode"`
OpenHelpMenu []string `toml:"open_help_menu"`
OpenCommandLine []string `toml:"open_command_line"`
CopyPath []string `toml:"copy_path"`
CopyPWD []string `toml:"copy_present_working_directory"`
ConfirmTyping []string `` /* 177-byte string literal not displayed */
CancelTyping []string `toml:"cancel_typing"`
ParentDirectory []string `` /* 221-byte string literal not displayed */
SearchBar []string `toml:"search_bar"`
FilePanelSelectModeItemsSelectDown []string `` /* 246-byte string literal not displayed */
FilePanelSelectModeItemsSelectUp []string `toml:"file_panel_select_mode_items_select_up"`
FilePanelSelectAllItem []string `toml:"file_panel_select_all_items"`
}
type ThemeType ¶
type ThemeType struct {
// Code syntax highlight theme
CodeSyntaxHighlightTheme string `toml:"code_syntax_highlight"`
// Border
FilePanelBorder string `toml:"file_panel_border"`
SidebarBorder string `toml:"sidebar_border"`
// Border Active
FilePanelBorderActive string `toml:"file_panel_border_active"`
SidebarBorderActive string `toml:"sidebar_border_active"`
ModalBorderActive string `toml:"modal_border_active"`
// Background (bg)
FullScreenBG string `toml:"full_screen_bg"`
FilePanelBG string `toml:"file_panel_bg"`
SidebarBG string `toml:"sidebar_bg"`
ModalBG string `toml:"modal_bg"`
// Foreground (fg)
FullScreenFG string `toml:"full_screen_fg"`
FilePanelFG string `toml:"file_panel_fg"`
SidebarFG string `toml:"sidebar_fg"`
ModalFG string `toml:"modal_fg"`
// Special Color
Cursor string `toml:"cursor"`
Correct string `toml:"correct"`
Error string `toml:"error"`
Hint string `toml:"hint"`
Cancel string `toml:"cancel"`
GradientColor []string `toml:"gradient_color"`
DirectoryIconColor string `toml:"directory_icon_color"`
// File Panel Special Items
FilePanelTopDirectoryIcon string `toml:"file_panel_top_directory_icon"`
FilePanelTopPath string `toml:"file_panel_top_path"`
FilePanelItemSelectedFG string `toml:"file_panel_item_selected_fg"`
FilePanelItemSelectedBG string `toml:"file_panel_item_selected_bg"`
// Sidebar Special Items
SidebarTitle string `toml:"sidebar_title"`
SidebarItemSelectedFG string `toml:"sidebar_item_selected_fg"`
SidebarItemSelectedBG string `toml:"sidebar_item_selected_bg"`
SidebarDivider string `toml:"sidebar_divider"`
// Modal Special Items
ModalCancelFG string `toml:"modal_cancel_fg"`
ModalCancelBG string `toml:"modal_cancel_bg"`
ModalConfirmFG string `toml:"modal_confirm_fg"`
ModalConfirmBG string `toml:"modal_confirm_bg"`
HelpMenuHotkey string `toml:"help_menu_hotkey"`
HelpMenuTitle string `toml:"help_menu_title"`
}
Theme configuration
Source Files
¶
- config_function.go
- config_type.go
- default_config.go
- file_operations.go
- file_operations_compress.go
- file_operations_extract.go
- function.go
- get_data.go
- handle_file_operations.go
- handle_modal.go
- handle_panel_movement.go
- handle_panel_navigation.go
- handle_panel_up_down.go
- handle_pinned_operations.go
- internal_consts.go
- key_function.go
- model.go
- model_render.go
- prerendered_variable.go
- sidebar.go
- string_function.go
- style.go
- style_function.go
- type.go
- type_utils.go
- wheel_function.go
Click to show internal directories.
Click to hide internal directories.