jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2024-11-29 21:46:11 +03:00
Code Issues Projects Releases Wiki Activity

CHANGELOG: add migration guide for event changes

Browse Source
This commit is contained in:
Jonathan Daugherty 2016-10-30 14:06:00 -07:00
parent a34ae2ec1c
commit 94011993c4
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CHANGELOG.md
View File

@ -6,7 +6,20 @@ Brick changelog
----
This release primarily adds support for mouse interaction. For details,
see the Mouse Support section of the User Guide.
see the Mouse Support section of the User Guide. This release also
includes breaking API changes for the App type. Here's a migration
guide:
* Event handlers now take "BrickEvent n e" instead of "e", where "e"
was the custom event type used before this change. To recover your
own custom events, pattern-match on "AppEvent"; to recover Vty input
events, pattern-match on "VtyEvent".
* appLiftVtyEvent went away and can just be removed from your App
record constructor.
* If you aren't using the custom event type or were just using Vty's
"Event" type as your App's event type, you can set your event type to
just "e" because you'll now be able to get Vty events regardless of
whether you use a custom event type.
API changes:
* Added the Widget combinator "clickable" to indicate that a widget