mirror of
https://github.com/jtdaugherty/brick.git
synced 2024-09-11 15:55:54 +03:00
Forms: improve module documentation
This commit is contained in:
parent
0febb15bc3
commit
79474295c3
@ -5,7 +5,11 @@
|
||||
{-# LANGUAGE ScopedTypeVariables #-}
|
||||
-- | NOTE: This API is experimental and will probably change. Please try
|
||||
-- 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
|
||||
-- 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
|
||||
-- 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
|
||||
-- structure representing the latest valid values for that form
|
||||
-- (referred to as the "state" of the form). A 'FormField' is a single
|
||||
|
Loading…
Reference in New Issue
Block a user