comand-component-library 3.1.71 → 3.1.74

package/src/documentation/generated/CmdBoxSiteSearchPropertyDescriptions.json

@@ -0,0 +1,79 @@
+{
+    "modelValueInput1": {
+        "comments": [
+            "custom modelValue for first input-field"
+        ]
+    },
+    "modelValueInput2": {
+        "comments": [
+            "custom modelValue for second input-field"
+        ]
+    },
+    "modelValueRadius": {
+        "comments": [
+            "custom modelValue for radius"
+        ]
+    },
+    "modelValueSearchFilters": {
+        "comments": [
+            "custom modelValue for search-filters"
+        ]
+    },
+    "useFilters": {
+        "comments": [
+            "toggle use of filters (must configured)"
+        ]
+    },
+    "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"
+        ]
+    },
+    "cmdFormElementInput1": {
+        "comments": [
+            "properties for CmdFormElement-component first search-field"
+        ]
+    },
+    "cmdFormElementInput2": {
+        "comments": [
+            "properties for CmdFormElement-component for second search-field"
+        ]
+    },
+    "cmdFormElementRadius": {
+        "comments": [
+            "properties for CmdFormElement-component for radius"
+        ]
+    },
+    "cmdFormElementSearchButton": {
+        "comments": [
+            "properties for CmdFormElement-component for search-button"
+        ]
+    },
+    "cmdFakeSelect": {
+        "comments": [
+            "properties for CmdFakeSelect-component for filters"
+        ]
+    }
+}

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,37 @@
+{
+    "modelValue": {
+        "comments": [
+            "set default v-model (must be named modelValue in Vue3)"
+        ]
+    },
+    "cmdCustomHeadlineCookieDisclaimer": {
+        "comments": [
+            "properties for CmdCustomHeadline-component at top of cookie disclaimer"
+        ]
+    },
+    "cmdBoxRequiredCookies": {
+        "comments": [
+            "property for CmdBox-component surrounding the required cookies"
+        ]
+    },
+    "cmdBoxOptionalCookies": {
+        "comments": [
+            "property for CmdBox-component surrounding the optional cookies"
+        ]
+    },
+    "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,84 @@
+{
+    "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, warning, success, info"
+            ],
+            "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"
+        ]
+    },
+    "showLabel": {
+        "comments": [
+            "toggle label visibility"
+        ]
+    },
+    "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/CmdFormElementPropertyDescriptions.json

@@ -0,0 +1,253 @@
+{
+    "modelValue": {
+        "comments": [
+            "set value for v-model (must be named modelValue in vue3 if default v-model should be used)"
+        ]
+    },
+    "element": {
+        "comments": [
+            "set type of native form-element"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "input, select, textarea, button"
+            ]
+        }
+    },
+    "showLabel": {
+        "comments": [
+            "hide label (and asterisk if mandatory)",
+            "",
+            "label may not be removed, because it is required for accessibility"
+        ]
+    },
+    "labelText": {
+        "comments": [
+            "text for label"
+        ]
+    },
+    "toggleSwitch": {
+        "comments": [
+            "set to activate to use toggle-switch-styling",
+            "element-prop must be set to \"input\" and type-attribute must be set to \"checkbox\" or \"radio\""
+        ],
+        "annotations": {
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    },
+    "onLabel": {
+        "comments": [
+            "text for on-label",
+            "",
+            "set to activate switch-label (=label is placed on toggle-switch (not behind))",
+            "toggleSwitch-prop must be set to \"true\"",
+            "element-prop must be set to \"input\" and type-attribute must be set to \"checkbox\" or \"radio\""
+        ]
+    },
+    "offLabel": {
+        "comments": [
+            "text for off-label",
+            "",
+            "set to activate switch-label (=label is placed on toggle-switch (not behind))",
+            "toggleSwitch-prop must be set to \"true\"",
+            "element-prop must be set to \"input\" and type-attribute must be set to \"checkbox\" or \"radio\""
+        ]
+    },
+    "colored": {
+        "comments": [
+            "on/off-, yes/no-color-styling",
+            "set to true, if checkbox/radio-buttons should have green/checked and red/unchecked color-coding",
+            "toggleSwitch-prop must be set to \"true\"",
+            "element-prop must be set to \"input\" and type-attribute must be set to \"checkbox\" or \"radio\""
+        ],
+        "annotations": {
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    },
+    "inputValue": {
+        "comments": [
+            "allow checkbox/radio-buttons to get value from outside"
+        ]
+    },
+    "replaceInputType": {
+        "comments": [
+            "for replacing native checkboxes/radio-buttons by custom ones (based on frontend-framework)"
+        ],
+        "annotations": {
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    },
+    "inputClass": {
+        "comments": [
+            "set an optional class on native form-element (use native class=\"\" on component ot set class on outer-component-element)",
+            "",
+            "may not be named as 'class' because it is a reserved keyword in JavaScript"
+        ]
+    },
+    "id": {
+        "comments": [
+            "if for native form-element"
+        ]
+    },
+    "datalist": {
+        "comments": [
+            "set if a native datalist should be used"
+        ]
+    },
+    "selectOptions": {
+        "comments": [
+            "list of options for selectbox",
+            "",
+            "element-property must be 'select'"
+        ]
+    },
+    "nativeButton": {
+        "comments": [
+            "native button"
+        ]
+    },
+    "tooltipText": {
+        "comments": [
+            "set text for tooltip"
+        ]
+    },
+    "fieldIconClass": {
+        "comments": [
+            "set class for inner icon (icon placed 'inside' input/ left of input-text)",
+            "",
+            "element-property must be 'input' and type-property may not be checkbox or radio"
+        ]
+    },
+    "displayLabelInline": {
+        "comments": [
+            "activate if label-text should be place inline/left of form-element (and not above)",
+            "",
+            "type-property may not be checkbox or radio"
+        ]
+    },
+    "status": {
+        "comments": [
+            "set status for label and form-element"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "error, warning, success, info",
+                ""
+            ],
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    },
+    "showCharactersTextarea": {
+        "comments": [
+            "toggle display of number of used and allowed characters for textarea",
+            "",
+            "type-property must be set to textarea"
+        ]
+    },
+    "showSearchButton": {
+        "comments": [
+            "toggle visibility of search-button (next to search-field)"
+        ]
+    },
+    "iconDelete": {
+        "comments": [
+            "icon to delete search term",
+            "",
+            "element-property must me set to 'input'",
+            "type-property must be set to 'search'",
+            ""
+        ]
+    },
+    "iconSearch": {
+        "comments": [
+            "icon to search term",
+            "",
+            "element-property must me set to 'input'",
+            "type-property must be set to 'search'",
+            ""
+        ]
+    },
+    "iconHasStateError": {
+        "comments": [
+            "icon for error-validated items in list-of-requirements",
+            "",
+            "element-property must me set to 'input'",
+            "showRequirements-property must be set to 'true'",
+            ""
+        ]
+    },
+    "iconHasStateWarning": {
+        "comments": [
+            "icon for warning-validated items in list-of-requirements",
+            "",
+            "element-property must me set to 'input'",
+            "showRequirements-property must be set to 'true'",
+            ""
+        ]
+    },
+    "iconHasStateSuccess": {
+        "comments": [
+            "icon for success-validated items in list-of-requirements",
+            "",
+            "element-property must me set to 'input'",
+            "showRequirements-property must be set to 'true'",
+            ""
+        ]
+    },
+    "iconHasStateInfo": {
+        "comments": [
+            "icon for info-validated items in list-of-requirements",
+            "",
+            "element-property must me set to 'input'",
+            "showRequirements-property must be set to 'true'",
+            ""
+        ]
+    },
+    "useIconsForToggleSwitch": {
+        "comments": [
+            "toggle if toggle-switch shows icons for checked/unchecked-status"
+        ]
+    },
+    "toggleSwitchCheckedIconClass": {
+        "comments": [
+            "icon for toggle-switch checked",
+            "",
+            "toggle-switch-property must be activated",
+            "use-icons-for-toggle-switch-property must be activated"
+        ]
+    },
+    "toggleSwitchUncheckedIconClass": {
+        "comments": [
+            "icon for toggle-switch unchecked",
+            "",
+            "toggle-switch-property must be activated",
+            "use-icons-for-toggle-switch-property must be activated"
+        ]
+    },
+    "iconPasswordVisible": {
+        "comments": [
+            "icon to toggle password-visibility",
+            "",
+            "element-property must me set to 'input'",
+            "type-property must be set to 'password'",
+            ""
+        ]
+    },
+    "iconPasswordInvisible": {
+        "comments": [
+            "icon to toggle password-visibility",
+            "",
+            "element-property must me set to 'input'",
+            "type-property must be set to 'password'",
+            ""
+        ]
+    }
+}

package/src/documentation/generated/CmdFormFiltersPropertyDescriptions.json

@@ -0,0 +1,32 @@
+{
+    "modelValue": {
+        "comments": [
+            "model-value to support v-model"
+        ]
+    },
+    "linkDeleteAllFilters": {
+        "comments": [
+            "delete-all-filters-link"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "deleteFilter": {
+        "comments": [
+            "icon for deleting (a single) filter"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "selectedOptionsName": {
+        "comments": [
+            "name for selected options"
+        ]
+    }
+}