91f9ae2d71
* feat: add basic explorer structure„ * feat: integrate new component/plugin * feat: add basic explorer structure * feat: add sort to FileNodes * style: improve style for explorer * refactor: remove unused explorer plugin * refactor: clean explorer structure, fix base (toc) * refactor: clean css, respect displayClass * style: add styling to chevron * refactor: clean up debug statements * refactor: remove unused import * fix: clicking folder icon sometimes turns invisible * refactor: clean css * feat(explorer): add config for title * feat: add config for folder click behavior * fix: `no-pointer` not being set for all elements new approach, have one `no-pointer` class, that removes pointer events and one `clickable` class on the svg and button (everything that can normally be clicked). then, find all children with `clickable` and toggle `no-pointer` * fix: bug where nested folders got incorrect height this fixes the bug where nested folders weren't calculating their total height correctly. done by adding class to main container of all children and calculating total * feat: introduce `folderDefaultState` config * feat: store depth for explorer nodes * feat: implement option for collapsed state + bug fixes folderBehavior: "link" still has bad styling, but major bugs with pointers fixed (not clean yet, but working) * fix: default folder icon rotation * fix: hitbox problem with folder links, fix style * fix: redirect url for nested folders * fix: inconsistent behavior with 'collapseFolders' opt * chore: add comments to `ExplorerNode` * feat: save explorer state to local storage (not clean) * feat: rework `getFolders()`, fix localstorage read + write * feat: set folder state from localStorage needs serious refactoring but functional (except folder icon orientation) * fix: folder icon orientation after local storage * feat: add config for `useSavedState` * refactor: clean `explorer.inline.ts` remove unused functions, comments, unused code, add types to EventHandler * refactor: clean explorer merge `isSvg` paths, remove console logs * refactor: add documentation, remove unused funcs * feat: rework folder collapse logic use grids instead of jank scuffed solution with calculating total heights * refactor: remove depth arg from insert * feat: restore collapse functionality to clicks allow folder icon + folder label to collapse folders again * refactor: remove `pointer-event` jank * feat: improve svg viewbox + remove unused props * feat: use css selector to toggle icon rework folder icon to work purely with css instead of JS manipulation * refactor: remove unused cfg * feat: move TOC to right sidebar * refactor: clean css * style: fix overflow + overflow margin * fix: use `resolveRelative` to resolve file paths * fix: `defaultFolderState` config option * refactor: rename import, rename `folderLi` + ul * fix: use `QuartzPluginData` type * docs: add explorer documentation
71 lines
2.2 KiB
TypeScript
71 lines
2.2 KiB
TypeScript
import { QuartzComponentConstructor, QuartzComponentProps } from "./types"
|
|
import explorerStyle from "./styles/explorer.scss"
|
|
|
|
// @ts-ignore
|
|
import script from "./scripts/explorer.inline"
|
|
import { ExplorerNode, FileNode, Options } from "./ExplorerNode"
|
|
|
|
// Options interface defined in `ExplorerNode` to avoid circular dependency
|
|
const defaultOptions = (): Options => ({
|
|
title: "Explorer",
|
|
folderClickBehavior: "collapse",
|
|
folderDefaultState: "collapsed",
|
|
useSavedState: true,
|
|
})
|
|
export default ((userOpts?: Partial<Options>) => {
|
|
function Explorer({ allFiles, displayClass, fileData }: QuartzComponentProps) {
|
|
// Parse config
|
|
const opts: Options = { ...defaultOptions(), ...userOpts }
|
|
|
|
// Construct tree from allFiles
|
|
const fileTree = new FileNode("")
|
|
allFiles.forEach((file) => fileTree.add(file, 1))
|
|
|
|
// Sort tree (folders first, then files (alphabetic))
|
|
fileTree.sort()
|
|
|
|
// Get all folders of tree. Initialize with collapsed state
|
|
const folders = fileTree.getFolderPaths(opts.folderDefaultState === "collapsed")
|
|
|
|
// Stringify to pass json tree as data attribute ([data-tree])
|
|
const jsonTree = JSON.stringify(folders)
|
|
|
|
return (
|
|
<div class={`explorer ${displayClass}`}>
|
|
<button
|
|
type="button"
|
|
id="explorer"
|
|
data-behavior={opts.folderClickBehavior}
|
|
data-collapsed={opts.folderDefaultState}
|
|
data-savestate={opts.useSavedState}
|
|
data-tree={jsonTree}
|
|
>
|
|
<h3>{opts.title}</h3>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
width="14"
|
|
height="14"
|
|
viewBox="5 8 14 8"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-width="2"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
class="fold"
|
|
>
|
|
<polyline points="6 9 12 15 18 9"></polyline>
|
|
</svg>
|
|
</button>
|
|
<div id="explorer-content">
|
|
<ul class="overflow">
|
|
<ExplorerNode node={fileTree} opts={opts} fileData={fileData} />
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
)
|
|
}
|
|
Explorer.css = explorerStyle
|
|
Explorer.afterDOMLoaded = script
|
|
return Explorer
|
|
}) satisfies QuartzComponentConstructor
|