From b35f364a7cc18ad7f2e8d70e6c788914f6e550f5 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 4 Mar 2024 20:02:18 +0000 Subject: [PATCH] Update docs --- README.md | 90 +++++++++++++++++++++++++++---------------------------- 1 file changed, 45 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 94b3b08..1a9357c 100644 --- a/README.md +++ b/README.md @@ -73,19 +73,19 @@ Go to [HTML documentation](https://40ants.com/reblocks-ui/) to see this code in -#### [class](fed0) `reblocks-ui/core:ui-widget` (widget) +#### [class](2063) `reblocks-ui/core:ui-widget` (widget) Use this class as a parent for all widgets, who use `UI`. -#### [class](8d93) `reblocks-ui/core:widget` (ui-widget) +#### [class](7f64) `reblocks-ui/core:widget` (ui-widget) Use this class as a parent for all widgets, who use `UI`. Warning: 'widget' was renamed to 'ui-widget' and will be removed after 2020-06-01. -#### [variable](a4cd) `reblocks-ui/core:*foundation-dependencies*` (# +#### [variable](25ad) `reblocks-ui/core:*foundation-dependencies*` (# # #) @@ -247,7 +247,7 @@ Go to [HTML documentation](https://40ants.com/reblocks-ui/) to see this code in -#### [macro](8b01) `reblocks-ui/form:with-html-form` (METHOD-TYPE ACTION &KEY ID CLASS ENCTYPE (USE-AJAX-P T) EXTRA-SUBMIT-CODE REQUIRES-CONFIRMATION-P (CONFIRM-QUESTION "Are you sure?") (SUBMIT-FN "initiateFormAction(\"~A\", $(this), \"~A\")")) &BODY BODY +#### [macro](fe67) `reblocks-ui/form:with-html-form` (METHOD-TYPE ACTION &KEY ID CLASS ENCTYPE (USE-AJAX-P T) EXTRA-SUBMIT-CODE REQUIRES-CONFIRMATION-P (CONFIRM-QUESTION "Are you sure?") (SUBMIT-FN "initiateFormAction(\"~A\", $(this), \"~A\")")) &BODY BODY Wraps a body with (:form ...) using [`reblocks/html:with-html`][f21e]. @@ -269,17 +269,17 @@ Wraps a body with (:form ...) using [`reblocks/html:with-html`][f21e]. -#### [class](fed0) `reblocks-ui/core:ui-widget` (widget) +#### [class](2063) `reblocks-ui/core:ui-widget` (widget) Use this class as a parent for all widgets, who use `UI`. -#### [class](d9e9) `reblocks-ui/form:error-placeholder` (widget) +#### [class](7204) `reblocks-ui/form:error-placeholder` (widget) -#### [function](d12e) `reblocks-ui/form:error-placeholder` name &key (widget-class 'error-placeholder) +#### [function](f24c) `reblocks-ui/form:error-placeholder` name &key (widget-class 'error-placeholder) This function creates and renders a widget to show an error message related to some form field. @@ -291,7 +291,7 @@ to the [`field-error`][5162] function. -#### [function](daaf) `reblocks-ui/form:form-error-placeholder` &key (widget-class 'form-error-placeholder) +#### [function](0070) `reblocks-ui/form:form-error-placeholder` &key (widget-class 'form-error-placeholder) This function creates and renders a widget to show an error for the whole form. @@ -301,11 +301,11 @@ Later, you can call [`form-error`][ea04] function to signal an error from the ac -#### [condition](4873) `reblocks-ui/form:field-error` (form-error) +#### [condition](360d) `reblocks-ui/form:field-error` (form-error) -#### [function](bfc1) `reblocks-ui/form:field-error` name message +#### [function](d9c6) `reblocks-ui/form:field-error` name message Signals an error which will be shown for the whole form.lisp @@ -319,11 +319,11 @@ then error message can be shown for the whole form in a place where -#### [condition](4b55) `reblocks-ui/form:form-error` (error) +#### [condition](565b) `reblocks-ui/form:form-error` (error) -#### [function](3a47) `reblocks-ui/form:form-error` message +#### [function](a533) `reblocks-ui/form:form-error` message Signals an error which will be shown for the whole form.lisp @@ -333,7 +333,7 @@ will be logged and ignored. -#### [function](1f14) `reblocks-ui/form:get-field-errors-count` +#### [function](2625) `reblocks-ui/form:get-field-errors-count` Returns total number of errors, reported by [`field-error`][5162] function. @@ -342,13 +342,13 @@ the result is not zero. -#### [function](ae5e) `reblocks-ui/form:get-field-errors` field-name +#### [function](ae38) `reblocks-ui/form:get-field-errors` field-name Returns all errors, reported for the field with name given in `FIELD-NAME`. -#### [function](f0e4) `reblocks-ui/form:render-button` NAME &KEY (VALUE (HUMANIZE-NAME NAME)) ID (CLASS "button") (ONCLICK "disableIrrelevantButtons(this);") DISABLEDP +#### [function](45e8) `reblocks-ui/form:render-button` NAME &KEY (VALUE (HUMANIZE-NAME NAME)) ID (CLASS "button") (ONCLICK "disableIrrelevantButtons(this);") DISABLEDP Renders a button in a form. @@ -361,14 +361,14 @@ Renders a button in a form. -#### [function](d54d) `reblocks-ui/form:render-form-and-button` NAME ACTION &KEY (VALUE (HUMANIZE-NAME NAME)) (METHOD :GET) BUTTON-ID (BUTTON-CLASS "button") (USE-AJAX-P T) FORM-ID FORM-CLASS +#### [function](14e2) `reblocks-ui/form:render-form-and-button` NAME ACTION &KEY (VALUE (HUMANIZE-NAME NAME)) (METHOD :GET) BUTTON-ID (BUTTON-CLASS "button") (USE-AJAX-P T) FORM-ID FORM-CLASS Renders a button within a form. This function can be used a short cut to quickly render a sumbit button. -#### [function](3cf9) `reblocks-ui/form:render-link` action label &key (ajaxp t) id class title render-fn +#### [function](c49f) `reblocks-ui/form:render-link` action label &key (ajaxp t) id class title render-fn Renders an action into a href link. If `AJAXP` is true (the default), the link will be rendered in such a way that the action will @@ -389,7 +389,7 @@ bot, crawling the internet will hit this action with `GET` request. -#### [function](84a1) `reblocks-ui/form:render-textarea` name &key (label (humanize-name name)) value id class disabledp +#### [function](393b) `reblocks-ui/form:render-textarea` name &key (label (humanize-name name)) value id class disabledp Renders a textarea. @@ -406,7 +406,7 @@ Renders a textarea. -### [class](c9f7) `reblocks-ui/popup:popup-widget` (ui-widget) +### [class](9a76) `reblocks-ui/popup:popup-widget` (ui-widget) This widgets shows a popup window. @@ -417,19 +417,19 @@ and call [`show-popup`][5ada] generic function. -### [generic-function](f7e0) `reblocks-ui/popup:show-popup` widget +### [generic-function](eeec) `reblocks-ui/popup:show-popup` widget Shows popup window. -### [generic-function](bb41) `reblocks-ui/popup:hide-popup` widget +### [generic-function](2b5a) `reblocks-ui/popup:hide-popup` widget Hides popup window. -### [generic-function](25ed) `reblocks-ui/popup:render-popup-content` widget +### [generic-function](16a1) `reblocks-ui/popup:render-popup-content` widget Renders inner `HTML` for popup window. You need to define a method for this generic function @@ -437,7 +437,7 @@ and specialize it for your own class. -### [accessor](b484) `reblocks-ui/popup:visible-p` (popup-widget) (= nil) +### [accessor](7f99) `reblocks-ui/popup:visible-p` (popup-widget) (= nil) [233f]: https://40ants.com/reblocks-ui/ @@ -457,28 +457,28 @@ and specialize it for your own class. [4fd9]: https://foundation.zurb.com/ [5ce9]: https://get.foundation/sites/docs/reveal.html [1818]: https://github.com/40ants/reblocks-ui -[fed0]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/core.lisp#L28 -[8d93]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/core.lisp#L32 -[a4cd]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/core.lisp#L42 -[1f14]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L149 -[ae5e]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L160 -[d9e9]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L277 -[d12e]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L310 -[daaf]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L327 -[8b01]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L368 -[f0e4]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L422 -[4b55]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L45 -[3cf9]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L481 -[d54d]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L517 -[4873]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L53 -[84a1]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L533 -[bfc1]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L62 -[3a47]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/form.lisp#L78 -[c9f7]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/popup.lisp#L15 -[b484]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/popup.lisp#L16 -[f7e0]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/popup.lisp#L26 -[bb41]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/popup.lisp#L33 -[25ed]: https://github.com/40ants/reblocks-ui/blob/a9dbaceefa01aa5563f1f34e27c78e878d7942a8/src/popup.lisp#L47 +[2063]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/core.lisp#L28 +[7f64]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/core.lisp#L32 +[25ad]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/core.lisp#L42 +[2625]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L149 +[ae38]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L160 +[7204]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L277 +[f24c]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L310 +[0070]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L327 +[fe67]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L368 +[45e8]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L422 +[565b]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L45 +[c49f]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L481 +[14e2]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L517 +[360d]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L53 +[393b]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L533 +[d9c6]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L62 +[a533]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/form.lisp#L78 +[9a76]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/popup.lisp#L15 +[7f99]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/popup.lisp#L16 +[eeec]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/popup.lisp#L26 +[2b5a]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/popup.lisp#L33 +[16a1]: https://github.com/40ants/reblocks-ui/blob/1021a51db1fe0689160fea83c1ca24e1fe08ac85/src/popup.lisp#L47 [2c00]: https://quickdocs.org/40ants-doc [7f8b]: https://quickdocs.org/log4cl [691c]: https://quickdocs.org/log4cl-extras