comand-component-library 3.1.45 → 3.1.46

package/src/documentation/generated/CmdFormElementPropertyDescriptions.json

@@ -0,0 +1,178 @@
+{
+    "modelValue": {
+        "comments": [
+            "set value for v-model (must be names modelValue in vue3)"
+        ]
+    },
+    "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"
+            ]
+        }
+    },
+    "htmlClass": {
+        "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, success",
+                ""
+            ],
+            "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'",
+            ""
+        ]
+    }
+}

package/src/documentation/generated/CmdFormFiltersPropertyDescriptions.json

@@ -0,0 +1,32 @@
+{
+    "modelValue": {
+        "comments": [
+            "list of all selected options"
+        ]
+    },
+    "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"
+        ]
+    }
+}

package/src/documentation/generated/CmdFormPropertyDescriptions.json

@@ -0,0 +1,40 @@
+{
+    "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"
+            ]
+        }
+    },
+    "showLegend": {
+        "comments": [
+            "toggle visibility for legend-text",
+            "",
+            "useFieldset must be activated"
+        ]
+    },
+    "textLegend": {
+        "comments": [
+            "text for legend",
+            "useFieldset must be activated"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdGoogleMapsPropertyDescriptions.json

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

package/src/documentation/generated/CmdImageGalleryPropertyDescriptions.json

@@ -0,0 +1,22 @@
+{
+    "images": {
+        "comments": [
+            "list of images (incl. captions)"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "partial"
+            ]
+        }
+    },
+    "figcaptionPosition": {
+        "comments": [
+            "position of figcaption"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "top, bottom"
+            ]
+        }
+    }
+}

package/src/documentation/generated/CmdImageZoomPropertyDescriptions.json

@@ -0,0 +1,12 @@
+{
+    "smallImageUrl": {
+        "comments": [
+            "url for small images"
+        ]
+    },
+    "largeImageUrl": {
+        "comments": [
+            "url for large image"
+        ]
+    }
+}

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"
+            ]
+        }
+    },
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for cmdCustomHeadline-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/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"
+            ]
+        }
+    },
+    "cmdCustomHeadlineLoginForm": {
+        "comments": [
+            "properties for CmdCustomHeadline-component for login-form"
+        ]
+    },
+    "cmdCustomHeadlineSendLoginForm": {
+        "comments": [
+            "properties for CmdCustomHeadline-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/CmdMultipleSwitchPropertyDescriptions.json

@@ -0,0 +1,52 @@
+{
+    "value": {
+        "comments": [
+            "value for v-model"
+        ]
+    },
+    "showLabel": {
+        "comments": [
+            "toggle label visibility"
+        ]
+    },
+    "labelText": {
+        "comments": [
+            "text for label"
+        ],
+        "annotations": {
+            "requiredForAccessibility": [
+                "true"
+            ]
+        }
+    },
+    "multipleSwitches": {
+        "comments": [
+            "list of switches"
+        ]
+    },
+    "switchTypes": {
+        "comments": [
+            "set type for switches"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "checkbox, radio"
+            ]
+        }
+    },
+    "switchNames": {
+        "comments": [
+            "name-attribute for switches"
+        ]
+    },
+    "status": {
+        "comments": [
+            "status for all switches"
+        ],
+        "annotations": {
+            "allowedValues": [
+                "error, disabled"
+            ]
+        }
+    }
+}

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 @@
+{
+    "cmdCustomHeadline": {
+        "comments": [
+            "properties for CmdCustomHeadline-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"
+            ]
+        }
+    }
+}