css style id and class for builtin elements in hmacro
This commit is contained in:
parent
4ef85ff0e0
commit
1b0fb3fb0b
6 changed files with 74 additions and 16 deletions
14
README.md
14
README.md
|
@ -146,10 +146,22 @@ Then just wrap `h` for all html generation part. In the same examples above, it
|
||||||
|
|
||||||
(defparameter *dog2* (dog :id "dog2" :size 20 "some children"))
|
(defparameter *dog2* (dog :id "dog2" :size 20 "some children"))
|
||||||
```
|
```
|
||||||
|
From version 0.2 (available in Aug 2018 Quicklisp), flute supports css style id and class attribute for builtin elements. For example `div#id-name.class1.class2`, So you can also write:
|
||||||
|
```lisp
|
||||||
|
(h (div#a.b "..."))
|
||||||
|
;; Provide additional class and attributes
|
||||||
|
(h (div#a.b :class "c" :onclick "fun()"))
|
||||||
|
```
|
||||||
|
|
||||||
That's all you need to know to define elements and generate html. Please reference the [API Reference](#api-reference) Section for detailed API.
|
That's all you need to know to define elements and generate html. Please reference the [API Reference](#api-reference) Section for detailed API.
|
||||||
|
|
||||||
|
# Change Logs
|
||||||
|
## 2018/07/28 Version 0.2-dev
|
||||||
|
- Support `element#id.class1.class2` in `H` macro for builtin elements;
|
||||||
|
- Jon Atack fix an error example in README.
|
||||||
|
## 2018/07/11 Version 0.1
|
||||||
|
- Current features, APIs and Tests.
|
||||||
|
|
||||||
# Motivation
|
# Motivation
|
||||||
Currently there're a few HTML generation library in Common Lisp, like [CL-WHO](https://edicl.github.io/cl-who/), [CL-MARKUP](https://github.com/arielnetworks/cl-markup) and [Spinneret](https://github.com/ruricolist/spinneret). They both have good features for generating standard HTML, but not very good at user element (components) that currently widely used in frontend: you need to define all of them as macros and to define components on top of these components, you'll have to make these components more complex macros to composite them. [Spinneret](https://github.com/ruricolist/spinneret) has a `deftag` feature, but `deftag` is still expand to a `defmacro`.
|
Currently there're a few HTML generation library in Common Lisp, like [CL-WHO](https://edicl.github.io/cl-who/), [CL-MARKUP](https://github.com/arielnetworks/cl-markup) and [Spinneret](https://github.com/ruricolist/spinneret). They both have good features for generating standard HTML, but not very good at user element (components) that currently widely used in frontend: you need to define all of them as macros and to define components on top of these components, you'll have to make these components more complex macros to composite them. [Spinneret](https://github.com/ruricolist/spinneret) has a `deftag` feature, but `deftag` is still expand to a `defmacro`.
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
(defsystem flute
|
(defsystem flute
|
||||||
:author "Bo Yao <icerove@gmail.com>"
|
:author "Bo Yao <icerove@gmail.com>"
|
||||||
:license "MIT"
|
:license "MIT"
|
||||||
:version "0.1"
|
:version "0.2-dev"
|
||||||
:components ((:module "src"
|
:components ((:module "src"
|
||||||
:serial t
|
:serial t
|
||||||
:components
|
:components
|
||||||
|
|
|
@ -152,12 +152,37 @@ When given :ASCII and :ATTR, it's possible to insert html text as a children, e.
|
||||||
(print-object (user-element-expand-to element) stream)
|
(print-object (user-element-expand-to element) stream)
|
||||||
(call-next-method)))
|
(call-next-method)))
|
||||||
|
|
||||||
|
(defun html-element-p (x)
|
||||||
|
(and (symbolp x) (not (keywordp x)) (gethash (collect-name-as-keyword x) *builtin-elements*)))
|
||||||
|
|
||||||
(defmacro h (&body body)
|
(defmacro h (&body body)
|
||||||
`(progn
|
`(progn
|
||||||
,@(tree-leaves
|
,@(tree-leaves
|
||||||
body
|
body
|
||||||
(and (symbolp x) (not (keywordp x)) (gethash (collect-name-as-keyword x) *builtin-elements*))
|
(html-element-p x)
|
||||||
(find-symbol (string (collect-name-as-keyword x)) :flute))))
|
(multiple-value-bind (name id class) (collect-id-and-class x)
|
||||||
|
(if (or id class)
|
||||||
|
(make-!expanded :list (list (find-symbol (string-upcase name) :flute)
|
||||||
|
(coerce (append (when id (list :id id))
|
||||||
|
(when class (list :class class)))
|
||||||
|
'vector)))
|
||||||
|
(find-symbol (string-upcase name) :flute))))))
|
||||||
|
|
||||||
|
;;; Experimental
|
||||||
|
;; (when (find :illusion *features*)
|
||||||
|
;; (illusion:set-paren-reader
|
||||||
|
;; :flute
|
||||||
|
;; #'html-element-p
|
||||||
|
;; (lambda (stream indicator)
|
||||||
|
;; (multiple-value-bind (name id class) (collect-id-and-class indicator)
|
||||||
|
;; (if (or id class)
|
||||||
|
;; (list* (find-symbol (string-upcase name) :flute)
|
||||||
|
;; (coerce (append (when id (list :id))
|
||||||
|
;; (when class (list :class class)))
|
||||||
|
;; 'vector)
|
||||||
|
;; (illusion:cl-read-list stream))
|
||||||
|
;; (cons (find-symbol (string-upcase name) :flute)
|
||||||
|
;; (illusion:cl-read-list stream)))))))
|
||||||
|
|
||||||
(defmethod element-string ((element element))
|
(defmethod element-string ((element element))
|
||||||
(with-output-to-string (s)
|
(with-output-to-string (s)
|
||||||
|
|
|
@ -12,7 +12,8 @@
|
||||||
:mkstr
|
:mkstr
|
||||||
:flatten)
|
:flatten)
|
||||||
(:import-from :alexandria
|
(:import-from :alexandria
|
||||||
:make-keyword)
|
:make-keyword
|
||||||
|
:if-let)
|
||||||
(:export
|
(:export
|
||||||
;;; builtin HTML elements
|
;;; builtin HTML elements
|
||||||
;;; all html5 elements, e.g. div, nav, media, export in code except
|
;;; all html5 elements, e.g. div, nav, media, export in code except
|
||||||
|
|
|
@ -10,12 +10,16 @@
|
||||||
(cdr kv)))
|
(cdr kv)))
|
||||||
alist))
|
alist))
|
||||||
|
|
||||||
|
(defstruct !expanded list)
|
||||||
|
|
||||||
(defun tree-leaves%% (tree test result)
|
(defun tree-leaves%% (tree test result)
|
||||||
(if tree
|
(if tree
|
||||||
(if (listp tree)
|
(if (listp tree)
|
||||||
(cons
|
(let ((car-result (tree-leaves%% (car tree) test result))
|
||||||
(tree-leaves%% (car tree) test result)
|
(cdr-result (tree-leaves%% (cdr tree) test result)))
|
||||||
(tree-leaves%% (cdr tree) test result))
|
(if (!expanded-p car-result)
|
||||||
|
(append (!expanded-list car-result) cdr-result)
|
||||||
|
(cons car-result cdr-result)))
|
||||||
(if (funcall test tree)
|
(if (funcall test tree)
|
||||||
(funcall result tree)
|
(funcall result tree)
|
||||||
tree))))
|
tree))))
|
||||||
|
@ -128,13 +132,13 @@
|
||||||
(do ((current-and-remains (collect-until-dot-or-sharp (string-downcase (string symbol)))
|
(do ((current-and-remains (collect-until-dot-or-sharp (string-downcase (string symbol)))
|
||||||
(collect-until-dot-or-sharp (cdr current-and-remains))))
|
(collect-until-dot-or-sharp (cdr current-and-remains))))
|
||||||
((string= "" (car current-and-remains))
|
((string= "" (car current-and-remains))
|
||||||
(values name id (format nil "~{~a~^ ~}" (nreverse class))))
|
(values name id (when class (format nil "~{~a~^ ~}" (nreverse class)))))
|
||||||
(case next-is
|
(case next-is
|
||||||
(:id (setf id (car current-and-remains)))
|
(:id (setf id (car current-and-remains)))
|
||||||
(:class (push (car current-and-remains) class))
|
(:class (push (car current-and-remains) class))
|
||||||
(otherwise (setf name (car current-and-remains))))
|
(otherwise (setf name (car current-and-remains))))
|
||||||
(unless (string= "" (cdr current-and-remains))
|
(unless (string= "" (cdr current-and-remains))
|
||||||
(setf next-is (ecase (aref (cdr current-and-remains) 0)
|
(setf next-is (ecase (aref (cdr current-and-remains) 0)
|
||||||
(#\. :id)
|
(#\# :id)
|
||||||
(#\# :class))
|
(#\. :class))
|
||||||
(cdr current-and-remains) (subseq (cdr current-and-remains) 1))))))
|
(cdr current-and-remains) (subseq (cdr current-and-remains) 1))))))
|
||||||
|
|
18
t/flute.lisp
18
t/flute.lisp
|
@ -371,6 +371,22 @@
|
||||||
</div>"
|
</div>"
|
||||||
(element-string
|
(element-string
|
||||||
(h (duck :id 5 :color "blue"
|
(h (duck :id 5 :color "blue"
|
||||||
(img :href "duck.png"))))))))
|
(img :href "duck.png"))))))
|
||||||
|
(is (string=
|
||||||
|
"<div class=\"class1 class2\" id=\"has-id\">child</div>"
|
||||||
|
(element-string
|
||||||
|
(h (div#has-id.class1.class2 "child")))))
|
||||||
|
(is (string=
|
||||||
|
"<div class=\"class1 class2\" id=\"has-id\" onclick=\"func()\">child</div>"
|
||||||
|
(element-string
|
||||||
|
(h (div#has-id.class1.class2 :onclick "func()" "child")))))
|
||||||
|
(is (string=
|
||||||
|
"<div class=\"class1 class2\" id=\"has-id\" onclick=\"func()\">child</div>"
|
||||||
|
(element-string
|
||||||
|
(h (div#has-id.class1.class2 '(:onclick "func()") "child")))))
|
||||||
|
(is (string=
|
||||||
|
"<div id=\"has-id\" class=\"class1 class2 additional-class\">child</div>"
|
||||||
|
(element-string
|
||||||
|
(h (div.class1#has-id.class2 ':class "additional-class" "child")))))))
|
||||||
|
|
||||||
(run-all-tests)
|
(run-all-tests)
|
||||||
|
|
Loading…
Reference in a new issue