This README is the one indexed from the repository at its latest ref, not from the tag for this version.

layout

This is a constraint based layout framework. Or more simply put, this generates the measurements for a visual layout which could then be used for:

• Positioning things on a PDF
• Drawing objects in a UI toolkit

Installation

1. Add the dependency to your shard.yml:

dependencies:
  layout:
    github: da1nerd/layout.cr

2. Run shards install

Usage

require "layout"

screen = Layout::Block.new(Layout::Direction::COLUMN)
screen.width = 300f64
screen.height = 300f64
screen.x = 0f64
screen.y = 0f64

top_block = Layout::Block.new
top_block.height = 100f64

bottom_block = Layout::Block.new

screen.children = [top_block, bottom_block]

Layout.solve(screen)

# go use the calculated dimensions!
bottom_block.height.value # => 200f64

With the above code you'd have all the necessary dimensions to draw this stack of blocks.

Development

TODO: Write development instructions here

Contributing

1. Fork it (https://github.com/da1nerd/layout.cr/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Joel Lonbeck - creator and maintainer