Search documentation of Plushie

# Documentation

Copy Markdown View Source

## Guides

Sequential chapters that build on each other. Start here if you're new to Plushie.

1. Introduction - what Plushie is and how it works
2. Getting Started - installation, binary setup, first run
3. Your First App - building a counter with the Elm architecture
4. The Development Loop - hot reload, IEx, debugging
5. Events - widget events, keyboard, mouse, pattern matching
6. Lists and Inputs - dynamic lists, text inputs, forms
7. Layout - rows, columns, containers, responsive sizing
8. Styling - themes, colors, fonts, per-widget style overrides
9. Animation and Transitions - transitions, springs, tweens, easing
10. Subscriptions - timers, global key/mouse events, window events
11. Async and Effects - async tasks, streams, platform effects
12. Canvas - shapes, layers, transforms, interactive elements
13. Custom Widgets - composing widgets, canvas widgets, native Rust widgets
14. State Management - routing, undo/redo, selection, data pipelines
15. Testing - test framework, backends, selectors, screenshots
16. Shared State - multi-session apps over SSH

## Reference

Lookup material organized by topic. Each page is self-contained.

- Accessibility - AccessKit integration, roles, labels, keyboard navigation
- Animation - transitions, springs, sequences, easing curves, animatable props
- App Lifecycle - init/update/view callbacks, supervision, startup sequence
- Built-in Widgets - every widget with props, events, and examples
- Canvas - shapes, layers, groups, transforms, clips, gradients
- Commands and Effects - async, focus, scroll, window ops, platform effects
- Composition Patterns - reusable components, overlays, context menus, multi-window
- Configuration - application config, environment variables, build settings
- Custom Widgets - the widget macro, props, events, state, native crates
- DSL - macro internals, block forms, canvas scope, container scope
- Events - event types, fields, bubbling, scoped ID matching
- Mix Tasks - build, download, gui, inspect, script, replay
- Scoped IDs - ID scoping rules, scope matching, command paths
- Subscriptions - timer, keyboard, mouse, window, custom subscriptions
- Testing - test case setup, helpers, backends, screenshots, CI
- Themes and Styling - built-in themes, custom palettes, style maps
- Windows and Layout - window props, sizing, pane grids, multi-window
- Wire Protocol - MessagePack/JSON framing, message types, transport modes

## Other resources

- Examples - example apps included in the repo
- Changelog - version history and migration notes
- Demo apps - multi-file projects with custom widgets and real scaffolding

Next Page → Introduction