mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
017d7c7377
* fix: reduce Vale false positives via vocab and config updates - Make English-word vocab entries case-insensitive so sentence-start capitalization and normal prose usage stop flagging (agents, rest, cursor, setup, endpoints, etc.) - Add vocab entries for filenames and code identifiers that appear in frontmatter and JSX contexts (docs.json, llms.txt, CLAUDE.md, etc.) - Ignore openapi frontmatter lines, filenames, JSX attributes, email addresses, and internal link targets via TokenIgnores - Skip inline code scope and indented code fences - Add Headings exceptions for proper nouns (Claude Code, GitHub Actions, Route 53, GA4, etc.) - Disable linting for the all-code vercel-json-generator snippet Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: resolve all Vale warnings and errors across docs Content fixes: - Reword sentences using 'will', first person, spaced em dashes, 'e.g.', Latin abbreviations, and hyphenated adverbs - Sentence-case headings that started with dotted filenames - Backtick literal API values instead of bolding them - Move periods inside quotation marks - Fix Oxford comma rule misfires by restructuring sentences False-positive suppression: - Vale toggles around example user questions, keyboard shortcut keys (Cmd+I), UI labels, and code samples in JSX contexts that Vale misparses - Exclude vale toggle comments from the brace Token/BlockIgnores so in-document commands actually reach Vale (the greedy brace pattern was also silently swallowing large regions; now lazy) - Vocab entries for code identifiers (internal_id, handleSubmit, etc.) - Per-file rule disables for component docs with dotted JSX names and files where link-target linting ignores in-document toggles Result: vale --minAlertLevel warning is clean repo-wide; only suggestion-level items (Passive, Semicolons, Acronyms) remain. mint broken-links passes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: correct WordList rule instead of degrading prose - Restore sentence-start "Email" in advanced-support; the rule now only flags hyphenated e-mail/E-mail forms - Restore the idiom "above all else"; the above->preceding swap now exempts "above all" Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: restore deliberate prose flagged by blunt rules - Restore spatial 'above the navbar' / 'above a page title' in custom-scripts; the above->preceding swap now exempts 'above the/a/an' - Restore the '= ...' in the react-components named-export example (the ellipsis is inside inline code) with an Ellipses toggle - Restore SLA phrasing 'will use commercially reasonable efforts' with a Will toggle - Restore the quoted developer question in the GEO guide intro with a FirstPerson toggle, matching the file's other example questions Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: remove WordList swaps that flag legitimate English - Drop tablet->device and firewalls->firewall rules; both words are correct in ordinary prose - Narrow touch->tap to UI-instruction phrasing (touch the/a) so 'keep in touch' and 'touch devices' stop flagging Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: reposition vale toggles to wrap whole blocks Toggle comments placed between list items split the lists (restarting ol numbering in deployments) and comments flush against tables risked breaking GFM table parsing. Wrap entire lists/tables with blank-line separation instead. Verified rendering with mint dev: single ol with two items, tables intact, no comments in visible DOM. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * refactor: prune accept.txt to load-bearing entries Empirically removed 166 vocab entries (575 -> 409) whose removal causes no Vale flags across all 908 English pages: dictionary words that never needed listing (agents, setup, endpoints, webhooks, yaml), lowercase entries the speller already accepts, and filename entries made redundant by inline vale toggles. Kept every case-enforcing entry (API, JSON, GitHub, ...) so casing policy is unchanged, plus entries that double as capitalization exceptions for headings (mcp, md, auth, cursor, txt). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Update ai/mintlify-mcp.mdx * Update api/agent/v2/create-agent-job.mdx * chore: alphabetize Headings exceptions and accept.txt Case-insensitive sort, ignoring the (?i) prefix; also drops a duplicate Scala entry. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix: re-apply OxfordComma rewrite lost in branch merge Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: resolve Vale suggestions batch 1 (acronyms, semicolons, passive voice) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: resolve remaining Vale suggestions (passive voice batch 2) Rewrite ~90 passive constructions to active voice across deploy, guides, migration-services, and organize docs. Toggle the deliberate passive examples in the style-and-tone guide ('by zombies' test). Add axios/lodash vocab entries for a repositioned code example. vale . is now fully clean: 0 errors, 0 warnings, 0 suggestions. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
120 lines
3.5 KiB
Plaintext
120 lines
3.5 KiB
Plaintext
---
|
|
title: "Tree"
|
|
description: "Use the tree component to display hierarchical file and folder structures with collapsible nodes and syntax highlighting for path names."
|
|
keywords: ["tree", "file tree", "folder structure", "hierarchical navigation", "file system"]
|
|
boost: 3
|
|
---
|
|
|
|
Use tree components to display hierarchical structures like file systems, project directories, or nested content. The tree component supports keyboard navigation and accessibility features.
|
|
|
|
## Basic tree
|
|
|
|
<Tree>
|
|
<Tree.Folder name="app" defaultOpen>
|
|
<Tree.File name="layout.tsx" />
|
|
<Tree.File name="page.tsx" />
|
|
<Tree.File name="global.css" />
|
|
</Tree.Folder>
|
|
<Tree.Folder name="lib">
|
|
<Tree.File name="utils.ts" />
|
|
<Tree.File name="db.ts" />
|
|
</Tree.Folder>
|
|
<Tree.File name="package.json" />
|
|
<Tree.File name="tsconfig.json" />
|
|
</Tree>
|
|
|
|
```mdx Tree example
|
|
<Tree>
|
|
<Tree.Folder name="app" defaultOpen>
|
|
<Tree.File name="layout.tsx" />
|
|
<Tree.File name="page.tsx" />
|
|
<Tree.File name="global.css" />
|
|
</Tree.Folder>
|
|
<Tree.Folder name="lib">
|
|
<Tree.File name="utils.ts" />
|
|
<Tree.File name="db.ts" />
|
|
</Tree.Folder>
|
|
<Tree.File name="package.json" />
|
|
<Tree.File name="tsconfig.json" />
|
|
</Tree>
|
|
```
|
|
|
|
## Nested folders
|
|
|
|
Create deeply nested structures by nesting `Tree.Folder` components within each other.
|
|
|
|
<Tree>
|
|
<Tree.Folder name="app" defaultOpen>
|
|
<Tree.File name="layout.tsx" />
|
|
<Tree.File name="page.tsx" />
|
|
<Tree.Folder name="api" defaultOpen>
|
|
<Tree.Folder name="auth">
|
|
<Tree.File name="route.ts" />
|
|
</Tree.Folder>
|
|
<Tree.File name="route.ts" />
|
|
</Tree.Folder>
|
|
<Tree.Folder name="components">
|
|
<Tree.File name="button.tsx" />
|
|
<Tree.File name="dialog.tsx" />
|
|
<Tree.File name="tabs.tsx" />
|
|
</Tree.Folder>
|
|
</Tree.Folder>
|
|
<Tree.File name="package.json" />
|
|
</Tree>
|
|
|
|
```mdx Nested folders example
|
|
<Tree>
|
|
<Tree.Folder name="app" defaultOpen>
|
|
<Tree.File name="layout.tsx" />
|
|
<Tree.File name="page.tsx" />
|
|
<Tree.Folder name="api" defaultOpen>
|
|
<Tree.Folder name="auth">
|
|
<Tree.File name="route.ts" />
|
|
</Tree.Folder>
|
|
<Tree.File name="route.ts" />
|
|
</Tree.Folder>
|
|
<Tree.Folder name="components">
|
|
<Tree.File name="button.tsx" />
|
|
<Tree.File name="dialog.tsx" />
|
|
<Tree.File name="tabs.tsx" />
|
|
</Tree.Folder>
|
|
</Tree.Folder>
|
|
<Tree.File name="package.json" />
|
|
</Tree>
|
|
```
|
|
|
|
## Keyboard navigation
|
|
|
|
The tree component supports keyboard navigation.
|
|
|
|
- **Arrow keys**: Navigate up and down through visible items.
|
|
- **Right arrow**: Expand a closed folder or move to the first child of an open folder.
|
|
- **Left arrow**: Collapse an open folder or move to the parent folder.
|
|
- **Home**: Jump to the first item in the tree.
|
|
- **End**: Jump to the last visible item in the tree.
|
|
- **Enter/Space**: Toggle folder open/closed state.
|
|
- **\***: Expand all sibling folders at the current level.
|
|
- **Type-ahead search**: Type characters to jump to items that start with those characters.
|
|
|
|
## Properties
|
|
|
|
### Tree.Folder
|
|
|
|
<ResponseField name="name" type="string" required>
|
|
The name of the folder displayed in the tree.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="defaultOpen" type="boolean" default="false">
|
|
Whether the folder expands by default.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="openable" type="boolean" default="true">
|
|
Whether users can open and close the folder. Set to false for non-interactive folders.
|
|
</ResponseField>
|
|
|
|
### Tree.File
|
|
|
|
<ResponseField name="name" type="string" required>
|
|
The name of the file displayed in the tree.
|
|
</ResponseField>
|