https://github.com/cortesi/canopy

https://github.com/cortesi/canopy

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/cortesi/canopy
• Owner: cortesi
• Created: 2021-06-06T07:30:03.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-10-01T06:52:56.000Z (over 1 year ago)
• Last Synced: 2025-03-26T13:04:46.531Z (2 months ago)
• Language: Rust
• Size: 5.51 MB
• Stars: 16
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![.github/workflows/ci.yml](https://github.com/cortesi/canopy/actions/workflows/ci.yml/badge.svg)](https://github.com/cortesi/canopy/actions/workflows/ci.yml)

**Hey curious person - if you've stumbled onto this project, please know that Canopy is is not yet ready for human

consumption. I'll announce a release as soon as I feel it's worth anyone else's time.**

    

# Canopy: a terminal UI library for Rust

In a forest each tree spreads its branches wide to maximise access to sunlight, but also carefully avoids touching the

foliage of its neighbours. This phenomenon is called "crown shyness" - the forest canopy becomes an organic tiling of

the sky.

**Canopy** works just the same, but in your terminal. Interface elements are arranged in an ordered tree, with each node

managing only its children, who manage their own children in turn, until the leaf nodes tile the screen without overlap.

All interface operations are defined cleanly as traversals of this node tree.

# Documentation

- [Guide](https://cortesi.github.io/canopy/book)

- [API](https://cortesi.github.io/canopy/book/doc/canopy/index.html)