comand-component-library 4.1.29 → 4.1.31

package/src/documentation/generated/CmdFancyBoxPropertyDescriptions.json

@@ -1,97 +0,0 @@
-{
-    "ariaLabelText": {
-        "comments": [
-            "sets aria-label-text on component"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    },
-    "url": {
-        "comments": [
-            "set if content should be loaded by url"
-        ]
-    },
-    "defaultAriaLabelText": {
-        "comments": [
-            "(hidden) text for aria-label"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    },
-    "showPrintButtons": {
-        "comments": [
-            "toggle visibility of print-buttons"
-        ]
-    },
-    "showSubmitButtons": {
-        "comments": [
-            "toggle visibility of print-buttons"
-        ]
-    },
-    "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"
-            ]
-        }
-    },
-    "cmdImage": {
-        "comments": [
-            "properties for CmdImage-component"
-        ]
-    },
-    "cmdHeadline": {
-        "comments": [
-            "properties for CmdHeadline-component"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    }
-}

package/src/documentation/generated/CmdFormElementPropertyDescriptions.json

@@ -1,269 +0,0 @@
-{
-    "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"
-            ]
-        }
-    },
-    "showStatusIcon": {
-        "comments": [
-            "set icon for the status (styled by validation)"
-        ],
-        "affectStyling": [
-            "partial"
-        ]
-    },
-    "showLabel": {
-        "comments": [
-            "hide label (and asterisk if mandatory)",
-            "",
-            "label may not be removed, because it is required for accessibility"
-        ]
-    },
-    "labelText": {
-        "comments": [
-            "text for label"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    },
-    "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"
-        ]
-    },
-    "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"
-        ]
-    },
-    "textCharacters": {
-        "comments": [
-            "text shown in front of character-count below textarea",
-            "",
-            "type-property must be set to textarea",
-            "showCharactersTextarea-property must be activated"
-        ]
-    },
-    "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-subproperty (of CmdListOfRequirements)  must be set to 'true'",
-            ""
-        ]
-    },
-    "iconHasStateWarning": {
-        "comments": [
-            "icon for warning-validated items in list-of-requirements",
-            "",
-            "element-property must me set to 'input'",
-            "showRequirements-subproperty (of CmdListOfRequirements)  must be set to 'true'",
-            ""
-        ]
-    },
-    "iconHasStateSuccess": {
-        "comments": [
-            "icon for success-validated items in list-of-requirements",
-            "",
-            "element-property must me set to 'input'",
-            "showRequirements-subproperty (of CmdListOfRequirements)  must be set to 'true'",
-            ""
-        ]
-    },
-    "iconHasStateInfo": {
-        "comments": [
-            "icon for info-validated items in list-of-requirements",
-            "",
-            "element-property must me set to 'input'",
-            "showRequirements-subproperty (of CmdListOfRequirements) 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

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

package/src/documentation/generated/CmdFormPropertyDescriptions.json

@@ -1,57 +0,0 @@
-{
-    "formAction": {
-        "comments": [
-            "provide a url the form should be send to"
-        ]
-    },
-    "submitButton": {
-        "comments": [
-            "define the submit-button"
-        ]
-    },
-    "formElements": {
-        "comments": [
-            "list of provides form elements"
-        ]
-    },
-    "useSlot": {
-        "comments": [
-            "enable if you want to use the slot for the provided content"
-        ]
-    },
-    "legend": {
-        "comments": [
-            "legend for inner fieldset of the form"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    },
-    "novalidate": {
-        "comments": [
-            "deactivate if browser-validation should be used"
-        ]
-    },
-    "useValidation": {
-        "comments": [
-            "if activated the entire form will be validated by pre-coded validation"
-        ],
-        "annotations": {
-            "affectsStyling": [
-                "true"
-            ]
-        }
-    },
-    "useFieldset": {
-        "comments": [
-            "activate if you want to use a fieldset"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    }
-}

package/src/documentation/generated/CmdGoogleMapsPropertyDescriptions.json

@@ -1,7 +0,0 @@
-{
-    "address": {
-        "comments": [
-            "address to show on Google Maps™"
-        ]
-    }
-}

package/src/documentation/generated/CmdHeadlinePropertyDescriptions.json

@@ -1,32 +0,0 @@
-{
-    "headlineText": {
-        "comments": [
-            "text for headline"
-        ]
-    },
-    "headlineLevel": {
-        "comments": [
-            "level for headline"
-        ]
-    },
-    "preHeadlineText": {
-        "comments": [
-            "small pre-headline-text above main-headline"
-        ]
-    },
-    "cmdIcon": {
-        "comments": [
-            "properties for CmdIcon-component"
-        ],
-        "annotations": {
-            "affectsStyling": [
-                "partial"
-            ]
-        }
-    },
-    "textAlign": {
-        "comments": [
-            "Align of headline-text (incl. pre-headline-text if defined)"
-        ]
-    }
-}

package/src/documentation/generated/CmdIconPropertyDescriptions.json

@@ -1,32 +0,0 @@
-{
-    "type": {
-        "comments": [
-            "type that defines where the icon is loaded from",
-            "'auto' is for letting the component check (by classname) if the icon should be loaded from the local iconfont (class=\"icon-'iconname'\")",
-            " or if the icon should be loaded form iconify-api (class='fontprefix':'iconname') (https://iconify.design/)",
-            "'iconify' forces the component to load an iconify icon (without api) from a local source (which must be defined)"
-        ],
-        "annotations": {
-            "allowedValues": [
-                "'auto', 'iconify'"
-            ]
-        }
-    },
-    "iconClass": {
-        "comments": [
-            "icon-class for icon from local iconfont",
-            "",
-            "type-property must be set to auto and classname must include icon-'iconname'"
-        ]
-    },
-    "tooltip": {
-        "comments": [
-            "tooltip text for icon"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    }
-}

package/src/documentation/generated/CmdImageGalleryPropertyDescriptions.json

@@ -1,32 +0,0 @@
-{
-    "cmdHeadline": {
-        "comments": [
-            "properties for CmdHeadline-component"
-        ]
-    },
-    "useFancyboxForLargeImages": {
-        "comments": [
-            "enable if images should be clickable and large version of the image (must be defined) should e displayed in a fancybox)"
-        ]
-    },
-    "images": {
-        "comments": [
-            "list of images (incl. captions)"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "partial"
-            ]
-        }
-    },
-    "figcaptionPosition": {
-        "comments": [
-            "position of figcaption"
-        ],
-        "annotations": {
-            "allowedValues": [
-                "top, bottom"
-            ]
-        }
-    }
-}

package/src/documentation/generated/CmdImagePropertyDescriptions.json

@@ -1,27 +0,0 @@
-{
-    "image": {
-        "comments": [
-            "image-object including source, alternative text, tooltip (not required)"
-        ]
-    },
-    "figcaption": {
-        "comments": [
-            "figcaption-object including visibility, position (top/bottom), text"
-        ]
-    },
-    "maxFileUploadSize": {
-        "comments": [
-            "define a maximum size (in bytes) for images to upload (edit-mode only)"
-        ]
-    },
-    "minImageWidth": {
-        "comments": [
-            "define a minim width (in pixels) for images to upload (edit-mode only)"
-        ]
-    },
-    "useFigureTag": {
-        "comments": [
-            "toggle if image should be wrapped by a figure-tag (recommend if figcaption is used)"
-        ]
-    }
-}

package/src/documentation/generated/CmdImageZoomPropertyDescriptions.json

@@ -1,12 +0,0 @@
-{
-    "imageSmall": {
-        "comments": [
-            "object for small image"
-        ]
-    },
-    "imageLarge": {
-        "comments": [
-            "object for large image"
-        ]
-    }
-}