The cl-forms Reference Manual

Table of Contents

The cl-forms Reference Manual

This is the cl-forms Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Feb 19 19:42:33 2020 GMT+0.

1 Introduction

CL-FORMS

CL-FORMS is a web forms handling library for Common Lisp.

Although it is potentially framework agnostic, it runs on top of Hunchentoot at the moment.

It features:

• Several form field types: String, boolean, integer, email, password fields. And more.
• Custom fields. CL-FORMS is extensible and it is possible to define new field types.
• Server and client side validation
• Rendering backends. Forms can be rendered via CL-WHO, or Djula, or something else; the backend is pluggable. The default renderer is CL-WHO.
• Themes (like Bootstrap)
• Control on rendering and layout.
• Handling of form errors.
• CSRF protection

Basics

Use defform to define a form. Example:

(defform fields-form (:action "/fields-post")
  ((name :string :value "")
   (ready :boolean :value t)
   (sex :choice :choices (list "Male" "Female") :value "Male")
   (submit :submit :label "Create")))

On your web handler, grab the form via get-form, select a renderer with with-form-rendererand then render the form with render-form:

(let ((form (forms::get-form 'fields-form)))
   (forms:with-form-renderer :who
      (forms:render-form form))

To handle the form, grab it via get-form and then call handle-request (you should probably also call validate-form after). Then bind form fields via either with-form-field-values, that binds the form field values; or with-form-fields that binds the form fields.

(let ((form (forms:get-form 'fields-form)))
    (forms::handle-request form)
    (forms::with-form-field-values (name ready sex) form
       (who:with-html-output (forms.who::*html*)
          (:ul
            (:li (who:fmt "Name: ~A" name))
            (:li (who:fmt "Ready: ~A" ready))
            (:li (who:fmt "Sex: ~A" sex))))))

Plase have a look at the demo sources for more examples of how to use the library

DEMO

There's a demo included. To run:

Download web assets. From /test/static directory run:

bower install

and then:

(require :cl-forms.demo)
(forms.test:run-demo)

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-forms

Author

Mariano Montone

License

MIT

Description

A web forms handling library

Dependencies

• alexandria
• cl-ppcre
• hunchentoot
• ironclad
• uuid
• clavier
• fmt

Source

cl-forms.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cl-forms/src

Parent

cl-forms (system)

Location

src/

Components

• package.lisp (file)
• themes (module)
• cl-forms.lisp (file)
• fields (module)

3.2 cl-forms/src/themes

Dependency

package.lisp (file)

Parent

src (module)

Location

src/themes/

Components

• theme.lisp (file)
• default.lisp (file)
• specials.lisp (file)

3.3 cl-forms/src/fields

Dependency

cl-forms.lisp (file)

Parent

src (module)

Location

src/fields/

Components

• string.lisp (file)
• boolean.lisp (file)
• email.lisp (file)
• password.lisp (file)
• url.lisp (file)
• integer.lisp (file)
• choice.lisp (file)
• date.lisp (file)
• datetime.lisp (file)
• file.lisp (file)
• hidden.lisp (file)
• submit.lisp (file)
• subform.lisp (file)
• list.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 cl-forms.asd

Location

cl-forms.asd

Systems

cl-forms (system)

4.1.2 cl-forms/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-forms

4.1.3 cl-forms/src/themes/theme.lisp

Parent

themes (module)

Location

src/themes/theme.lisp

Internal Definitions

form-theme (class)

4.1.4 cl-forms/src/themes/default.lisp

Dependency

theme.lisp (file)

Parent

themes (module)

Location

src/themes/default.lisp

Internal Definitions

default-form-theme (class)

4.1.5 cl-forms/src/themes/specials.lisp

Dependency

default.lisp (file)

Parent

themes (module)

Location

src/themes/specials.lisp

Internal Definitions

*form-theme* (special variable)

4.1.6 cl-forms/src/cl-forms.lisp

Dependency

themes (module)

Parent

src (module)

Location

src/cl-forms.lisp

Exported Definitions

• *base64-encode* (special variable)
• add-field (function)
• add-form-error (function)
• defform (macro)
• defform-builder (macro)
• field-accessor (method)
• (setf field-accessor) (method)
• field-formatter (method)
• (setf field-formatter) (method)
• field-parser (method)
• (setf field-parser) (method)
• field-reader (method)
• field-valid-p (method)
• field-value (method)
• field-value (method)
• (setf field-value) (method)
• field-writer (method)
• fill-form-from-model (function)
• fill-model-from-form (function)
• form-errors (method)
• (setf form-errors) (method)
• form-field (class)
• form-valid-p (function)
• format-field-value (generic function)
• format-field-value (method)
• format-field-value (method)
• format-field-value-to-string (function)
• get-field (function)
• get-field-value (function)
• get-form (function)
• handle-request (function)
• make-formatter (function)
• remove-field (function)
• render-field (function)
• render-field-errors (function)
• render-field-label (function)
• render-field-widget (function)
• render-form (function)
• render-form-end (function)
• render-form-errors (function)
• render-form-start (function)
• set-field-value (function)
• validate-form (function)
• with-form (macro)
• with-form-field-values (macro)
• with-form-fields (macro)
• with-form-renderer (macro)
• with-form-template (macro)
• with-form-theme (macro)

Internal Definitions

• %collect-replace-fields (function)
• *default-form-renderer* (special variable)
• *field-path* (special variable)
• *field-required-message* (special variable)
• *form* (special variable)
• *form-renderer* (special variable)
• call-with-form (function)
• call-with-form-renderer (method)
• call-with-form-theme (function)
• check-duplicate-fields (function)
• client-validation (method)
• (setf client-validation) (method)
• collect-replace-fields (function)
• display-errors (method)
• (setf display-errors) (method)
• empty-value-p (function)
• field-add-to-path (generic function)
• field-add-to-path (method)
• field-constraints (method)
• (setf field-constraints) (method)
• field-default-value (method)
• (setf field-default-value) (method)
• field-disabled-p (method)
• (setf field-disabled-p) (method)
• field-form (method)
• (setf field-form) (method)
• field-help-text (method)
• (setf field-help-text) (method)
• field-invalid-message (method)
• (setf field-invalid-message) (method)
• field-label (method)
• (setf field-label) (method)
• field-name (method)
• (setf field-name) (method)
• field-placeholder (method)
• (setf field-placeholder) (method)
• field-read-from-request (generic function)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-only-p (method)
• (setf field-read-only-p) (method)
• field-render-label-p (method)
• field-request-name (function)
• field-required-message (method)
• (setf field-required-message) (method)
• field-required-p (method)
• (setf field-required-p) (method)
• field-trim-p (method)
• (setf field-trim-p) (method)
• field-validation-triggers (method)
• (setf field-validation-triggers) (method)
• field-validator (class)
• form (class)
• form-action (method)
• (setf form-action) (method)
• form-csrf-field-name (method)
• (setf form-csrf-field-name) (method)
• form-csrf-protection-p (method)
• (setf form-csrf-protection-p) (method)
• form-enctype (method)
• (setf form-enctype) (method)
• form-fields (method)
• (setf form-fields) (method)
• form-id (method)
• (setf form-id) (method)
• form-method (method)
• (setf form-method) (method)
• form-model (method)
• (setf form-model) (method)
• form-name (method)
• (setf form-name) (method)
• form-session-csrf-entry (method)
• get-form-session-csrf-token (method)
• make-csrf-token (method)
• make-form (function)
• make-form-field (generic function)
• make-form-fields (function)
• post-parameters (function)
• render-field-request-name (function)
• renderer-render-field (generic function)
• renderer-render-field-errors (generic function)
• renderer-render-field-errors (method)
• renderer-render-field-label (generic function)
• renderer-render-field-widget (generic function)
• renderer-render-field-widget (method)
• renderer-render-form (generic function)
• renderer-render-form-end (generic function)
• renderer-render-form-errors (generic function)
• renderer-render-form-errors (method)
• renderer-render-form-start (generic function)
• set-form-session-csrf-token (method)
• validate-form-field (generic function)
• validate-form-field (method)
• validate-form-field (method)
• validator-field (method)
• (setf validator-field) (method)

4.1.7 cl-forms/src/fields/string.lisp

Parent

fields (module)

Location

src/fields/string.lisp

Internal Definitions

• field-read-from-request (method)
• make-form-field (method)
• make-form-field (method)
• string-form-field (class)
• text-form-field (class)
• validate-form-field (method)

4.1.8 cl-forms/src/fields/boolean.lisp

Parent

fields (module)

Location

src/fields/boolean.lisp

Exported Definitions

format-field-value (method)

Internal Definitions

• boolean-form-field (class)
• field-read-from-request (method)
• field-required-p (method)
• make-form-field (method)
• validate-form-field (method)

4.1.9 cl-forms/src/fields/email.lisp

Parent

fields (module)

Location

src/fields/email.lisp

Internal Definitions

• email-form-field (class)
• field-read-from-request (method)
• make-form-field (method)
• validate-form-field (method)

4.1.10 cl-forms/src/fields/password.lisp

Parent

fields (module)

Location

src/fields/password.lisp

Internal Definitions

• field-read-from-request (method)
• make-form-field (method)
• password-form-field (class)

4.1.11 cl-forms/src/fields/url.lisp

Parent

fields (module)

Location

src/fields/url.lisp

Internal Definitions

• field-read-from-request (method)
• make-form-field (method)
• url-form-field (class)
• validate-form-field (method)

4.1.12 cl-forms/src/fields/integer.lisp

Parent

fields (module)

Location

src/fields/integer.lisp

Internal Definitions

• field-read-from-request (method)
• integer-form-field (class)
• make-form-field (method)
• validate-form-field (method)

4.1.13 cl-forms/src/fields/choice.lisp

Parent

fields (module)

Location

src/fields/choice.lisp

Internal Definitions

• alistp (function)
• choice-field-validator (class)
• choice-form-field (class)
• field-choices (method)
• (setf field-choices) (method)
• field-choices-alist (method)
• field-expanded (method)
• (setf field-expanded) (method)
• field-hash-function (method)
• (setf field-hash-function) (method)
• field-key-and-value (method)
• field-key-reader (method)
• (setf field-key-reader) (method)
• field-keys-and-values (method)
• field-multiple (method)
• (setf field-multiple) (method)
• field-preferred-choices (method)
• (setf field-preferred-choices) (method)
• field-read-from-request (method)
• field-test (method)
• (setf field-test) (method)
• make-form-field (method)
• use-key-as-value (method)
• (setf use-key-as-value) (method)

4.1.14 cl-forms/src/fields/date.lisp

Parent

fields (module)

Location

src/fields/date.lisp

Exported Definitions

format-field-value (method)

Internal Definitions

• +default-date-format+ (special variable)
• date-form-field (class)
• date-format (method)
• (setf date-format) (method)
• date-format (method)
• (setf date-format) (method)
• date-max (method)
• (setf date-max) (method)
• date-min (method)
• (setf date-min) (method)
• date-validator (class)
• field-read-from-request (method)
• field-widget (method)
• (setf field-widget) (method)
• make-form-field (method)
• validate-form-field (method)

4.1.15 cl-forms/src/fields/datetime.lisp

Parent

fields (module)

Location

src/fields/datetime.lisp

Exported Definitions

format-field-value (method)

Internal Definitions

• +default-datetime-format+ (special variable)
• datetime-form-field (class)
• datetime-format (method)
• (setf datetime-format) (method)
• datetime-format (method)
• (setf datetime-format) (method)
• datetime-max (method)
• (setf datetime-max) (method)
• datetime-min (method)
• (setf datetime-min) (method)
• datetime-validator (class)
• field-read-from-request (method)
• field-widget (method)
• (setf field-widget) (method)
• make-form-field (method)
• validate-form-field (method)

4.1.16 cl-forms/src/fields/file.lisp

Parent

fields (module)

Location

src/fields/file.lisp

Internal Definitions

• download-link (method)
• field-read-from-request (method)
• field-read-from-request (method)
• file-accept (method)
• (setf file-accept) (method)
• file-content-type (method)
• (setf file-content-type) (method)
• file-form-field (class)
• file-name (method)
• (setf file-name) (method)
• file-path (method)
• (setf file-path) (method)
• make-form-field (method)
• make-form-field (method)
• multiple-p (method)
• (setf multiple-p) (method)
• renderer-render-field-widget (method)
• stateful-file-field (class)
• upload-handler (method)
• (setf upload-handler) (method)

4.1.17 cl-forms/src/fields/hidden.lisp

Parent

fields (module)

Location

src/fields/hidden.lisp

Internal Definitions

• field-read-from-request (method)
• field-render-label-p (method)
• hidden-form-field (class)
• make-form-field (method)

4.1.18 cl-forms/src/fields/submit.lisp

Parent

fields (module)

Location

src/fields/submit.lisp

Internal Definitions

• field-read-from-request (method)
• field-render-label-p (method)
• make-form-field (method)
• submit-form-field (class)

4.1.19 cl-forms/src/fields/subform.lisp

Parent

fields (module)

Location

src/fields/subform.lisp

Internal Definitions

• field-read-from-request (method)
• field-subform (method)
• field-subform-builder (method)
• (setf field-subform-builder) (method)
• field-subform-name (method)
• (setf field-subform-name) (method)
• make-form-field (method)
• subform-builder (method)
• subform-form-field (class)

4.1.20 cl-forms/src/fields/list.lisp

Parent

fields (module)

Location

src/fields/list.lisp

Internal Definitions

• add-button-p (method)
• (setf add-button-p) (method)
• empty-item-predicate (method)
• (setf empty-item-predicate) (method)
• field-read-from-request (method)
• list-field-type (method)
• (setf list-field-type) (method)
• list-field-values (function)
• list-form-field (class)
• make-form-field (method)
• remove-button-p (method)
• (setf remove-button-p) (method)

5 Packages

Packages are listed by definition order.

5.1 cl-forms

Source

package.lisp (file)

Nickname

forms

Use List

common-lisp

Exported Definitions

• *base64-encode* (special variable)
• add-field (function)
• add-form-error (function)
• defform (macro)
• defform-builder (macro)
• field-accessor (generic function)
• field-accessor (method)
• (setf field-accessor) (method)
• (setf field-accessor) (generic function)
• field-formatter (generic function)
• field-formatter (method)
• (setf field-formatter) (method)
• (setf field-formatter) (generic function)
• field-parser (generic function)
• field-parser (method)
• (setf field-parser) (method)
• (setf field-parser) (generic function)
• field-reader (generic function)
• field-reader (method)
• field-valid-p (generic function)
• field-valid-p (method)
• field-value (generic function)
• field-value (method)
• field-value (method)
• (setf field-value) (generic function)
• (setf field-value) (method)
• field-writer (generic function)
• field-writer (method)
• fill-form-from-model (function)
• fill-model-from-form (function)
• form-errors (generic function)
• form-errors (method)
• (setf form-errors) (method)
• (setf form-errors) (generic function)
• form-field (class)
• form-valid-p (function)
• format-field-value (generic function)
• format-field-value (method)
• format-field-value (method)
• format-field-value (method)
• format-field-value (method)
• format-field-value (method)
• format-field-value-to-string (function)
• get-field (function)
• get-field-value (function)
• get-form (function)
• handle-request (function)
• make-formatter (function)
• remove-field (function)
• render-field (function)
• render-field-errors (function)
• render-field-label (function)
• render-field-widget (function)
• render-form (function)
• render-form-end (function)
• render-form-errors (function)
• render-form-start (function)
• set-field-value (function)
• validate-form (function)
• with-form (macro)
• with-form-field-values (macro)
• with-form-fields (macro)
• with-form-renderer (macro)
• with-form-template (macro)
• with-form-theme (macro)

Internal Definitions

• %collect-replace-fields (function)
• *default-form-renderer* (special variable)
• *field-path* (special variable)
• *field-required-message* (special variable)
• *form* (special variable)
• *form-renderer* (special variable)
• *form-theme* (special variable)
• +default-date-format+ (special variable)
• +default-datetime-format+ (special variable)
• add-button-p (generic function)
• add-button-p (method)
• (setf add-button-p) (method)
• (setf add-button-p) (generic function)
• alistp (function)
• boolean-form-field (class)
• call-with-form (function)
• call-with-form-renderer (generic function)
• call-with-form-renderer (method)
• call-with-form-theme (function)
• check-duplicate-fields (function)
• choice-field-validator (class)
• choice-form-field (class)
• client-validation (generic function)
• client-validation (method)
• (setf client-validation) (method)
• (setf client-validation) (generic function)
• collect-replace-fields (function)
• date-form-field (class)
• date-format (generic function)
• date-format (method)
• (setf date-format) (method)
• date-format (method)
• (setf date-format) (method)
• (setf date-format) (generic function)
• date-max (generic function)
• date-max (method)
• (setf date-max) (method)
• (setf date-max) (generic function)
• date-min (generic function)
• date-min (method)
• (setf date-min) (method)
• (setf date-min) (generic function)
• date-validator (class)
• datetime-form-field (class)
• datetime-format (generic function)
• datetime-format (method)
• (setf datetime-format) (method)
• datetime-format (method)
• (setf datetime-format) (method)
• (setf datetime-format) (generic function)
• datetime-max (generic function)
• datetime-max (method)
• (setf datetime-max) (method)
• (setf datetime-max) (generic function)
• datetime-min (generic function)
• datetime-min (method)
• (setf datetime-min) (method)
• (setf datetime-min) (generic function)
• datetime-validator (class)
• default-form-theme (class)
• display-errors (generic function)
• display-errors (method)
• (setf display-errors) (method)
• (setf display-errors) (generic function)
• download-link (generic function)
• download-link (method)
• email-form-field (class)
• empty-item-predicate (generic function)
• empty-item-predicate (method)
• (setf empty-item-predicate) (method)
• (setf empty-item-predicate) (generic function)
• empty-value-p (function)
• field-add-to-path (generic function)
• field-add-to-path (method)
• field-choices (generic function)
• field-choices (method)
• (setf field-choices) (generic function)
• (setf field-choices) (method)
• field-choices-alist (generic function)
• field-choices-alist (method)
• field-constraints (generic function)
• field-constraints (method)
• (setf field-constraints) (method)
• (setf field-constraints) (generic function)
• field-default-value (generic function)
• field-default-value (method)
• (setf field-default-value) (method)
• (setf field-default-value) (generic function)
• field-disabled-p (generic function)
• field-disabled-p (method)
• (setf field-disabled-p) (method)
• (setf field-disabled-p) (generic function)
• field-expanded (generic function)
• field-expanded (method)
• (setf field-expanded) (method)
• (setf field-expanded) (generic function)
• field-form (generic function)
• field-form (method)
• (setf field-form) (method)
• (setf field-form) (generic function)
• field-hash-function (generic function)
• field-hash-function (method)
• (setf field-hash-function) (method)
• (setf field-hash-function) (generic function)
• field-help-text (generic function)
• field-help-text (method)
• (setf field-help-text) (method)
• (setf field-help-text) (generic function)
• field-invalid-message (generic function)
• field-invalid-message (method)
• (setf field-invalid-message) (method)
• (setf field-invalid-message) (generic function)
• field-key-and-value (generic function)
• field-key-and-value (method)
• field-key-reader (generic function)
• field-key-reader (method)
• (setf field-key-reader) (method)
• (setf field-key-reader) (generic function)
• field-keys-and-values (generic function)
• field-keys-and-values (method)
• field-label (generic function)
• field-label (method)
• (setf field-label) (method)
• (setf field-label) (generic function)
• field-multiple (generic function)
• field-multiple (method)
• (setf field-multiple) (method)
• (setf field-multiple) (generic function)
• field-name (generic function)
• field-name (method)
• (setf field-name) (method)
• (setf field-name) (generic function)
• field-placeholder (generic function)
• field-placeholder (method)
• (setf field-placeholder) (method)
• (setf field-placeholder) (generic function)
• field-preferred-choices (generic function)
• field-preferred-choices (method)
• (setf field-preferred-choices) (method)
• (setf field-preferred-choices) (generic function)
• field-read-from-request (generic function)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-from-request (method)
• field-read-only-p (generic function)
• field-read-only-p (method)
• (setf field-read-only-p) (method)
• (setf field-read-only-p) (generic function)
• field-render-label-p (generic function)
• field-render-label-p (method)
• field-render-label-p (method)
• field-render-label-p (method)
• field-request-name (function)
• field-required-message (generic function)
• field-required-message (method)
• (setf field-required-message) (method)
• (setf field-required-message) (generic function)
• field-required-p (generic function)
• field-required-p (method)
• field-required-p (method)
• (setf field-required-p) (method)
• (setf field-required-p) (generic function)
• field-subform (generic function)
• field-subform (method)
• field-subform-builder (generic function)
• field-subform-builder (method)
• (setf field-subform-builder) (method)
• (setf field-subform-builder) (generic function)
• field-subform-name (generic function)
• field-subform-name (method)
• (setf field-subform-name) (method)
• (setf field-subform-name) (generic function)
• field-test (generic function)
• field-test (method)
• (setf field-test) (method)
• (setf field-test) (generic function)
• field-trim-p (generic function)
• field-trim-p (method)
• (setf field-trim-p) (method)
• (setf field-trim-p) (generic function)
• field-validation-triggers (generic function)
• field-validation-triggers (method)
• (setf field-validation-triggers) (method)
• (setf field-validation-triggers) (generic function)
• field-validator (class)
• field-widget (generic function)
• field-widget (method)
• (setf field-widget) (method)
• field-widget (method)
• (setf field-widget) (method)
• (setf field-widget) (generic function)
• file-accept (generic function)
• file-accept (method)
• (setf file-accept) (method)
• (setf file-accept) (generic function)
• file-content-type (generic function)
• file-content-type (method)
• (setf file-content-type) (method)
• (setf file-content-type) (generic function)
• file-form-field (class)
• file-name (generic function)
• file-name (method)
• (setf file-name) (method)
• (setf file-name) (generic function)
• file-path (generic function)
• file-path (method)
• (setf file-path) (method)
• (setf file-path) (generic function)
• form (class)
• form-action (generic function)
• form-action (method)
• (setf form-action) (method)
• (setf form-action) (generic function)
• form-csrf-field-name (generic function)
• form-csrf-field-name (method)
• (setf form-csrf-field-name) (method)
• (setf form-csrf-field-name) (generic function)
• form-csrf-protection-p (generic function)
• form-csrf-protection-p (method)
• (setf form-csrf-protection-p) (method)
• (setf form-csrf-protection-p) (generic function)
• form-enctype (generic function)
• form-enctype (method)
• (setf form-enctype) (method)
• (setf form-enctype) (generic function)
• form-fields (generic function)
• form-fields (method)
• (setf form-fields) (method)
• (setf form-fields) (generic function)
• form-id (generic function)
• form-id (method)
• (setf form-id) (method)
• (setf form-id) (generic function)
• form-method (generic function)
• form-method (method)
• (setf form-method) (method)
• (setf form-method) (generic function)
• form-model (generic function)
• form-model (method)
• (setf form-model) (method)
• (setf form-model) (generic function)
• form-name (generic function)
• form-name (method)
• (setf form-name) (method)
• (setf form-name) (generic function)
• form-session-csrf-entry (generic function)
• form-session-csrf-entry (method)
• form-theme (class)
• get-form-session-csrf-token (generic function)
• get-form-session-csrf-token (method)
• hidden-form-field (class)
• integer-form-field (class)
• list-field-type (generic function)
• list-field-type (method)
• (setf list-field-type) (method)
• (setf list-field-type) (generic function)
• list-field-values (function)
• list-form-field (class)
• make-csrf-token (generic function)
• make-csrf-token (method)
• make-form (function)
• make-form-field (generic function)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-field (method)
• make-form-fields (function)
• multiple-p (generic function)
• multiple-p (method)
• (setf multiple-p) (method)
• (setf multiple-p) (generic function)
• password-form-field (class)
• post-parameters (function)
• remove-button-p (generic function)
• remove-button-p (method)
• (setf remove-button-p) (method)
• (setf remove-button-p) (generic function)
• render-field-request-name (function)
• renderer-render-field (generic function)
• renderer-render-field-errors (generic function)
• renderer-render-field-errors (method)
• renderer-render-field-label (generic function)
• renderer-render-field-widget (generic function)
• renderer-render-field-widget (method)
• renderer-render-field-widget (method)
• renderer-render-form (generic function)
• renderer-render-form-end (generic function)
• renderer-render-form-errors (generic function)
• renderer-render-form-errors (method)
• renderer-render-form-start (generic function)
• set-form-session-csrf-token (generic function)
• set-form-session-csrf-token (method)
• stateful-file-field (class)
• string-form-field (class)
• subform-builder (generic function)
• subform-builder (method)
• subform-form-field (class)
• submit-form-field (class)
• text-form-field (class)
• upload-handler (generic function)
• upload-handler (method)
• (setf upload-handler) (method)
• (setf upload-handler) (generic function)
• url-form-field (class)
• use-key-as-value (generic function)
• use-key-as-value (method)
• (setf use-key-as-value) (method)
• (setf use-key-as-value) (generic function)
• validate-form-field (generic function)
• validate-form-field (method)
• validate-form-field (method)
• validate-form-field (method)
• validate-form-field (method)
• validate-form-field (method)
• validate-form-field (method)
• validate-form-field (method)
• validate-form-field (method)
• validate-form-field (method)
• validator-field (generic function)
• validator-field (method)
• (setf validator-field) (method)
• (setf validator-field) (generic function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *base64-encode*

If T, encode form parameters in base64

Package

cl-forms

Source

cl-forms.lisp (file)

6.1.2 Macros

Macro: defform FORM-NAME ARGS FIELDS

Define a form at top-level

Package

cl-forms

Source

cl-forms.lisp (file)

Macro: defform-builder FORM-NAME ARGS &body BODY

Package

cl-forms

Source

cl-forms.lisp (file)

Macro: with-form FORM &body BODY

Package

cl-forms

Source

cl-forms.lisp (file)

Macro: with-form-field-values FIELDS FORM &body BODY

Package

cl-forms

Source

cl-forms.lisp (file)

Macro: with-form-fields FIELDS FORM &body BODY

Package

cl-forms

Source

cl-forms.lisp (file)

Macro: with-form-renderer RENDERER &body BODY

Package

cl-forms

Source

cl-forms.lisp (file)

Macro: with-form-template (&optional FORM-VAR) FORM-NAME ARGS &body BODY

Package

cl-forms

Source

cl-forms.lisp (file)

Macro: with-form-theme FORM-THEME &body BODY

Package

cl-forms

Source

cl-forms.lisp (file)

6.1.3 Functions

Function: add-field FORM FIELD

Package

cl-forms

Source

cl-forms.lisp (file)

Function: add-form-error FIELD ERROR-MSG &optional FORM

Add an error on FIELD

Package

cl-forms

Source

cl-forms.lisp (file)

Function: fill-form-from-model FORM MODEL

Fill a FORM from a MODEL

Package

cl-forms

Source

cl-forms.lisp (file)

Function: fill-model-from-form FORM MODEL

Set a MODEL’s values from FORM field values

Package

cl-forms

Source

cl-forms.lisp (file)

Function: form-valid-p FORM

Package

cl-forms

Source

cl-forms.lisp (file)

Function: format-field-value-to-string FORM-FIELD &optional FIELD-VALUE

Package

cl-forms

Source

cl-forms.lisp (file)

Function: get-field FORM FIELD-NAME &optional ERROR-P

Package

cl-forms

Source

cl-forms.lisp (file)

Function: get-field-value FORM FIELD-NAME &optional ERROR-P

Package

cl-forms

Source

cl-forms.lisp (file)

Function: get-form NAME &rest ARGS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: handle-request &optional FORM

Package

cl-forms

Source

cl-forms.lisp (file)

Function: make-formatter SYMBOL

Create a field formatter. SYMBOL is the function to call.

Package

cl-forms

Source

cl-forms.lisp (file)

Function: remove-field FORM FIELD

Package

cl-forms

Source

cl-forms.lisp (file)

Function: render-field FIELD &optional FORM &rest ARGS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: render-field-errors FIELD &optional FORM &rest ARGS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: render-field-label FIELD &optional FORM &rest ARGS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: render-field-widget FIELD &optional FORM &rest ARGS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: render-form &optional FORM &rest ARGS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: render-form-end &optional FORM

Package

cl-forms

Source

cl-forms.lisp (file)

Function: render-form-errors &optional FORM &rest ARGS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: render-form-start &optional FORM &rest ARGS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: set-field-value FORM FIELD-NAME VALUE

Package

cl-forms

Source

cl-forms.lisp (file)

Function: validate-form &optional FORM

Package

cl-forms

Source

cl-forms.lisp (file)

6.1.4 Generic functions

Generic Function: field-accessor OBJECT

Generic Function: (setf field-accessor) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-accessor (FORM-FIELD form-field)

Method: (setf field-accessor) NEW-VALUE (FORM-FIELD form-field)

The field accessor to the underlying model

Source

cl-forms.lisp (file)

Generic Function: field-formatter OBJECT

Generic Function: (setf field-formatter) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-formatter (FORM-FIELD form-field)

Method: (setf field-formatter) NEW-VALUE (FORM-FIELD form-field)

The field formatter. The function takes two arguments, a VALUE and STREAM to format it into.

Source

cl-forms.lisp (file)

Generic Function: field-parser OBJECT

Generic Function: (setf field-parser) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-parser (FORM-FIELD form-field)

Method: (setf field-parser) NEW-VALUE (FORM-FIELD form-field)

Custom field value parser

Source

cl-forms.lisp (file)

Generic Function: field-reader FIELD

Package

cl-forms

Methods

Method: field-reader (FIELD form-field)

Source

cl-forms.lisp (file)

Generic Function: field-valid-p FORM-FIELD &optional FORM

Package

cl-forms

Methods

Method: field-valid-p (FORM-FIELD form-field) &optional FORM

Determines if a field is valid. This method assumes the form has already been validated via validate-form.

Source

cl-forms.lisp (file)

Generic Function: field-value FIELD

Generic Function: (setf field-value) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-value (FIELD form-field) around

Source

cl-forms.lisp (file)

Method: field-value (FIELD form-field)

Source

cl-forms.lisp (file)

Method: (setf field-value) VALUE (FIELD form-field)

Source

cl-forms.lisp (file)

Generic Function: field-writer FIELD

Package

cl-forms

Methods

Method: field-writer (FIELD form-field)

Source

cl-forms.lisp (file)

Generic Function: form-errors OBJECT

Generic Function: (setf form-errors) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: form-errors (FORM form)

Method: (setf form-errors) NEW-VALUE (FORM form)

Form errors after validation

Source

cl-forms.lisp (file)

Generic Function: format-field-value FORM-FIELD FIELD-VALUE &optional STREAM

Package

cl-forms

Source

cl-forms.lisp (file)

Methods

Method: format-field-value (FIELD datetime-form-field) VALUE &optional STREAM

Source

datetime.lisp (file)

Method: format-field-value (FIELD date-form-field) VALUE &optional STREAM

Source

date.lisp (file)

Method: format-field-value (FIELD boolean-form-field) VALUE &optional STREAM

Source

boolean.lisp (file)

Method: format-field-value (FORM-FIELD form-field) FIELD-VALUE &optional STREAM

Method: format-field-value (FORM-FIELD form-field) FIELD-VALUE &optional STREAM around

6.1.5 Classes

Class: form-field ()

A form field

Package

cl-forms

Source

cl-forms.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• string-form-field (class)
• boolean-form-field (class)
• email-form-field (class)
• password-form-field (class)
• url-form-field (class)
• integer-form-field (class)
• choice-form-field (class)
• date-form-field (class)
• datetime-form-field (class)
• file-form-field (class)
• hidden-form-field (class)
• submit-form-field (class)
• subform-form-field (class)
• list-form-field (class)

Direct methods

• format-field-value (method)
• format-field-value (method)
• field-valid-p (method)
• validate-form-field (method)
• validate-form-field (method)
• (setf field-value) (method)
• field-value (method)
• field-value (method)
• field-writer (method)
• field-reader (method)
• field-render-label-p (method)
• print-object (method)
• field-form (method)
• field-form (method)
• field-validation-triggers (method)
• field-validation-triggers (method)
• field-trim-p (method)
• field-trim-p (method)
• field-accessor (method)
• field-accessor (method)
• field-disabled-p (method)
• field-disabled-p (method)
• field-read-only-p (method)
• field-read-only-p (method)
• field-invalid-message (method)
• field-invalid-message (method)
• field-required-message (method)
• field-required-message (method)
• field-required-p (method)
• field-required-p (method)
• field-constraints (method)
• field-constraints (method)
• field-formatter (method)
• field-formatter (method)
• field-parser (method)
• field-parser (method)
• field-help-text (method)
• field-help-text (method)
• field-placeholder (method)
• field-placeholder (method)
• field-default-value (method)
• field-default-value (method)
• field-label (method)
• field-label (method)
• field-name (method)
• field-name (method)

Direct slots

Slot: name

The field name

Type

symbol

Initargs

:name

Initform

(error "provide the field name")

Readers

field-name (generic function)

Writers

(setf field-name) (generic function)

Slot: label

The field label

Type

(or null string)

Initargs

:label

Readers

field-label (generic function)

Writers

(setf field-label) (generic function)

Slot: value

Field value

Initargs

:value

Writers

(setf field-value) (generic function)

Slot: default-value

Value to use when the field value is nil

Initargs

:default-value

Readers

field-default-value (generic function)

Writers

(setf field-default-value) (generic function)

Slot: placeholder

Field placeholder (text that appears when the field is empty)

Type

(or null string)

Initargs

:placeholder

Readers

field-placeholder (generic function)

Writers

(setf field-placeholder) (generic function)

Slot: help-text

Field help text

Type

(or null string)

Initargs

:help-text

Readers

field-help-text (generic function)

Writers

(setf field-help-text) (generic function)

Slot: parser

Custom field value parser

Type

(or null symbol function)

Initargs

:parser

Readers

field-parser (generic function)

Writers

(setf field-parser) (generic function)

Slot: formatter

The field formatter. The function takes two arguments, a VALUE and STREAM to format it into.

Type

(or null symbol function)

Initargs

:formatter

Readers

field-formatter (generic function)

Writers

(setf field-formatter) (generic function)

Slot: constraints

The field constraints

Initargs

:constraints

Readers

field-constraints (generic function)

Writers

(setf field-constraints) (generic function)

Slot: required

Whether the field is required

Type

boolean

Initargs

:required-p

Initform

t

Readers

field-required-p (generic function)

Writers

(setf field-required-p) (generic function)

Slot: required-message

Message to display when field is required

Type

(or null string)

Initargs

:required-message

Initform

cl-forms::*field-required-message*

Readers

field-required-message (generic function)

Writers

(setf field-required-message) (generic function)

Slot: invalid-message

Message to display when field is invalid

Type

(or null string function)

Initargs

:invalid-message

Readers

field-invalid-message (generic function)

Writers

(setf field-invalid-message) (generic function)

Slot: read-only

Whether the field is read only

Type

boolean

Initargs

:read-only-p

Readers

field-read-only-p (generic function)

Writers

(setf field-read-only-p) (generic function)

Slot: disabled

Whether the field is disabled

Type

boolean

Initargs

:disabled-p

Readers

field-disabled-p (generic function)

Writers

(setf field-disabled-p) (generic function)

Slot: accessor

The field accessor to the underlying model

Type

(or null symbol)

Initargs

:accessor

Readers

field-accessor (generic function)

Writers

(setf field-accessor) (generic function)

Slot: reader

The function to use to read from the underlying model

Type

(or null symbol function)

Initargs

:reader

Slot: writer

The function to use to write to underlying model

Type

(or null symbol function)

Initargs

:writer

Slot: trim

Trim the input

Type

boolean

Initargs

:trim-p

Initform

t

Readers

field-trim-p (generic function)

Writers

(setf field-trim-p) (generic function)

Slot: validation-triggers

Client side validation triggers. A list of :change, :focus, :focusout, :focusin, etc

Initargs

:validation-triggers

Readers

field-validation-triggers (generic function)

Writers

(setf field-validation-triggers) (generic function)

Slot: form

The form the field belongs to

Type

(or null cl-forms::form)

Initargs

:form

Readers

field-form (generic function)

Writers

(setf field-form) (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *default-form-renderer*

Package

cl-forms

Source

cl-forms.lisp (file)

Special Variable: *field-path*

Package

cl-forms

Source

cl-forms.lisp (file)

Special Variable: *field-required-message*

Package

cl-forms

Source

cl-forms.lisp (file)

Special Variable: *form*

The current form

Package

cl-forms

Source

cl-forms.lisp (file)

Special Variable: *form-renderer*

Package

cl-forms

Source

cl-forms.lisp (file)

Special Variable: *form-theme*

Package

cl-forms

Source

specials.lisp (file)

Special Variable: +default-date-format+

Package

cl-forms

Source

date.lisp (file)

Special Variable: +default-datetime-format+

Package

cl-forms

Source

datetime.lisp (file)

6.2.2 Functions

Function: %collect-replace-fields FORM COLLECT-FIELD

Package

cl-forms

Source

cl-forms.lisp (file)

Function: alistp ALIST

Package

cl-forms

Source

choice.lisp (file)

Function: call-with-form FORM FUNCTION

Package

cl-forms

Source

cl-forms.lisp (file)

Function: call-with-form-theme FORM-THEME FUNCTION

Package

cl-forms

Source

cl-forms.lisp (file)

Function: check-duplicate-fields FIELDS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: collect-replace-fields FORM

Package

cl-forms

Source

cl-forms.lisp (file)

Function: empty-value-p VAL

Package

cl-forms

Source

cl-forms.lisp (file)

Function: field-request-name FORM-FIELD FORM

Package

cl-forms

Source

cl-forms.lisp (file)

Function: list-field-values LIST-FIELD

Returns the actual values of a list field

Package

cl-forms

Source

list.lisp (file)

Function: make-form NAME FIELDS &rest OPTIONS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: make-form-fields FIELDS

Package

cl-forms

Source

cl-forms.lisp (file)

Function: post-parameters &optional REQUEST

Package

cl-forms

Source

cl-forms.lisp (file)

Function: render-field-request-name FORM-FIELD FORM

Package

cl-forms

Source

cl-forms.lisp (file)

6.2.3 Generic functions

Generic Function: add-button-p OBJECT

Generic Function: (setf add-button-p) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: add-button-p (LIST-FORM-FIELD list-form-field)

Method: (setf add-button-p) NEW-VALUE (LIST-FORM-FIELD list-form-field)

Whether have a list ’ADD’ button or not

Source

list.lisp (file)

Generic Function: call-with-form-renderer RENDERER FUNCTION

Package

cl-forms

Methods

Method: call-with-form-renderer RENDERER FUNCTION

Source

cl-forms.lisp (file)

Generic Function: client-validation OBJECT

Generic Function: (setf client-validation) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: client-validation (FORM form)

Method: (setf client-validation) NEW-VALUE (FORM form)

When T, form client validation is enabled

Source

cl-forms.lisp (file)

Generic Function: date-format OBJECT

Generic Function: (setf date-format) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: date-format (DATE-VALIDATOR date-validator)

automatically generated reader method

Source

date.lisp (file)

Method: (setf date-format) NEW-VALUE (DATE-VALIDATOR date-validator)

automatically generated writer method

Source

date.lisp (file)

Method: date-format (DATE-FORM-FIELD date-form-field)

automatically generated reader method

Source

date.lisp (file)

Method: (setf date-format) NEW-VALUE (DATE-FORM-FIELD date-form-field)

automatically generated writer method

Source

date.lisp (file)

Generic Function: date-max OBJECT

Generic Function: (setf date-max) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: date-max (DATE-FORM-FIELD date-form-field)

automatically generated reader method

Source

date.lisp (file)

Method: (setf date-max) NEW-VALUE (DATE-FORM-FIELD date-form-field)

automatically generated writer method

Source

date.lisp (file)

Generic Function: date-min OBJECT

Generic Function: (setf date-min) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: date-min (DATE-FORM-FIELD date-form-field)

automatically generated reader method

Source

date.lisp (file)

Method: (setf date-min) NEW-VALUE (DATE-FORM-FIELD date-form-field)

automatically generated writer method

Source

date.lisp (file)

Generic Function: datetime-format OBJECT

Generic Function: (setf datetime-format) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: datetime-format (DATETIME-VALIDATOR datetime-validator)

automatically generated reader method

Source

datetime.lisp (file)

Method: (setf datetime-format) NEW-VALUE (DATETIME-VALIDATOR datetime-validator)

automatically generated writer method

Source

datetime.lisp (file)

Method: datetime-format (DATETIME-FORM-FIELD datetime-form-field)

automatically generated reader method

Source

datetime.lisp (file)

Method: (setf datetime-format) NEW-VALUE (DATETIME-FORM-FIELD datetime-form-field)

automatically generated writer method

Source

datetime.lisp (file)

Generic Function: datetime-max OBJECT

Generic Function: (setf datetime-max) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: datetime-max (DATETIME-FORM-FIELD datetime-form-field)

automatically generated reader method

Source

datetime.lisp (file)

Method: (setf datetime-max) NEW-VALUE (DATETIME-FORM-FIELD datetime-form-field)

automatically generated writer method

Source

datetime.lisp (file)

Generic Function: datetime-min OBJECT

Generic Function: (setf datetime-min) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: datetime-min (DATETIME-FORM-FIELD datetime-form-field)

automatically generated reader method

Source

datetime.lisp (file)

Method: (setf datetime-min) NEW-VALUE (DATETIME-FORM-FIELD datetime-form-field)

automatically generated writer method

Source

datetime.lisp (file)

Generic Function: display-errors OBJECT

Generic Function: (setf display-errors) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: display-errors (FORM form)

Method: (setf display-errors) NEW-VALUE (FORM form)

A list containing the places where to display errors. Valid options are :list and :inline

Source

cl-forms.lisp (file)

Generic Function: download-link FIELD

Package

cl-forms

Methods

Method: download-link (FIELD stateful-file-field)

Source

file.lisp (file)

Generic Function: empty-item-predicate OBJECT

Generic Function: (setf empty-item-predicate) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: empty-item-predicate (LIST-FORM-FIELD list-form-field)

Method: (setf empty-item-predicate) NEW-VALUE (LIST-FORM-FIELD list-form-field)

A predicate that tells when a list item is considered empty, and so it is removed from the list

Source

list.lisp (file)

Generic Function: field-add-to-path FORM-FIELD FORM &optional PATH

Package

cl-forms

Source

cl-forms.lisp (file)

Methods

Method: field-add-to-path FORM-FIELD FORM &optional PATH

Generic Function: field-choices FIELD

Generic Function: (setf field-choices) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-choices (FIELD choice-form-field)

Source

choice.lisp (file)

Method: (setf field-choices) NEW-VALUE (CHOICE-FORM-FIELD choice-form-field)

An alist with the choices. Or a function with which to obtain the choices.

Source

choice.lisp (file)

Generic Function: field-choices-alist FIELD

Package

cl-forms

Methods

Method: field-choices-alist (FIELD choice-form-field)

Source

choice.lisp (file)

Generic Function: field-constraints OBJECT

Generic Function: (setf field-constraints) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-constraints (FORM-FIELD form-field)

Method: (setf field-constraints) NEW-VALUE (FORM-FIELD form-field)

The field constraints

Source

cl-forms.lisp (file)

Generic Function: field-default-value OBJECT

Generic Function: (setf field-default-value) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-default-value (FORM-FIELD form-field)

Method: (setf field-default-value) NEW-VALUE (FORM-FIELD form-field)

Value to use when the field value is nil

Source

cl-forms.lisp (file)

Generic Function: field-disabled-p OBJECT

Generic Function: (setf field-disabled-p) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-disabled-p (FORM-FIELD form-field)

Method: (setf field-disabled-p) NEW-VALUE (FORM-FIELD form-field)

Whether the field is disabled

Source

cl-forms.lisp (file)

Generic Function: field-expanded OBJECT

Generic Function: (setf field-expanded) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-expanded (CHOICE-FORM-FIELD choice-form-field)

Method: (setf field-expanded) NEW-VALUE (CHOICE-FORM-FIELD choice-form-field)

If set to true, radio buttons or checkboxes will be rendered (depending on the multiple value). If false, a select element will be rendered.

Source

choice.lisp (file)

Generic Function: field-form OBJECT

Generic Function: (setf field-form) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-form (FORM-FIELD form-field)

Method: (setf field-form) NEW-VALUE (FORM-FIELD form-field)

The form the field belongs to

Source

cl-forms.lisp (file)

Generic Function: field-hash-function OBJECT

Generic Function: (setf field-hash-function) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-hash-function (CHOICE-FORM-FIELD choice-form-field)

Method: (setf field-hash-function) NEW-VALUE (CHOICE-FORM-FIELD choice-form-field)

The function to use for choices key

Source

choice.lisp (file)

Generic Function: field-help-text OBJECT

Generic Function: (setf field-help-text) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-help-text (FORM-FIELD form-field)

Method: (setf field-help-text) NEW-VALUE (FORM-FIELD form-field)

Field help text

Source

cl-forms.lisp (file)

Generic Function: field-invalid-message OBJECT

Generic Function: (setf field-invalid-message) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-invalid-message (FORM-FIELD form-field)

Method: (setf field-invalid-message) NEW-VALUE (FORM-FIELD form-field)

Message to display when field is invalid

Source

cl-forms.lisp (file)

Generic Function: field-key-and-value FIELD

Package

cl-forms

Methods

Method: field-key-and-value (FIELD choice-form-field)

Source

choice.lisp (file)

Generic Function: field-key-reader OBJECT

Generic Function: (setf field-key-reader) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-key-reader (CHOICE-FORM-FIELD choice-form-field)

Method: (setf field-key-reader) NEW-VALUE (CHOICE-FORM-FIELD choice-form-field)

Function to read the option key from the request

Source

choice.lisp (file)

Generic Function: field-keys-and-values FIELD

Package

cl-forms

Methods

Method: field-keys-and-values (FIELD choice-form-field)

Source

choice.lisp (file)

Generic Function: field-label OBJECT

Generic Function: (setf field-label) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-label (FORM-FIELD form-field)

Method: (setf field-label) NEW-VALUE (FORM-FIELD form-field)

The field label

Source

cl-forms.lisp (file)

Generic Function: field-multiple OBJECT

Generic Function: (setf field-multiple) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-multiple (CHOICE-FORM-FIELD choice-form-field)

Method: (setf field-multiple) NEW-VALUE (CHOICE-FORM-FIELD choice-form-field)

If true, the user will be able to select multiple options (as opposed to choosing just one option). Depending on the value of the expanded option, this will render either a select tag or checkboxes if true and a select tag or radio buttons if false.

Source

choice.lisp (file)

Generic Function: field-name OBJECT

Generic Function: (setf field-name) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-name (FORM-FIELD form-field)

Method: (setf field-name) NEW-VALUE (FORM-FIELD form-field)

The field name

Source

cl-forms.lisp (file)

Generic Function: field-placeholder OBJECT

Generic Function: (setf field-placeholder) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-placeholder (FORM-FIELD form-field)

Method: (setf field-placeholder) NEW-VALUE (FORM-FIELD form-field)

Field placeholder (text that appears when the field is empty)

Source

cl-forms.lisp (file)

Generic Function: field-preferred-choices OBJECT

Generic Function: (setf field-preferred-choices) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-preferred-choices (CHOICE-FORM-FIELD choice-form-field)

Method: (setf field-preferred-choices) NEW-VALUE (CHOICE-FORM-FIELD choice-form-field)

If this option is specified, then a sub-set of all of the options will be moved to the top of the select menu.

Source

choice.lisp (file)

Generic Function: field-read-from-request FIELD FORM PARAMETERS

Package

cl-forms

Source

cl-forms.lisp (file)

Methods

Method: field-read-from-request (FIELD list-form-field) FORM PARAMETERS

Source

list.lisp (file)

Method: field-read-from-request (FIELD subform-form-field) FORM PARAMETERS

Source

subform.lisp (file)

Method: field-read-from-request (FIELD submit-form-field) FORM PARAMETERS

Source

submit.lisp (file)

Method: field-read-from-request (FIELD hidden-form-field) FORM PARAMETERS

Source

hidden.lisp (file)

Method: field-read-from-request (FIELD stateful-file-field) FORM PARAMETERS

Source

file.lisp (file)

Method: field-read-from-request (FIELD file-form-field) FORM PARAMETERS

Source

file.lisp (file)

Method: field-read-from-request (FIELD datetime-form-field) FORM PARAMETERS

Source

datetime.lisp (file)

Method: field-read-from-request (FIELD date-form-field) FORM PARAMETERS

Source

date.lisp (file)

Method: field-read-from-request (FIELD choice-form-field) FORM PARAMETERS

Source

choice.lisp (file)

Method: field-read-from-request (FIELD integer-form-field) FORM PARAMETERS

Source

integer.lisp (file)

Method: field-read-from-request (FIELD url-form-field) FORM PARAMETERS

Source

url.lisp (file)

Method: field-read-from-request (FIELD password-form-field) FORM PARAMETERS

Source

password.lisp (file)

Method: field-read-from-request (FIELD email-form-field) FORM PARAMETERS

Source

email.lisp (file)

Method: field-read-from-request (FIELD boolean-form-field) FORM PARAMETERS

Source

boolean.lisp (file)

Method: field-read-from-request (FIELD string-form-field) FORM PARAMETERS

Source

string.lisp (file)

Method: field-read-from-request FIELD FORM PARAMETERS after

Use the parser function after reading the value from the request

Method: field-read-from-request FIELD FORM PARAMETERS around

Generic Function: field-read-only-p OBJECT

Generic Function: (setf field-read-only-p) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-read-only-p (FORM-FIELD form-field)

Method: (setf field-read-only-p) NEW-VALUE (FORM-FIELD form-field)

Whether the field is read only

Source

cl-forms.lisp (file)

Generic Function: field-render-label-p FIELD

Package

cl-forms

Methods

Method: field-render-label-p (FIELD submit-form-field)

Source

submit.lisp (file)

Method: field-render-label-p (FIELD hidden-form-field)

Source

hidden.lisp (file)

Method: field-render-label-p (FIELD form-field)

Source

cl-forms.lisp (file)

Generic Function: field-required-message OBJECT

Generic Function: (setf field-required-message) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-required-message (FORM-FIELD form-field)

Method: (setf field-required-message) NEW-VALUE (FORM-FIELD form-field)

Message to display when field is required

Source

cl-forms.lisp (file)

Generic Function: field-required-p OBJECT

Generic Function: (setf field-required-p) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-required-p (FORM-FIELD boolean-form-field)

Source

boolean.lisp (file)

Method: field-required-p (FORM-FIELD form-field)

Method: (setf field-required-p) NEW-VALUE (FORM-FIELD form-field)

Whether the field is required

Source

cl-forms.lisp (file)

Generic Function: field-subform FIELD

Package

cl-forms

Methods

Method: field-subform (FIELD subform-form-field)

Source

subform.lisp (file)

Generic Function: field-subform-builder OBJECT

Generic Function: (setf field-subform-builder) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-subform-builder (SUBFORM-FORM-FIELD subform-form-field)

automatically generated reader method

Source

subform.lisp (file)

Method: (setf field-subform-builder) NEW-VALUE (SUBFORM-FORM-FIELD subform-form-field)

automatically generated writer method

Source

subform.lisp (file)

Generic Function: field-subform-name OBJECT

Generic Function: (setf field-subform-name) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-subform-name (SUBFORM-FORM-FIELD subform-form-field)

automatically generated reader method

Source

subform.lisp (file)

Method: (setf field-subform-name) NEW-VALUE (SUBFORM-FORM-FIELD subform-form-field)

automatically generated writer method

Source

subform.lisp (file)

Generic Function: field-test OBJECT

Generic Function: (setf field-test) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-test (CHOICE-FORM-FIELD choice-form-field)

Method: (setf field-test) NEW-VALUE (CHOICE-FORM-FIELD choice-form-field)

Function to test equality between choices

Source

choice.lisp (file)

Generic Function: field-trim-p OBJECT

Generic Function: (setf field-trim-p) NEW-VALUE OBJECT

Package

cl-forms

Methods

Method: field-trim-p (FORM-FIELD form-field)

Method: (setf field-trim-p) NEW-VALUE (FORM-FIELD form-field)

Trim the input

Source

cl-forms.lisp (file)