comand-component-library 4.1.30 → 4.1.32

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"
-        ]
-    }
-}

package/src/documentation/generated/CmdInputGroupPropertyDescriptions.json

@@ -1,132 +0,0 @@
-{
-    "modelValue": {
-        "comments": [
-            "set value for v-model (must be named modelValue in vue3 if default v-model should be used)"
-        ]
-    },
-    "required": {
-        "comments": [
-            "set if input-group should be required"
-        ]
-    },
-    "inputElements": {
-        "comments": [
-            "list of input-elements inside group",
-            "",
-            "useSlot-property must be set to 'false'"
-        ]
-    },
-    "inputTypes": {
-        "comments": [
-            "set type for inputs in group"
-        ],
-        "annotations": {
-            "allowedValues": [
-                "checkbox, radio"
-            ]
-        }
-    },
-    "status": {
-        "comments": [
-            "set status for label and inner form-elements"
-        ],
-        "annotations": {
-            "allowedValues": [
-                "error, warning, success, info",
-                ""
-            ],
-            "affectsStyling": [
-                "true"
-            ]
-        }
-    },
-    "replaceInputType": {
-        "comments": [
-            "for replacing native checkboxes/radio-buttons by custom ones (based on frontend-framework)",
-            "toggleSwitch-property must be set to 'false'"
-        ],
-        "annotations": {
-            "affectsStyling": [
-                "true"
-            ]
-        }
-    },
-    "toggleSwitch": {
-        "comments": [
-            "for replacing native checkboxes/radio-buttons by toggle-switches (based on frontend-framework)",
-            "replaceInputType-property must be set to 'false'"
-        ],
-        "annotations": {
-            "affectsStyling": [
-                "true"
-            ]
-        }
-    },
-    "useSlot": {
-        "comments": [
-            "activate if input-elements should be given by slot"
-        ]
-    },
-    "multipleSwitch": {
-        "comments": [
-            "toggle multipleSwitch-styling"
-        ],
-        "annotations": {
-            "affectsStyling": [
-                "true"
-            ]
-        }
-    },
-    "showLabel": {
-        "comments": [
-            "toggle label-text visibility"
-        ]
-    },
-    "showStatusIcon": {
-        "comments": [
-            "Toggle visibility of icon for status (i.e. error, warning)"
-        ]
-    },
-    "toggleSwitches": {
-        "comments": [
-            "activate if input-elements should be displayed as toggle-switches"
-        ],
-        "annotations": {
-            "affectsStyling": [
-                "true"
-            ]
-        }
-    },
-    "labelText": {
-        "comments": [
-            "label-text for input-group"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    },
-    "labelInline": {
-        "comments": [
-            "toggle label-position (inline/left of input-elements or above input-elements)"
-        ]
-    },
-    "stretchHorizontally": {
-        "comments": [
-            "toggle if input-elements will be stretched horizontally"
-        ],
-        "annotations": {
-            "affectsStyling": [
-                "true"
-            ]
-        }
-    },
-    "disabled": {
-        "comments": [
-            "define disabled-property to set disabled-style",
-            "",
-            "component cannot handle native disabled-attribute, because it is no native form-element"
-        ]
-    }
-}

package/src/documentation/generated/CmdLinkPropertyDescriptions.json

@@ -1,49 +0,0 @@
-{
-    "fancybox": {
-        "comments": [
-            "deactivate if link should open content in fancybox"
-        ]
-    },
-    "icon": {
-        "comments": [
-            "define (additional) icon as link"
-        ]
-    },
-    "linkType": {
-        "comments": [
-            "define type of link"
-        ],
-        "annotations": {
-            "allowedValues": [
-                "href, router, button"
-            ]
-        }
-    },
-    "path": {
-        "comments": [
-            "the url the link will open or an object for the router"
-        ]
-    },
-    "target": {
-        "comments": [
-            "define a target (i.e. _blank) to open path in new tab"
-        ]
-    },
-    "text": {
-        "comments": [
-            "the displayed text for the link"
-        ]
-    },
-    "styleAsButton": {
-        "comments": [
-            "activate if the link should be styled as default button"
-        ]
-    },
-    "primaryButton": {
-        "comments": [
-            "activate if the link should be styled as primary button",
-            "",
-            "(styledAsButton-property must be activated)"
-        ]
-    }
-}

package/src/documentation/generated/CmdListOfLinksPropertyDescriptions.json

@@ -1,70 +0,0 @@
-{
-    "sectionAnchors": {
-        "comments": [
-            "activate if component should contain a list of anchors for the section within th page"
-        ]
-    },
-    "showListStyleItems": {
-        "comments": [
-            "Toggle visibility of list-style-items for list-entries"
-        ]
-    },
-    "largeIcons": {
-        "comments": [
-            "activate if large icons for links should be used"
-        ]
-    },
-    "activeSection": {
-        "comments": [
-            "given active section from outside to set class for styling",
-            "",
-            "sectionAnchors-property must be activated"
-        ]
-    },
-    "align": {
-        "comments": [
-            "set horizontal alignment",
-            "orientation-property must be set to 'horizontal'"
-        ],
-        "annotations": {
-            "allowedValues": [
-                "left, center, right"
-            ]
-        }
-    },
-    "cmdHeadline": {
-        "comments": [
-            "properties for CmdHeadline-component"
-        ]
-    },
-    "links": {
-        "comments": [
-            "list of displayed links"
-        ]
-    },
-    "orientation": {
-        "comments": [
-            "toggle orientation of list"
-        ],
-        "annotations": {
-            "allowedValues": [
-                "horizontal, vertical"
-            ]
-        }
-    },
-    "useGap": {
-        "comments": [
-            "toggle gab between links"
-        ]
-    },
-    "styleAsBox": {
-        "comments": [
-            "style component like a box"
-        ],
-        "annotations": {
-            "affectsStyling": [
-                "true"
-            ]
-        }
-    }
-}

package/src/documentation/generated/CmdListOfRequirementsPropertyDescriptions.json

@@ -1,47 +0,0 @@
-{
-    "inputModelValue": {
-        "comments": [
-            "property to check validity of given modelValue"
-        ]
-    },
-    "inputAttributes": {
-        "comments": [
-            "property to check validity of given attributes"
-        ]
-    },
-    "labelText": {
-        "comments": [
-            "text for label (used in headline)"
-        ]
-    },
-    "inputRequirements": {
-        "comments": [
-            "list of all requirements"
-        ]
-    },
-    "helplink": {
-        "comments": [
-            "set a helplink to a different page for further support"
-        ]
-    },
-    "iconSuccess": {
-        "comments": [
-            "icon to show success-status"
-        ]
-    },
-    "iconError": {
-        "comments": [
-            "icon to show error-status"
-        ]
-    },
-    "showHeadline": {
-        "comments": [
-            "toggle headline-visibility"
-        ]
-    },
-    "cmdHeadline": {
-        "comments": [
-            "properties of CmdHeadline-component"
-        ]
-    }
-}

package/src/documentation/generated/CmdLoginFormPropertyDescriptions.json

@@ -1,105 +0,0 @@
-{
-    "modelValue": {
-        "comments": [
-            "value for v-model (modelValue is default name in vue 3)"
-        ]
-    },
-    "buttonLogin": {
-        "comments": [
-            "define login-/submit-button to login"
-        ]
-    },
-    "buttonSendLogin": {
-        "comments": [
-            "define 'send login-'/submit-button to send login-data"
-        ]
-    },
-    "legendLoginForm": {
-        "comments": [
-            "define legend for 'login'-form"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    },
-    "legendForgotLoginForm": {
-        "comments": [
-            "define legend for 'forgot-login'-form"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    },
-    "orientation": {
-        "comments": [
-            "orientation for form-elements"
-        ],
-        "annotations": {
-            "allowedValues": [
-                "horizontal, vertical"
-            ]
-        }
-    },
-    "cmdHeadlineLoginForm": {
-        "comments": [
-            "properties for CmdHeadline-component for login-form"
-        ]
-    },
-    "cmdHeadlineSendLoginForm": {
-        "comments": [
-            "properties for CmdHeadline-component for send-login-form"
-        ]
-    },
-    "cmdFormElementUsername": {
-        "comments": [
-            "properties for CmdFormElement-component for username-field"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "partial"
-            ]
-        }
-    },
-    "cmdFormElementPassword": {
-        "comments": [
-            "properties for CmdFormElement-component for password-field"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "partial"
-            ]
-        }
-    },
-    "cmdFormElementSendLogin": {
-        "comments": [
-            "properties for CmdFormElement-component for email-address-field (to send login-data)"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "partial"
-            ]
-        }
-    },
-    "options": {
-        "comments": [
-            "options to display",
-            "",
-            "forgotPassword: toggles form to send password by email",
-            "createAccount: creates a link (href/router) which could lead to a register-form"
-        ]
-    },
-    "buttons": {
-        "comments": [
-            "button to login"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "partial"
-            ]
-        }
-    }
-}

package/src/documentation/generated/CmdMainNavigationPropertyDescriptions.json

@@ -1,72 +0,0 @@
-{
-    "stretchMainItems": {
-        "comments": [
-            "toggle if main-entries (on first-level) should be (horizontally) stretched equally"
-        ]
-    },
-    "persistOnMobile": {
-        "comments": [
-            "set if navigation should persist on mobile and not be collapsed to off-canvas"
-        ],
-        "annotations": {
-            "affectsStyling": [
-                "true"
-            ]
-        }
-    },
-    "navigationEntries": {
-        "comments": [
-            "list of all navigation-entries (incl. sub-entries)"
-        ]
-    },
-    "offcanvasPosition": {
-        "comments": [
-            "position of OffCanvas-navigation"
-        ],
-        "annotations": {
-            "allowedValues": [
-                "right, left"
-            ]
-        }
-    },
-    "closeOffcanvas": {
-        "comments": [
-            "link shown inside off-canvas-navigation to close itself"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "partial"
-            ]
-        }
-    },
-    "buttonOffcanvas": {
-        "comments": [
-            "button to open off-canvas-navigation"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "partial"
-            ]
-        }
-    },
-    "subentriesIconClass": {
-        "comments": [
-            "icon to show if an navigation-entry has sub-entries"
-        ]
-    },
-    "subSubentriesIconClass": {
-        "comments": [
-            "icon to show if a sub-entry has further sub-entries"
-        ]
-    },
-    "showContentOverlay": {
-        "comments": [
-            "toggle if overlay over content should be shown if off-canvas is open"
-        ],
-        "annotations": {
-            "affectsStyling": [
-                "true"
-            ]
-        }
-    }
-}

package/src/documentation/generated/CmdMultistepFormProgressBarPropertyDescriptions.json

@@ -1,22 +0,0 @@
-{
-    "showStepNumber": {
-        "comments": [
-            "toggle visibility of step-number in front/left of link-icon and -name"
-        ]
-    },
-    "multisteps": {
-        "comments": [
-            "list of multisteps"
-        ]
-    },
-    "separatorIconClass": {
-        "comments": [
-            "icon-class for separator shown between multisteps"
-        ]
-    },
-    "useGap": {
-        "comments": [
-            "activate if a gap should be shown between the steps"
-        ]
-    }
-}

package/src/documentation/generated/CmdNewsletterSubscriptionPropertyDescriptions.json

@@ -1,37 +0,0 @@
-{
-    "modelValue": {
-        "comments": [
-            "set value for v-model (must be named modelValue in vue3 if default v-model should be used)"
-        ]
-    },
-    "buttonType": {
-        "comments": [
-            "set value for v-model (must be named modelValue in vue3 if default v-model should be used)"
-        ]
-    },
-    "legend": {
-        "comments": [
-            "define the legend for the form"
-        ],
-        "annotations": {
-            "requiredForAccessibility": [
-                "true"
-            ]
-        }
-    },
-    "cmdInputGroup": {
-        "comments": [
-            "properties for CmdInputGroup-component"
-        ]
-    },
-    "cmdFormElementEmail": {
-        "comments": [
-            "properties for CmdFormElement-component for email-field"
-        ]
-    },
-    "cmdFormElementSubmit": {
-        "comments": [
-            "properties for CmdFormElement-component for submit-button"
-        ]
-    }
-}