jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2024-12-02 11:05:10 +03:00
Code Issues Projects Releases Wiki Activity

Forms: improve module documentation

Browse Source
This commit is contained in:
Jonathan Daugherty 2020-02-07 16:28:09 -08:00
parent 0febb15bc3
commit 79474295c3
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/Brick/Forms.hs
View File

@ -5,7 +5,11 @@
{-# LANGUAGE ScopedTypeVariables #-} {-# LANGUAGE ScopedTypeVariables #-}
-- | NOTE: This API is experimental and will probably change. Please try -- | NOTE: This API is experimental and will probably change. Please try
-- it out! Feedback is very much appreciated, and your patience in the -- it out! Feedback is very much appreciated, and your patience in the
-- face of breaking API changes is also appreciated! -- face of breaking API changes is also appreciated! It's also worth
-- bearing in mind that this API is designed to support a narrow range
-- of use cases. If you find that you need more customization than this
-- offers, then you will need to consider building your own layout and
-- event handling for input fields.
-- --
-- For a fuller introduction to this API, see the "Input Forms" section -- For a fuller introduction to this API, see the "Input Forms" section
-- of the Brick User Guide. Also see the demonstration programs for -- of the Brick User Guide. Also see the demonstration programs for
@ -19,10 +23,6 @@
-- user when a form field's value is invalid, and stores valid inputs in -- user when a form field's value is invalid, and stores valid inputs in
-- your data type when possible. -- your data type when possible.
-- --
-- This module provides the API to create forms, populate them with some
-- basic input field types, render forms, handle form events, and create
-- custom input field types.
--
-- A form has both a visual representation and a corresponding data -- A form has both a visual representation and a corresponding data
-- structure representing the latest valid values for that form -- structure representing the latest valid values for that form
-- (referred to as the "state" of the form). A 'FormField' is a single -- (referred to as the "state" of the form). A 'FormField' is a single