comand-component-library 3.1.72 → 3.1.75

package/src/documentation/generated/CmdInputGroupPropertyDescriptions.json

@@ -0,0 +1,117 @@
+{
+    "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"
+        ]
+    },
+    "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/CmdListOfLinksPropertyDescriptions.json

@@ -0,0 +1,60 @@
+{
+    "sectionAnchors": {
+        "comments": [
+            "activate if component should contain a list of anchors for the section within th page"
+        ]
+    },
+    "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

@@ -0,0 +1,32 @@
+{
+    "inputModelValue": {
+        "comments": [
+            "property to check validity of given modelValue"
+        ]
+    },
+    "inputAttributes": {
+        "comments": [
+            "property to check validity of given attributes"
+        ]
+    },
+    "labelText": {
+        "comments": [
+            "text for label"
+        ]
+    },
+    "inputRequirements": {
+        "comments": [
+            "list of all requirements"
+        ]
+    },
+    "helplink": {
+        "comments": [
+            "set a helplink to a different page for further support"
+        ]
+    },
+    "CmdHeadline": {
+        "comments": [
+            "properties of CmdHeadline-component"
+        ]
+    }
+}

package/src/documentation/generated/CmdLoginFormPropertyDescriptions.json

@@ -0,0 +1,90 @@
+{
+    "modelValue": {
+        "comments": [
+            "value for v-model (modelValue is default name in vue 3)"
+        ]
+    },
+    "textLegend": {
+        "comments": [
+            "text used as legend for login-fieldset"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    },
+    "showLegend": {
+        "comments": [
+            "toggle legend visibility"
+        ]
+    },
+    "legendSendLoginForm": {
+        "comments": [
+            "legend for send-login-fieldset"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    },
+    "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

@@ -0,0 +1,62 @@
+{
+    "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)"
+        ]
+    },
+    "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

@@ -0,0 +1,17 @@
+{
+    "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"
+        ]
+    }
+}

package/src/documentation/generated/CmdOpeningHoursPropertyDescriptions.json

@@ -0,0 +1,42 @@
+{
+    "CmdHeadline": {
+        "comments": [
+            "properties for CmdHeadline-component"
+        ]
+    },
+    "link": {
+        "comments": [
+            "set a link to a detail page"
+        ]
+    },
+    "closed": {
+        "comments": [
+            "toggles if \"closed\"-text will be shown"
+        ],
+        "annotations": {
+            "affectsStyling": [
+                "true"
+            ]
+        }
+    },
+    "textOpenClosed": {
+        "comments": [
+            "text for open/closed-information"
+        ]
+    },
+    "openingHours": {
+        "comments": [
+            "list of opening-hours"
+        ]
+    },
+    "textHolidaysClosed": {
+        "comments": [
+            "text to show if holidays closed (shown below opening-hours)"
+        ]
+    },
+    "textMiscInfo": {
+        "comments": [
+            "additional/miscellaneous text (shown below holiday-closed-text/opening hours)"
+        ]
+    }
+}

package/src/documentation/generated/CmdPagerPropertyDescriptions.json

@@ -0,0 +1,37 @@
+{
+    "items": {
+        "comments": [
+            "number of items displayed"
+        ]
+    },
+    "itemsPerPage": {
+        "comments": [
+            "number of items shown per page"
+        ]
+    },
+    "showLinksAsButtons": {
+        "comments": [
+            "show links as buttons"
+        ]
+    },
+    "prevButton": {
+        "comments": [
+            "button to switch to previous page"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "nextButton": {
+        "comments": [
+            "button to switch to next page"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdProgressBarPropertyDescriptions.json

@@ -0,0 +1,32 @@
+{
+    "labelText": {
+        "comments": [
+            "label-text for progress-bar"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    },
+    "showLabel": {
+        "comments": [
+            "toggle visibility for label-text"
+        ]
+    },
+    "showLoadingStatus": {
+        "comments": [
+            "toggle visibility for loading-status"
+        ]
+    },
+    "id": {
+        "comments": [
+            "id for progress-bar"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    }
+}

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/CmdSiteFooterPropertyDescriptions.json

@@ -0,0 +1,12 @@
+{
+    "orientation": {
+        "comments": [
+            "set to vertical if items inside should be arranged vertically"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "horizontal, vertical"
+            ]
+        }
+    }
+}

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/CmdSwitchLanguagePropertyDescriptions.json

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

package/src/documentation/generated/CmdSystemMessagePropertyDescriptions.json

@@ -0,0 +1,45 @@
+{
+    "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"
+        ]
+    },
+    "messageHeadlineLevel": {
+        "comments": [
+            "set headline-level for system-message (given to CmdHeadline-component)"
+        ]
+    },
+    "iconClose": {
+        "comments": [
+            "icon to close system-message"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    }
+}