feat(explorer): improve accessibility and consistency (+ bug fix) (#488)

Ben Schlegel

2023-09-20 b029eeadabe0877df6ec11443c68743f1494bc40

 quartz/components/ExplorerNode.tsx

@@ -2,6 +2,8 @@
import { QuartzPluginData } from "../plugins/vfile"
import { resolveRelative } from "../util/path"

type OrderEntries = "sort" | "filter" | "map"

export interface Options {
  title: string
  folderDefaultState: "collapsed" | "open"
@@ -9,6 +11,8 @@
  useSavedState: boolean
  sortFn: (a: FileNode, b: FileNode) => number
  filterFn?: (node: FileNode) => boolean
  mapFn?: (node: FileNode) => void
  order?: OrderEntries[]
}

type DataWrapper = {
@@ -31,7 +35,7 @@
  constructor(name: string, file?: QuartzPluginData, depth?: number) {
    this.children = []
    this.name = name
    this.file = file ?? null
    this.file = file ? structuredClone(file) : null
    this.depth = depth ?? 0
  }

@@ -72,18 +76,18 @@
   * @param filterFn function to filter tree with
   */
  filter(filterFn: (node: FileNode) => boolean) {
    const filteredNodes: FileNode[] = []
    this.children = this.children.filter(filterFn)
    this.children.forEach((child) => child.filter(filterFn))
  }

    const traverse = (node: FileNode) => {
      if (filterFn(node)) {
        filteredNodes.push(node)
      }
      node.children.forEach(traverse)
    }
  /**
   * Filter FileNode tree. Behaves similar to `Array.prototype.map()`, but modifies tree in place
   * @param mapFn function to use for mapping over tree
   */
  map(mapFn: (node: FileNode) => void) {
    mapFn(this)

    traverse(this)

    this.children = filteredNodes
    this.children.forEach((child) => child.map(mapFn))
  }

  /**
@@ -141,12 +145,12 @@
  }

  return (
    <div>
    <li>
      {node.file ? (
        // Single file node
        <li key={node.file.slug}>
          <a href={resolveRelative(fileData.slug!, node.file.slug!)} data-for={node.file.slug}>
            {node.file.frontmatter?.title}
            {node.name}
          </a>
        </li>
      ) : (
@@ -170,17 +174,17 @@
                <polyline points="6 9 12 15 18 9"></polyline>
              </svg>
              {/* render <a> tag if folderBehavior is "link", otherwise render <button> with collapse click event */}
              <li key={node.name} data-folderpath={folderPath}>
              <div key={node.name} data-folderpath={folderPath}>
                {folderBehavior === "link" ? (
                  <a href={`${folderPath}`} data-for={node.name} class="folder-title">
                    {node.name}
                  </a>
                ) : (
                  <button class="folder-button">
                    <h3 class="folder-title">{node.name}</h3>
                    <p class="folder-title">{node.name}</p>
                  </button>
                )}
              </li>
              </div>
            </div>
          )}
          {/* Recursively render children of folder */}
@@ -206,6 +210,6 @@
          </div>
        </div>
      )}
    </div>
    </li>
  )
}