浏览代码

Chore: Document components related to hide page-preview itself when hovered hierarchy ref in the preview (#8198)

* fix(hierarchy): do not hide page-preview itself when hovered hierarchy ref in the preview

* docs: add docs for `page-cp`

* docs: add docs for `page-reference`

* docs: add quotation mark

Co-authored-by: Bad3r <[email protected]>
situ2001 2 年之前
父节点
当前提交
07d959bb39
共有 1 个文件被更改,包括 12 次插入1 次删除
  1. 12 1
      src/main/frontend/components/block.cljs

+ 12 - 1
src/main/frontend/components/block.cljs

@@ -680,7 +680,13 @@
       children)))
 
 (rum/defc page-cp
-  "Accepts {:block/name sanitized / unsanitized page-name}"
+  "The page components
+
+   Accepts {:block/name sanitized / unsanitized page-name}
+
+   Configurable keys: 
+   
+   - `:preview?`: Is this component under preview mode? (If true, `page-preview-trigger` won't be registered to this `page-cp`)"
   [{:keys [html-export? redirect-page-name label children contents-page? preview?] :as config} page]
   (when-let [page-name-in-block (:block/name page)]
     (let [page-name-in-block (gp-util/remove-boundary-slashes page-name-in-block)
@@ -749,6 +755,11 @@
       (draw-component {:file file :block-uuid block-uuid}))))
 
 (rum/defc page-reference < rum/reactive
+  "Component for page reference, if there is existing page reference, will render the reference.
+   
+   Arguments:
+   
+   `config`: will be passed as first argument to `page-cp`"
   [html-export? s {:keys [nested-link? id] :as config} label]
   (let [show-brackets? (state/show-brackets?)
         block-uuid (:block/uuid config)