dev.metalisp.sbt/src/component/spinner.lisp

;; https://getbootstrap.com/docs/5.3/components/spinners/

;; Bootstrap Spinners are versatile components used to indicate a loading state
;; in a variety of scenarios. They can be displayed when the user initiates an
;; action that requires some time to process, such as submitting a form or
;; loading data. They help inform the user that something is happening behind
;; the scenes.

;; Spinners are available in two styles: Border and Grow. The Border style is a
;; rotating border, while the Grow style is a shape that continuously grows and
;; shrinks.

;; Bootstrap allows customization of spinners through CSS classes. You can
;; change the color of the spinner to 'primary', 'secondary', 'success',
;; 'danger', 'warning', 'info', 'light', 'dark'. You can also control the size
;; of the spinner through size classes.

(defpackage cl-sbt-spinner
  (:use :cl)
  (:export
   :spinner
   :spinner-border-primary
   :spinner-border-secondary
   :spinner-border-success
   :spinner-border-danger
   :spinner-border-warning
   :spinner-border-info
   :spinner-border-warning
   :spinner-border-light
   :spinner-border-dark
   :spinner-grow-primary
   :spinner-grow-secondary
   :spinner-grow-success
   :spinner-grow-danger
   :spinner-grow-warning
   :spinner-grow-info
   :spinner-grow-warning
   :spinner-grow-light
   :spinner-grow-dark)
  (:documentation "This package provides a set of macros to generate Bootstrap Spinner components. Bootstrap Spinners are versatile components used to indicate a loading state in a variety of scenarios. They can be displayed when the user initiates an action that requires some time to process, such as submitting a form or loading data. Spinners are available in two styles: Border and Grow. The Border style is a rotating border, while the Grow style is a shape that continuously grows and shrinks. Through these macros, the color of the spinner can be specified as 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark'."))

(in-package :cl-sbt-spinner)

(defmacro spinner ((&key (type "border") (color "primary") (size nil)))
  "This macro generates a Bootstrap spinner with a specified color.

TYPE: Specifies the spinner style. Can be 'border' or 'grow'. Defaults to 'border'.
COLOR: Specifies the spinner color. Can be 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark', or 'link'. Defaults to 'primary'."
  `(spinneret:with-html
     (:div :class ,(if (null size)
                       (format nil "spinner-~a text-~a" type color)
                       (format nil "spinner-~a spinner-~a-~a text-~a" type type size color))
           :role "status"
           (:span :class "visually-hidden" "Loading..."))))

(defmacro define-spinner (type color size)
  "This macro defines a new spinner macro with a specified style and color.

TYPE: Specifies the style of the spinner. It can be 'border' or 'grow'.
COLOR: Specifies the color of the spinner."
  (let* ((size-name (if (null size) "" (format nil "-~a" size)))
         (macro-name (intern (string-upcase (concatenate 'string "SPINNER-" type "-" color size-name)))))
    `(defmacro ,macro-name ()
       `(spinner (:type ,,type :color ,,color :size ,,size)))))

(defmacro define-spinners (names)
  "This macro defines a set of new spinner macros.

NAMES: A list of colors to use for the spinners."
  `(progn
     ,@(loop for item in names
             for color = (string-downcase (string item))
             collect `(progn
                        (define-spinner "border" ,color nil)
                        (define-spinner "grow" ,color nil)
                        (define-spinner "border" ,color "sm")
                        (define-spinner "grow" ,color "sm")))))

(define-spinners (primary secondary success danger warning info light dark))