@saltcorn/builder 0.6.1-beta.0 → 0.6.1

package/src/components/elements/HTMLCode.js

@@ -1,3 +1,9 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/HTMLCode
+ * @subcategory components / elements
+ */
+
 import React from "react";
 import { useNode } from "@craftjs/core";
 import {
@@ -7,7 +13,15 @@ import {
   TextStyleSetting,
 } from "./utils";
 
-export const HTMLCode = ({ text }) => {
+export /**
+ * @param {object} props
+ * @param {string} props.text
+ * @returns {span}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const HTMLCode = ({ text }) => {
   const {
     selected,
     connectors: { connect, drag },
@@ -23,7 +37,6 @@ export const HTMLCode = ({ text }) => {
   );
 };
 
-
 const fields = [
   {
     label: "HTML Code",
@@ -33,6 +46,9 @@ const fields = [
   },
 ];
 
+/**
+ * @type {object}
+ */
 HTMLCode.craft = {
   displayName: "HTMLCode",
   related: {

package/src/components/elements/Image.js

@@ -1,3 +1,9 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/Image
+ * @subcategory components / elements
+ */
+
 import React, { useContext, Fragment } from "react";
 import { useNode } from "@craftjs/core";
 import optionsCtx from "../context";
@@ -5,7 +11,19 @@ import previewCtx from "../preview_context";
 
 import { blockProps, BlockSetting, TextStyleSetting, OrFormula } from "./utils";
 
-export const Image = ({ fileid, block, srctype, url, alt }) => {
+export /**
+ * @param {object} props
+ * @param {string} props.fileid
+ * @param {boolean} props.block
+ * @param {string} props.srctype
+ * @param {string} props.url
+ * @param {string} props.alt
+ * @returns {span}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const Image = ({ fileid, block, srctype, url, alt }) => {
   const {
     selected,
     connectors: { connect, drag },
@@ -26,7 +44,13 @@ export const Image = ({ fileid, block, srctype, url, alt }) => {
   );
 };
 
-export const ImageSettings = () => {
+export /**
+ * @returns {table}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const ImageSettings = () => {
   const node = useNode((node) => ({
     fileid: node.data.props.fileid,
     field: node.data.props.field,
@@ -227,6 +251,9 @@ export const ImageSettings = () => {
   );
 };
 
+/**
+ * @type {object}
+ */
 Image.craft = {
   displayName: "Image",
   defaultProps: {

package/src/components/elements/JoinField.js

@@ -1,3 +1,9 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/JoinField
+ * @subcategory components / elements
+ */
+
 import React, { useContext, useEffect, Fragment } from "react";
 import { useNode } from "@craftjs/core";
 import optionsCtx from "../context";
@@ -9,7 +15,18 @@ import {
 } from "./utils";
 import previewCtx from "../preview_context";
 
-export const JoinField = ({ name, block, fieldview, textStyle }) => {
+export /**
+ * @param {object} props
+ * @param {string} props.name
+ * @param {boolean} props.block
+ * @param {object} props.fieldview
+ * @param {string} props.textStyle
+ * @returns {span}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const JoinField = ({ name, block, fieldview, textStyle }) => {
   const {
     selected,
     node_id,
@@ -47,7 +64,13 @@ export const JoinField = ({ name, block, fieldview, textStyle }) => {
   );
 };
 
-export const JoinFieldSettings = () => {
+export /**
+ * @returns {Fragment}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const JoinFieldSettings = () => {
   const {
     actions: { setProp },
     name,
@@ -148,6 +171,9 @@ export const JoinFieldSettings = () => {
   );
 };
 
+/**
+ * @type {object}
+ */
 JoinField.craft = {
   displayName: "JoinField",
   related: {

package/src/components/elements/LineBreak.js

@@ -1,8 +1,21 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/LineBreak
+ * @subcategory components / elements
+ */
+
 import React, { Fragment } from "react";
 import { useNode } from "@craftjs/core";
 import { SettingsFromFields } from "./utils";
 
-export const LineBreak = ({}) => {
+export /**
+ * @param {object} [props = {}]
+ * @returns {Fragment}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+ const LineBreak = ({}) => {
   const {
     selected,
     connectors: { connect, drag },
@@ -20,6 +33,9 @@ export const LineBreak = ({}) => {
   );
 };
 
+/**
+ * @type {object}
+ */
 LineBreak.craft = {
   displayName: "LineBreak",
   related: {

package/src/components/elements/Link.js

@@ -1,3 +1,9 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/Link
+ * @subcategory components / elements
+ */
+
 import React, { Fragment, useContext } from "react";
 import { useNode } from "@craftjs/core";
 import {
@@ -10,7 +16,24 @@ import {
 } from "./utils";
 import optionsCtx from "../context";
 
-export const Link = ({
+export /**
+ * @param {object} props
+ * @param {string} props.text
+ * @param {boolean} props.block
+ * @param {object} props.isFormula
+ * @param {string} props.textStyle
+ * @param {string} props.link_style
+ * @param {string} props.link_size
+ * @param {string} [props.link_icon]
+ * @param {string} [props.link_bgcol]
+ * @param {string} [props.link_bordercol]
+ * @param {string} [props.link_textcol]
+ * @returns {Fragment}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const Link = ({
   text,
   block,
   isFormula,
@@ -49,7 +72,13 @@ export const Link = ({
   );
 };
 
-export const LinkSettings = () => {
+export /**
+ * @returns {div}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const LinkSettings = () => {
   const node = useNode((node) => ({
     text: node.data.props.text,
     url: node.data.props.url,
@@ -224,6 +253,9 @@ export const LinkSettings = () => {
   );
 };
 
+/**
+ * @type {object}
+ */
 Link.craft = {
   defaultProps: {
     text: "Click here",

package/src/components/elements/SearchBar.js

@@ -1,10 +1,26 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/SearchBar
+ * @subcategory components / elements
+ */
+
 import React, { Fragment, useState } from "react";
 import { Element, useNode } from "@craftjs/core";
 import { Column } from "./Column";
 import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
 import { faCaretDown } from "@fortawesome/free-solid-svg-icons";
 
-export const SearchBar = ({ has_dropdown, children, show_badges }) => {
+export /**
+ * @param {object} props
+ * @param {boolean} props.has_dropdown
+ * @param {string} props.children
+ * @param {boolean} props.show_badges
+ * @returns {div}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const SearchBar = ({ has_dropdown, children, show_badges }) => {
   const {
     selected,
     connectors: { connect, drag },
@@ -63,7 +79,14 @@ export const SearchBar = ({ has_dropdown, children, show_badges }) => {
     </div>
   );
 };
-export const SearchBarSettings = () => {
+
+export /**
+ * @returns {div}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const SearchBarSettings = () => {
   const {
     actions: { setProp },
     has_dropdown,
@@ -102,6 +125,10 @@ export const SearchBarSettings = () => {
     </div>
   );
 };
+
+/**
+ * @type {object}
+ */
 SearchBar.craft = {
   displayName: "SearchBar",
   props: {

package/src/components/elements/Tabs.js

@@ -1,10 +1,27 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/Tabs
+ * @subcategory components / elements
+ */
+
 import React, { Fragment, useState } from "react";
 import { ntimes } from "./Columns";
 import { Column } from "./Column";
 
 import { Element, useNode } from "@craftjs/core";
 
-export const Tabs = ({ contents, titles, tabsStyle, ntabs }) => {
+export /**
+ * @param {object} props
+ * @param {string[]} props.contents
+ * @param {string[]} props.titles
+ * @param {string} props.tabsStyle
+ * @param {number} props.ntabs
+ * @returns {div}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const Tabs = ({ contents, titles, tabsStyle, ntabs }) => {
   const {
     selected,
     connectors: { connect, drag },
@@ -83,7 +100,13 @@ export const Tabs = ({ contents, titles, tabsStyle, ntabs }) => {
     );
 };
 
-export const TabsSettings = () => {
+export /**
+ * @returns {table}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const TabsSettings = () => {
   const node = useNode((node) => ({
     tabsStyle: node.data.props.tabsStyle,
     ntabs: node.data.props.ntabs,
@@ -156,6 +179,10 @@ export const TabsSettings = () => {
     </table>
   );
 };
+
+/**
+ * @type {object}
+ */
 Tabs.craft = {
   props: {
     titles: ["Tab1", "Tab2"],

package/src/components/elements/Text.js

@@ -1,3 +1,9 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/Text
+ * @subcategory components / elements
+ */
+
 import React, { useState, useContext, useEffect, Fragment } from "react";
 import { useNode } from "@craftjs/core";
 import {
@@ -45,10 +51,29 @@ const ckConfig = {
   removeButtons:
     "Source,Save,NewPage,ExportPdf,Print,Preview,Templates,Cut,Copy,Paste,PasteText,PasteFromWord,Find,Replace,SelectAll,Form,Checkbox,Radio,TextField,Textarea,Select,Button,ImageButton,HiddenField,CopyFormatting,CreateDiv,BidiLtr,BidiRtl,Language,Anchor,Flash,Iframe,PageBreak,Maximize,ShowBlocks,About,Undo,Redo,Image",
 };
+
+/**
+ * @param {string} str 
+ * @returns {string}
+ */
 function escape_tags(str) {
   return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
 }
-export const Text = ({ text, block, isFormula, textStyle, icon, font }) => {
+
+export /**
+ * @param {object} props
+ * @param {string} props.text
+ * @param {boolean} props.block
+ * @param {object} props.isFormula
+ * @param {string} props.textStyle
+ * @param {string} [props.icon]
+ * @param {string} [props.font]
+ * @returns {div}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const Text = ({ text, block, isFormula, textStyle, icon, font }) => {
   const {
     connectors: { connect, drag },
     selected,
@@ -103,7 +128,13 @@ export const Text = ({ text, block, isFormula, textStyle, icon, font }) => {
 };
 //<div dangerouslySetInnerHTML={{ __html: text }} />
 
-export const TextSettings = () => {
+export /**
+ * @returns {div}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+*/
+const TextSettings = () => {
   const node = useNode((node) => ({
     text: node.data.props.text,
     block: node.data.props.block,
@@ -220,6 +251,9 @@ export const TextSettings = () => {
   );
 };
 
+/**
+ * @type {object}
+ */
 Text.craft = {
   defaultProps: {
     text: "Click here",

package/src/components/elements/ToggleFilter.js

@@ -1,9 +1,29 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/ToggleFilter
+ * @subcategory components / elements
+ */
+
 import React, { useContext, Fragment } from "react";
 import { useNode } from "@craftjs/core";
 import optionsCtx from "../context";
 import { blockProps, BlockSetting, TextStyleRow } from "./utils";
 
-export const ToggleFilter = ({
+export /**
+ * @param {object} props
+ * @param {*} props.name
+ * @param {string} [props.value]
+ * @param {string} [props.preset_value]
+ * @param {boolean} props.block
+ * @param {string} [props.label]
+ * @param {string} props.size
+ * @param {string} props.style
+ * @returns {table}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const ToggleFilter = ({
   name,
   value,
   preset_value,
@@ -29,7 +49,13 @@ export const ToggleFilter = ({
   );
 };
 
-export const ToggleFilterSettings = () => {
+export /**
+ * @returns {table}
+ * @namespace
+ * @category saltcorn-builder
+ * @subcategory components
+ */
+const ToggleFilterSettings = () => {
   const {
     actions: { setProp },
     name,
@@ -195,6 +221,9 @@ export const ToggleFilterSettings = () => {
   );
 };
 
+/**
+ * @type {object}
+ */
 ToggleFilter.craft = {
   displayName: "ToggleFilter",
   related: {

package/src/components/elements/View.js

@@ -1,3 +1,9 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/View
+ * @subcategory components / elements
+ */
+
 import React, { Fragment, useContext, useEffect } from "react";
 import { useNode } from "@craftjs/core";
 import optionsCtx from "../context";
@@ -11,7 +17,17 @@ import {
   ConfigForm,
 } from "./utils";
 
-export const View = ({ name, view, state }) => {
+export /**
+ * @param {object} props
+ * @param {*} props.name
+ * @param {string} props.view
+ * @param {*} props.state
+ * @returns {div}
+ * @category saltcorn-builder
+ * @subcategory components
+ * @namespace
+ */
+const View = ({ name, view, state }) => {
   const {
     selected,
     node_id,
@@ -51,7 +67,13 @@ export const View = ({ name, view, state }) => {
   );
 };
 
-export const ViewSettings = () => {
+export /**
+ * @returns {div}
+ * @category saltcorn-builder
+ * @subcategory components
+ * @namespace
+ */
+const ViewSettings = () => {
   const node = useNode((node) => ({
     name: node.data.props.name,
     view: node.data.props.view,
@@ -136,6 +158,9 @@ export const ViewSettings = () => {
   );
 };
 
+/**
+ * @type {object}
+ */
 View.craft = {
   displayName: "View",
   related: {

package/src/components/elements/ViewLink.js

@@ -1,3 +1,9 @@
+/**
+ * @category saltcorn-builder
+ * @module components/elements/ViewLink
+ * @subcategory components / elements
+ */
+
 import React, { useContext } from "react";
 import { useNode } from "@craftjs/core";
 import optionsCtx from "../context";
@@ -10,7 +16,26 @@ import {
   ButtonOrLinkSettingsRows,
 } from "./utils";
 
-export const ViewLink = ({
+export /**
+ * @param {object} props
+ * @param {string} props.name
+ * @param {boolean} props.block
+ * @param {*} props.minRole
+ * @param {string} props.link_style
+ * @param {string} props.link_size
+ * @param {string} [props.link_icon]
+ * @param {boolean} props.inModal
+ * @param {string} [props.label]
+ * @param {string} props.textStyle
+ * @param {string} [props.link_bgcol]
+ * @param {string} [props.link_bordercol]
+ * @param {string} [props.link_textcol]
+ * @returns {tr}
+ * @category saltcorn-builder
+ * @subcategory components
+ * @namespace 
+ */
+const ViewLink = ({
   name,
   block,
   minRole,
@@ -53,7 +78,13 @@ export const ViewLink = ({
   );
 };
 
-export const ViewLinkSettings = () => {
+export /**
+ * @returns {div}
+ * @category saltcorn-builder
+ * @subcategory components
+ * @namespace
+ */
+const ViewLinkSettings = () => {
   const node = useNode((node) => ({
     name: node.data.props.name,
     block: node.data.props.block,
@@ -147,6 +178,9 @@ export const ViewLinkSettings = () => {
   );
 };
 
+/**
+ * @type {object}
+ */
 ViewLink.craft = {
   displayName: "ViewLink",
   defaultProps: {