# Uni Tree View

> Tree view and selection component for uni-app and Vue 3. It supports single and multiple selection, parent-child association, strict selection, disabled nodes, filtering and highlighting, lazy loading with retry, fixed-height virtual rendering, and custom slots.

Uni Tree View is distributed through npm and the DCloud plugin marketplace. The verified targets and known limitations are documented on the platform compatibility page. The project is currently in the 0.x stage, so check the changelog before upgrading.

## Start Here

- [Introduction](https://ofreshman.github.io/uni-tree-view/guide/introduction): Features, scope, non-goals, and verified compatibility summary.
- [Installation](https://ofreshman.github.io/uni-tree-view/guide/installation): npm and DCloud installation, manual import, resolver-based automatic import, and global types.
- [Quick Start](https://ofreshman.github.io/uni-tree-view/guide/quick-start): Copyable examples for basic data, selection with v-model, field mapping, node styling, and filtering.
- [Platform Compatibility](https://ofreshman.github.io/uni-tree-view/guide/platforms): Verified platforms, unverified targets, and cross-platform implementation notes.
- [License and Attribution](https://ofreshman.github.io/uni-tree-view/guide/license): MIT notice requirements, recommended attribution, and guidance for modified distributions.
- [FAQ](https://ofreshman.github.io/uni-tree-view/guide/faq): Controlled values, disabled nodes, virtual scrolling, component styling, lazy-load retry, and common integration issues.

## API Reference

- [Props](https://ofreshman.github.io/uni-tree-view/apis/props): Component properties, defaults, selection behavior, and TreeProps field mapping.
- [Events](https://ofreshman.github.io/uni-tree-view/apis/events): Event names and payload structures.
- [Slots](https://ofreshman.github.io/uni-tree-view/apis/slots): Node content, label, icon, append content, and empty states.
- [Methods](https://ofreshman.github.io/uni-tree-view/apis/methods): Public methods exposed through the component ref.
- [Types](https://ofreshman.github.io/uni-tree-view/apis/types): Public TypeScript types and global component declarations.

## Examples

- [Basic Usage](https://ofreshman.github.io/uni-tree-view/examples/basic): Display, expansion, disabled nodes, row interactions, paths, events, and node classes.
- [Single and Multiple Selection](https://ofreshman.github.io/uni-tree-view/examples/selection): Radio selection, leaf-only selection, linked checkboxes, strict mode, and imperative selection.
- [Filtering](https://ofreshman.github.io/uni-tree-view/examples/filter): Built-in matching, custom matching, filter events, highlighting, and empty results.
- [Lazy Loading](https://ofreshman.github.io/uni-tree-view/examples/lazy-load): Loading children, leaf resolution, error retry, static children, and virtual rendering integration.
- [Virtual Rendering](https://ofreshman.github.io/uni-tree-view/examples/virtual): Large trees, fixed row heights, lazy loading, and scrolling to a key.
- [Custom Slots](https://ofreshman.github.io/uni-tree-view/examples/slots): Label, icon, append content, full node content, and empty states.

## Project Resources

- [Interactive Demo](https://ofreshman.github.io/uni-tree-view/ui/index.html): H5 playground built from the current repository.
- [GitHub Repository](https://github.com/OFreshman/uni-tree-view): Source code, issues, contribution guide, and release history.
- [Changelog](https://github.com/OFreshman/uni-tree-view/blob/main/CHANGELOG.md): Public changes and upgrade notes.
- [npm Package](https://www.npmjs.com/package/uni-tree-view): Published package metadata and versions.
- [DCloud Plugin](https://ext.dcloud.net.cn/plugin?id=28897): Plugin marketplace distribution.

## Optional

- [Netlify Mirror](https://uni-tree-view.netlify.app/): Alternate documentation deployment; it may lag behind when Netlify production deploys are paused.