comand-component-library 3.1.45 → 3.1.46

package/src/documentation/generated/CmdAccordionPropertyDescriptions.json

@@ -0,0 +1,57 @@
+{
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for CmdCustomHeadline-component"
+        ]
+    },
+    "useTransition": {
+        "comments": [
+            "use transition to expand accordion-content"
+        ]
+    },
+    "toggleMode": {
+        "comments": [
+            "toggle if mode if only one accordion can be opened (or multiple ones)"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "single, multiple"
+            ]
+        }
+    },
+    "useCustomHeader": {
+        "comments": [
+            "activate if you want to use a customized header"
+        ]
+    },
+    "gapBetween": {
+        "comments": [
+            "set if a gap should be shown between multiple accordions"
+        ]
+    },
+    "accordionData": {
+        "comments": [
+            "all information about the contents in all shown accordions"
+        ]
+    },
+    "iconOpen": {
+        "comments": [
+            "icon to expand an accordion"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "iconClosed": {
+        "comments": [
+            "icon to collapse an accordion"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdAddressDataPropertyDescriptions.json

@@ -0,0 +1,32 @@
+{
+    "showLabelIcons": {
+        "comments": [
+            "show a label-icon (if exists)"
+        ]
+    },
+    "showLabelTexts": {
+        "comments": [
+            "show a label-text"
+        ]
+    },
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for CmdCustomHeadline-component"
+        ]
+    },
+    "showLabels": {
+        "comments": [
+            "option to toggle labels (i.e. telephone, email etc.) in front/left of data"
+        ]
+    },
+    "addressData": {
+        "comments": [
+            "all address-data (incl. labels) that will be shown"
+        ]
+    },
+    "linkGoogleMaps": {
+        "comments": [
+            "link physical address (street, no, zip and city) with Google Maps"
+        ]
+    }
+}

package/src/documentation/generated/CmdBackToTopButtonPropertyDescriptions.json

@@ -0,0 +1,12 @@
+{
+    "iconBackToTop": {
+        "comments": [
+            "icon-class (and shown tooltip on hover) for back to top button"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdBankAccountDataPropertyDescriptions.json

@@ -0,0 +1,34 @@
+{
+    "accountData": {
+        "comments": [
+            "bank account data",
+            "",
+            "must contain: owner, name of bank, IBAN, SWIFT/BIC"
+        ]
+    },
+    "allowCopyByClick": {
+        "comments": [
+            "enable if data can be copied by click on icon"
+        ]
+    },
+    "additionalInformation": {
+        "comments": [
+            "additional information shown in a paragraph below account data"
+        ]
+    },
+    "iconCopy": {
+        "comments": [
+            "icon 'copy'"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for CmdCustomHeadline-component"
+        ]
+    }
+}

package/src/documentation/generated/CmdBoxPropertyDescriptions.json

@@ -0,0 +1,91 @@
+{
+    "boxType": {
+        "comments": [
+            "set boyType to show different types of boxes/contents"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "content, product, user"
+            ],
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    },
+    "collapsible": {
+        "comments": [
+            "activate if box should be collapsible"
+        ]
+    },
+    "useTransition": {
+        "comments": [
+            "use transition to expand and collapse box-body",
+            "",
+            "boyType must be 'content' and 'collapsible' must be activated"
+        ]
+    },
+    "defaultProfileIconClass": {
+        "comments": [
+            "set default profile-icon (will eb shown if no user-image exists)"
+        ]
+    },
+    "product": {
+        "comments": [
+            "the shown product (incl. name, price, image, description)"
+        ],
+        "annotations": {
+            "required": [
+                "only available for boxtype===product"
+            ]
+        }
+    },
+    "user": {
+        "comments": [
+            "the shown user-profile (incl. name, image, contact-data)"
+        ],
+        "annotations": {
+            "required": [
+                "only available for boxtype===user"
+            ]
+        }
+    },
+    "useSlots": {
+        "comments": [
+            "activated if all content (incl. headline) is given by slot",
+            "",
+            "if false textBody-property must be set"
+        ]
+    },
+    "textBody": {
+        "comments": [
+            "String used as content (placed in a paragraph-tag) for box-body",
+            "",
+            "should only be used, if no further html-structure is required for box-body"
+        ]
+    },
+    "iconOpen": {
+        "comments": [
+            "icon to expand an accordion"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "iconClosed": {
+        "comments": [
+            "icon to collapse an accordion"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for CmdCustomHeadline-component"
+        ]
+    }
+}

package/src/documentation/generated/CmdBoxSiteSearchPropertyDescriptions.json

@@ -0,0 +1,41 @@
+{
+    "useFilters": {
+        "comments": [
+            "toggle use of filters (must configured)"
+        ]
+    },
+    "listOfFilters": {
+        "comments": [
+            "set list of filters",
+            "",
+            "useFilters-property must be activated"
+        ]
+    },
+    "textLegend": {
+        "comments": [
+            "text for legend"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    },
+    "showLegend": {
+        "comments": [
+            "toggle legend visibility",
+            "",
+            "textLegend must be set"
+        ]
+    },
+    "results": {
+        "comments": [
+            "send search result from outside to display inside this component"
+        ]
+    },
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for CmdCustomHeadline-component"
+        ]
+    }
+}

package/src/documentation/generated/CmdBoxWrapperPropertyDescriptions.json

@@ -0,0 +1,47 @@
+{
+    "useRowViewAsDefault": {
+        "comments": [
+            "activate if boxes should be arranged vertically (each box is a row) by default"
+        ]
+    },
+    "allowUserToToggleView": {
+        "comments": [
+            "activate if user can toggle grid- and row-view by himself"
+        ]
+    },
+    "allowTogglingCollapsingBoxes": {
+        "comments": [
+            "activate if user can toggle grid- and row-view by himself"
+        ]
+    },
+    "collapseBoxesIcon": {
+        "comments": [
+            "icon for collapsed box"
+        ]
+    },
+    "expandBoxesIcon": {
+        "comments": [
+            "icon for expanded box"
+        ]
+    },
+    "useFlexbox": {
+        "comments": [
+            "activate if you want to use a flex-container instead of a css-grid-container"
+        ]
+    },
+    "boxesPerRow": {
+        "comments": [
+            "define the number of boxes per row (if view is grid-view)"
+        ]
+    },
+    "iconGridView": {
+        "comments": [
+            "define icon for grid-view"
+        ]
+    },
+    "iconRowView": {
+        "comments": [
+            "define icon for row-view"
+        ]
+    }
+}

package/src/documentation/generated/CmdBreadcrumbsPropertyDescriptions.json

@@ -0,0 +1,17 @@
+{
+    "breadcrumbLabel": {
+        "comments": [
+            "label in front/left of breadcrumbs"
+        ]
+    },
+    "breadcrumbLinks": {
+        "comments": [
+            "list of breadcrumb-links (incl. path, icon and text)"
+        ]
+    },
+    "breadcrumbSeparator": {
+        "comments": [
+            "separator sign between entries"
+        ]
+    }
+}

package/src/documentation/generated/CmdCompanyLogoPropertyDescriptions.json

@@ -0,0 +1,27 @@
+{
+    "link": {
+        "comments": [
+            "link for company logo (i.e. to homepage)"
+        ]
+    },
+    "pathDefaultLogo": {
+        "comments": [
+            "path to (default) logo-file"
+        ]
+    },
+    "pathDarkmodeLogo": {
+        "comments": [
+            "path to dark-mode logo-file"
+        ]
+    },
+    "altText": {
+        "comments": [
+            "alternative text for image"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdCookieDisclaimerPropertyDescriptions.json

@@ -0,0 +1,22 @@
+{
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for CmdCustomHeadline-component"
+        ]
+    },
+    "cookieOptions": {
+        "comments": [
+            "list of cookie-options"
+        ]
+    },
+    "buttonLabelAcceptAllCookies": {
+        "comments": [
+            "label for button to accepting all cookies"
+        ]
+    },
+    "buttonLabelAcceptCurrentSettings": {
+        "comments": [
+            "label for button for accepting current settings"
+        ]
+    }
+}

package/src/documentation/generated/CmdCustomHeadlinePropertyDescriptions.json

@@ -0,0 +1,22 @@
+{
+    "headlineText": {
+        "comments": [
+            "text for headline"
+        ]
+    },
+    "headlineLevel": {
+        "comments": [
+            "level for headline"
+        ]
+    },
+    "preHeadlineText": {
+        "comments": [
+            "small pre-headline-text above main-headline"
+        ]
+    },
+    "iconClass": {
+        "comments": [
+            "icon-class for icon shown left/before headline"
+        ]
+    }
+}

package/src/documentation/generated/CmdFakeSelectPropertyDescriptions.json

@@ -0,0 +1,79 @@
+{
+    "type": {
+        "comments": [
+            "set different default selectbox-types for"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "default, color, country, checkboxOptions"
+            ]
+        }
+    },
+    "optionLinkType": {
+        "comments": [
+            "set type of option-links"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "href, router"
+            ]
+        }
+    },
+    "modelValue": {
+        "comments": [
+            "set default v-model (must be named modelValue in Vue3)"
+        ]
+    },
+    "selectData": {
+        "comments": [
+            "list of options to select (incl. displayed names and values)",
+            "",
+            "type-property must be set to \"checkboxOptions\""
+        ]
+    },
+    "showSelectAllOptions": {
+        "comments": [
+            "toggles option to (de)select all options in a checkbox-list",
+            "",
+            "type-property must be set to \"checkboxOptions\""
+        ]
+    },
+    "status": {
+        "comments": [
+            "status (i.e. for validation)"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "error, success, disabled"
+            ],
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    },
+    "dropdownIcon": {
+        "comments": [
+            "icon for dropdown-icon (i.e. an angle/arrow)"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ],
+            "defaultIcon": [
+                "icon-single-arrow-down"
+            ]
+        }
+    },
+    "labelText": {
+        "comments": [
+            "label-text for fake-select",
+            "",
+            " @requiredForAccessibility: true"
+        ]
+    },
+    "pathFlags": {
+        "comments": [
+            "path to flag-files (will be combined with flag isoCode to load svg)"
+        ]
+    }
+}

package/src/documentation/generated/CmdFancyBoxPropertyDescriptions.json

@@ -0,0 +1,62 @@
+{
+    "url": {
+        "comments": [
+            "set if content should be loaded by url"
+        ]
+    },
+    "fancyboxOptions": {
+        "comments": [
+            "options to show at top (closeIcon, printButtons)"
+        ]
+    },
+    "allowEscapeKey": {
+        "comments": [
+            "allow closing fancybox by escape-key"
+        ]
+    },
+    "content": {
+        "comments": [
+            "the content shown in the main area"
+        ]
+    },
+    "elements": {
+        "comments": [
+            "list of show elements (not images)"
+        ]
+    },
+    "fancyBoxGallery": {
+        "comments": [
+            "use if a gallery of images should be opened (and navigated) inside fancybox"
+        ]
+    },
+    "defaultGalleryIndex": {
+        "comments": [
+            "if gallery is used, you can set default index"
+        ]
+    },
+    "show": {
+        "comments": [
+            "show/hide entire fancybox"
+        ]
+    },
+    "showOverlay": {
+        "comments": [
+            "show/hide overlay (around fancybox, above website)"
+        ],
+        "annotations": {
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    },
+    "altText": {
+        "comments": [
+            "alternative text for large image (required for images)"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdFooterNavigationPropertyDescriptions.json

@@ -0,0 +1,17 @@
+{
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for cmdCustomHeadline-component"
+        ]
+    },
+    "footerNavigation": {
+        "comments": [
+            "list of links shown vertically"
+        ]
+    },
+    "styleAsBox": {
+        "comments": [
+            "list of links shown vertically"
+        ]
+    }
+}