Skip to content

azriel91/disposition

Repository files navigation

📐 disposition

Crates.io docs.rs CI Coverage Status

SVG diagram generator.

Playground: https://azriel.im/disposition.

Note

🚧 This crate is not yet stable.

See design notes at https://peace.mk/book/side_projects/disposition.html.

Features

Details
  • Pure Rust.
  • SVG for lossless resolution.
  • Stable layout.
  • Sensible default styling.
  • Customizable styling.
  • Interactive highlighting.
  • CSS only interactivity.
  • Edges between nodes.
  • Edge animations representing requests/responses.
  • Arrows on edges.
  • Circle as node shape.
  • Light and dark modes.
  • Dependencies between process steps.
  • Tooltips.
  • Images in nodes.
  • Responsive layout.

Usage

Library usage is a work in progress.

Add the following to Cargo.toml:

[dependencies]
disposition = "0.1.0"

In code:

use disposition;

todo!("Wait for the next version. Currently only the playground is usable.")

Development

Playground

Install dx (dioxus build tool):

cargo install cargo-binstall
cargo binstall dioxus-cli

Run dx serve in app/playground:

cd app/playground
dx serve

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

SVG diagram generator

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors