comand-component-library 3.1.45 → 3.1.46

package/src/documentation/generated/CmdShareButtonsPropertyDescriptions.json

@@ -0,0 +1,34 @@
+{
+    "align": {
+        "comments": [
+            "set horizontal alignment"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "left, right"
+            ]
+        }
+    },
+    "stretchButtons": {
+        "comments": [
+            "stretch-buttons to share horizontal space vertically"
+        ]
+    },
+    "shareButtons": {
+        "comments": [
+            "list of share-buttons (i.e. facebook, twitter etc.)"
+        ]
+    },
+    "page": {
+        "comments": [
+            "page to share (appended to social-bookmark-url)",
+            "",
+            "appendPage-property must be activated"
+        ]
+    },
+    "appendPage": {
+        "comments": [
+            "activate if page to share is not given by json-data)"
+        ]
+    }
+}

package/src/documentation/generated/CmdSiteHeaderPropertyDescriptions.json

@@ -0,0 +1,27 @@
+{
+    "cmdMainNavigation": {
+        "comments": [
+            "properties for CmdMainNavigation-component"
+        ]
+    },
+    "closeOffcanvas": {
+        "comments": [
+            "use only if default-button of inner navigation-component should not be used"
+        ]
+    },
+    "sticky": {
+        "comments": [
+            "activated sticky-header (stays on top if page is scrolled)"
+        ]
+    },
+    "useGrid": {
+        "comments": [
+            "use a grid for positioning of inner-elements (else a flex-container will be used)"
+        ],
+        "annotations": {
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdSlideButtonPropertyDescriptions.json

@@ -0,0 +1,25 @@
+{
+    "slideButtonType": {
+        "comments": [
+            "set slide-button-type"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "next, prev, up, down"
+            ],
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    },
+    "slideButtons": {
+        "comments": [
+            "default slide-buttons"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdSlideshowPropertyDescriptions.json

@@ -0,0 +1,42 @@
+{
+    "useSlot": {
+        "comments": [
+            "use slot for images"
+        ]
+    },
+    "autoplay": {
+        "comments": [
+            "activate if images should switch automatically"
+        ]
+    },
+    "autoplayInterval": {
+        "comments": [
+            "set milliseconds to switch images (if autoplay is activated only)"
+        ]
+    },
+    "showQuickLinkIcons": {
+        "comments": [
+            "shows buttons/icons to let user quick jump to each image"
+        ]
+    },
+    "showCounter": {
+        "comments": [
+            "activate if current number of each image should be displayed"
+        ]
+    },
+    "slideshowItems": {
+        "comments": [
+            "list of images to display (use slot must be set to false)"
+        ]
+    },
+    "cmdSlideButtons": {
+        "comments": [
+            "properties for CmdSlideButtons-component"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdSwitchButtonPropertyDescriptions.json

@@ -0,0 +1,79 @@
+{
+    "type": {
+        "comments": [
+            "set type for input",
+            "",
+            "values: checkbox, radio"
+        ]
+    },
+    "id": {
+        "comments": [
+            "set id for input"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    },
+    "name": {
+        "comments": [
+            "set name for input",
+            "",
+            "required for radio-buttons (and form-submit by browser)"
+        ]
+    },
+    "value": {
+        "comments": [
+            "value for v-model"
+        ]
+    },
+    "inputValue": {
+        "comments": [
+            "set value to pre-check toggle-switch"
+        ]
+    },
+    "labelText": {
+        "comments": [
+            "text for label",
+            "required if onLabel/offLabel are not set"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    },
+    "onLabel": {
+        "comments": [
+            "text for on-label",
+            "set to activate switch-label (=label is placed on toggle-switch (not behind))"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    },
+    "offLabel": {
+        "comments": [
+            "text for off-label",
+            "set to activate switch-label (=label is placed on toggle-switch (not behind))"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    },
+    "colored": {
+        "comments": [
+            "set to true, if checkbox/radio-buttons should have green/checked and red/unchecked color-coding"
+        ],
+        "annotations": {
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdSwitchLanguagePropertyDescriptions.json

@@ -0,0 +1,7 @@
+{
+    "languages": {
+        "comments": [
+            "list of languages"
+        ]
+    }
+}

package/src/documentation/generated/CmdSystemMessagePropertyDescriptions.json

@@ -0,0 +1,40 @@
+{
+    "validationStatus": {
+        "comments": [
+            "validation-status for the message-box"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "error, warning, success, info"
+            ],
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    },
+    "fullWidth": {
+        "comments": [
+            "activate to stretch message-box as wide as parent container (else message-box is as wide as message (+padding))"
+        ]
+    },
+    "iconMessage": {
+        "comments": [
+            "set icon-class for message (will be displayed left from message)"
+        ]
+    },
+    "systemMessage": {
+        "comments": [
+            "the system-message-text"
+        ]
+    },
+    "iconClose": {
+        "comments": [
+            "icon to close system-message"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdTablePropertyDescriptions.json

@@ -0,0 +1,62 @@
+{
+    "tableData": {
+        "comments": [
+            "table data (incl. caption, thead, tbody)"
+        ]
+    },
+    "collapsible": {
+        "comments": [
+            "activate if table should be collapsible"
+        ]
+    },
+    "fullWidthOnDefault": {
+        "comments": [
+            "activate if table should be stretched to full width of its parent-container (else table will be as wide as its content)"
+        ]
+    },
+    "userCanToggleWidth": {
+        "comments": [
+            "user can toggle width (full-width (=100% of parent container or as wide as table content) with button above table)"
+        ]
+    },
+    "iconExpand": {
+        "comments": [
+            "icon to expand table (vertically)"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "iconCollapse": {
+        "comments": [
+            "icon to collapse table (vertically)"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "iconShrink": {
+        "comments": [
+            "icon to shrink table (horizontally)"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "iconStretch": {
+        "comments": [
+            "icon to stretch table (horizontally)"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdTabsPropertyDescriptions.json

@@ -0,0 +1,27 @@
+{
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for CmdCustomHeadline-component"
+        ]
+    },
+    "stretchTabs": {
+        "comments": [
+            "activate if tabs should be (equally) stretched horizontally over full width of tab-content"
+        ]
+    },
+    "tabs": {
+        "comments": [
+            "list of tabs (incl. tab-name and tab-content (optional))"
+        ]
+    },
+    "useSlot": {
+        "comments": [
+            "activate if content should be given by slot"
+        ]
+    },
+    "activeTab": {
+        "comments": [
+            "set default active/shown tab"
+        ]
+    }
+}

package/src/documentation/generated/CmdThumbnailScrollerPropertyDescriptions.json

@@ -0,0 +1,32 @@
+{
+    "thumbnailScrollerItems": {
+        "comments": [
+            "list of thumbnail-scroller-items"
+        ]
+    },
+    "allowOpenFancyBox": {
+        "comments": [
+            "allow large version of images to be opened in CmdFancyBox-component"
+        ]
+    },
+    "imgIndex": {
+        "comments": [
+            "set a default index to activate/highlight a specific image/item"
+        ]
+    },
+    "figcaption": {
+        "comments": [
+            "set figcaption"
+        ]
+    },
+    "cmdSlideButtons": {
+        "comments": [
+            "properties for CmdSlideButtons-component"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdTooltipPropertyDescriptions.json

@@ -0,0 +1,17 @@
+{
+    "cmdCustomHeadline": {
+        "comments": [
+            "enable toggling tooltip-visibility by click"
+        ]
+    },
+    "methods": {
+        "comments": [
+            "enable toggling tooltip-visibility by click"
+        ]
+    },
+    "watch": {
+        "comments": [
+            "enable toggling tooltip-visibility by click"
+        ]
+    }
+}

package/src/documentation/generated/CmdUploadFormPropertyDescriptions.json

@@ -0,0 +1,90 @@
+{
+    "deleteIconClass": {
+        "comments": [
+            "set icon class for delete-icons"
+        ]
+    },
+    "showTotalUpload": {
+        "comments": [
+            "toggle visibility of total upload (number of files, total size, total progress"
+        ]
+    },
+    "componentHandlesUpload": {
+        "comments": [
+            "toggle if upload is handled by component itself or by outer component"
+        ]
+    },
+    "allowedFileExtensions": {
+        "comments": [
+            "list of allowed file extensions to upload (all can be selected)"
+        ]
+    },
+    "commentRequired": {
+        "comments": [
+            "activate if the comment given by the user should be mandatory",
+            "",
+            "enableComment-property must be set to true"
+        ]
+    },
+    "commentStatusMessage": {
+        "comments": [
+            "show a message if mandatory comment-textarea is not filled",
+            "",
+            "enableComment-property and commentRequired-property must be set to true"
+        ]
+    },
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for CmdCustomHeadline-component"
+        ]
+    },
+    "enableDragAndDrop": {
+        "comments": [
+            "enable if files can also be dragged (and dropped) into upload-area"
+        ]
+    },
+    "enableComment": {
+        "comments": [
+            "enable if a comment should be possible to left by the user"
+        ]
+    },
+    "presetComment": {
+        "comments": [
+            "preset the comment-textarea",
+            "",
+            "enableComment-property must be set to true"
+        ]
+    },
+    "maxTotalUploadSize": {
+        "comments": [
+            "set to 0 if no maximum for total upload size should be set"
+        ]
+    },
+    "maxFileUploadSize": {
+        "comments": [
+            "max file size (in bytes) for each single file"
+        ]
+    },
+    "allowMultipleFileUploads": {
+        "comments": [
+            "enable if more than file should be enabled to be selected for upload"
+        ]
+    },
+    "uploadOptions": {
+        "comments": [
+            "defines upload options if component handles upload itself",
+            "",
+            "componentHandlesUpload-property must be true"
+        ]
+    },
+    "advancedMode": {
+        "comments": [
+            "activate to use full upload-form-style and -functionality"
+        ],
+        "annotations": {
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdWidthLimitationWrapperPropertyDescriptions.json

@@ -0,0 +1,41 @@
+{
+    "innerComponent": {
+        "comments": [
+            "set a html-tag as inner tag"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "section, div"
+            ]
+        }
+    },
+    "innerWrapper": {
+        "comments": [
+            "activate if the inner content should be wrapped in inner component tag (recommended)",
+            "",
+            "(if deactivated, content will be directly placed inside cmd-width-limitation-wrapper)",
+            ""
+        ]
+    },
+    "sticky": {
+        "comments": [
+            "activate if wrapper (and its content) should be sticky (=position remains the same if content below is scrolled)",
+            "",
+            "i.e. use for site-header",
+            "",
+            "keep attention that more than one sticky-element on same html-level can cause problems, if content below is scrolled"
+        ]
+    },
+    "innerClass": {
+        "comments": [
+            "set class to inner component",
+            "",
+            "innerWrapper-property must be true"
+        ]
+    },
+    "anchorId": {
+        "comments": [
+            "set id for (invisible) anchor to enable shortcuts"
+        ]
+    }
+}