From 1743e34a1e9de21cc9c75ae91ab1e416f5b54f4b Mon Sep 17 00:00:00 2001 From: vc-shell-docs-bot Date: Wed, 13 May 2026 09:58:16 +0000 Subject: [PATCH] docs: manual sync from vc-shell (manual-20260513-095815) --- .../vc-shell/components/.pages | 11 + .../vc-shell/components/data-display/.pages | 8 + .../components/data-display/vc-accordion.md | 311 +++ .../components/data-display/vc-data-table.md | 2036 +++++++++++++++++ .../components/data-display/vc-gallery.md | 222 ++ .../components/data-display/vc-image-tile.md | 180 ++ .../vc-shell/components/feedback/.pages | 14 + .../vc-shell/components/feedback/vc-banner.md | 184 ++ .../vc-shell/components/feedback/vc-hint.md | 156 ++ .../components/feedback/vc-loading.md | 150 ++ .../vc-shell/components/feedback/vc-popup.md | 595 +++++ .../components/feedback/vc-progress.md | 191 ++ .../components/feedback/vc-skeleton.md | 148 ++ .../components/feedback/vc-status-icon.md | 173 ++ .../vc-shell/components/feedback/vc-status.md | 143 ++ .../vc-shell/components/feedback/vc-toast.md | 337 +++ .../components/feedback/vc-tooltip.md | 358 +++ .../vc-shell/components/form/.pages | 26 + .../components/form/multilanguage-selector.md | 160 ++ .../components/form/vc-checkbox-group.md | 171 ++ .../vc-shell/components/form/vc-checkbox.md | 394 ++++ .../components/form/vc-color-input.md | 228 ++ .../components/form/vc-date-picker.md | 384 ++++ .../components/form/vc-dynamic-property.md | 184 ++ .../vc-shell/components/form/vc-editor.md | 332 +++ .../vc-shell/components/form/vc-field.md | 260 +++ .../components/form/vc-file-upload.md | 365 +++ .../vc-shell/components/form/vc-form.md | 563 +++++ .../components/form/vc-input-currency.md | 373 +++ .../components/form/vc-input-dropdown.md | 337 +++ .../components/form/vc-input-group.md | 138 ++ .../vc-shell/components/form/vc-input.md | 819 +++++++ .../vc-shell/components/form/vc-multivalue.md | 383 ++++ .../components/form/vc-radio-button.md | 231 ++ .../components/form/vc-radio-group.md | 171 ++ .../vc-shell/components/form/vc-rating.md | 307 +++ .../vc-shell/components/form/vc-select.md | 735 ++++++ .../vc-shell/components/form/vc-slider.md | 150 ++ .../vc-shell/components/form/vc-switch.md | 324 +++ .../vc-shell/components/form/vc-textarea.md | 332 +++ .../vc-shell/components/layout/.pages | 13 + .../vc-shell/components/layout/vc-app.md | 251 ++ .../components/layout/vc-auth-layout.md | 236 ++ .../vc-shell/components/layout/vc-blade.md | 715 ++++++ .../vc-shell/components/layout/vc-card.md | 431 ++++ .../vc-shell/components/layout/vc-col.md | 170 ++ .../components/layout/vc-container.md | 141 ++ .../vc-shell/components/layout/vc-row.md | 181 ++ .../layout/vc-scrollable-container.md | 160 ++ .../vc-shell/components/layout/vc-sidebar.md | 248 ++ .../vc-shell/components/media/.pages | 7 + .../components/media/vc-image-upload.md | 163 ++ .../vc-shell/components/media/vc-image.md | 117 + .../vc-shell/components/media/vc-video.md | 146 ++ .../vc-shell/components/misc/.pages | 9 + .../vc-shell/components/misc/vc-badge.md | 161 ++ .../vc-shell/components/misc/vc-button.md | 352 +++ .../vc-shell/components/misc/vc-icon.md | 142 ++ .../vc-shell/components/misc/vc-label.md | 185 ++ .../vc-shell/components/misc/vc-widget.md | 139 ++ .../vc-shell/components/navigation/.pages | 10 + .../components/navigation/vc-breadcrumbs.md | 314 +++ .../navigation/vc-dropdown-panel.md | 169 ++ .../components/navigation/vc-dropdown.md | 399 ++++ .../vc-shell/components/navigation/vc-link.md | 165 ++ .../vc-shell/components/navigation/vc-menu.md | 149 ++ .../components/navigation/vc-pagination.md | 320 +++ .../vc-shell/composables/.pages | 12 + .../composables/blade-navigation/.pages | 9 + .../blade-navigation/blade-nav-composables.md | 152 ++ .../composables/blade-navigation/useBlade.md | 764 +++++++ .../blade-navigation/useBladeContext.md | 119 + .../blade-navigation/useBladeRegistry.md | 158 ++ .../blade-navigation/useBladeWidgets.md | 308 +++ .../vc-shell/composables/data/.pages | 12 + .../composables/data/table-composables.md | 163 ++ .../vc-shell/composables/data/useApiClient.md | 305 +++ .../vc-shell/composables/data/useAssets.md | 141 ++ .../composables/data/useAssetsManager.md | 158 ++ .../data/useDataTablePagination.md | 169 ++ .../composables/data/useDataTableSort.md | 148 ++ .../composables/data/useTableSelection.md | 162 ++ .../vc-shell/composables/data/useTableSort.md | 153 ++ .../vc-shell/composables/forms/.pages | 7 + .../composables/forms/useBladeForm.md | 172 ++ .../composables/forms/useDynamicProperties.md | 165 ++ .../forms/useModificationTracker.md | 134 ++ .../vc-shell/composables/notifications/.pages | 6 + .../notifications/useNotifications.md | 159 ++ .../composables/notifications/usePopup.md | 211 ++ .../vc-shell/composables/services/.pages | 13 + .../vc-shell/composables/services/index.md | 80 + .../services/useAppBarMobileButtons.md | 128 ++ .../composables/services/useAppBarWidget.md | 190 ++ .../composables/services/useDashboard.md | 405 ++++ .../composables/services/useMenuService.md | 350 +++ .../composables/services/useSettings.md | 191 ++ .../composables/services/useSettingsMenu.md | 179 ++ .../composables/services/useToolbar.md | 374 +++ .../composables/services/useWidgets.md | 143 ++ .../vc-shell/composables/ui-state/.pages | 14 + .../ui-state/ui-composables-overview.md | 105 + .../composables/ui-state/useBreadcrumbs.md | 185 ++ .../ui-state/useConnectionStatus.md | 113 + .../ui-state/useKeyboardNavigation.md | 172 ++ .../composables/ui-state/useLoading.md | 122 + .../composables/ui-state/useMenuExpanded.md | 83 + .../composables/ui-state/useResponsive.md | 200 ++ .../composables/ui-state/useSidebarState.md | 133 ++ .../ui-state/useSlowNetworkDetection.md | 151 ++ .../vc-shell/composables/ui-state/useTheme.md | 141 ++ .../vc-shell/composables/user/.pages | 8 + .../vc-shell/composables/user/useLanguages.md | 157 ++ .../composables/user/usePermissions.md | 288 +++ .../composables/user/usePlatformLocaleSync.md | 33 + .../vc-shell/composables/user/useUser.md | 177 ++ .../vc-shell/composables/utilities/.pages | 10 + .../composables/utilities/useAppInsights.md | 119 + .../composables/utilities/useAsync.md | 422 ++++ .../composables/utilities/useBeforeUnload.md | 112 + .../composables/utilities/useErrorHandler.md | 168 ++ .../composables/utilities/useFunctions.md | 119 + .../composables/utilities/useWebVitals.md | 135 ++ .../vc-shell/plugins/.pages | 13 + .../vc-shell/plugins/ai-agent.md | 167 ++ .../vc-shell/plugins/extension-points.md | 685 ++++++ .../vc-shell/plugins/global-error-handler.md | 153 ++ .../vc-shell/plugins/i18n.md | 263 +++ .../vc-shell/plugins/modularity.md | 965 ++++++++ .../vc-shell/plugins/notifications.md | 246 ++ .../vc-shell/plugins/permissions.md | 173 ++ .../vc-shell/plugins/signalr.md | 170 ++ .../vc-shell/plugins/validation.md | 243 ++ .../vc-shell/reference/api/.pages | 12 + .../vc-shell/reference/api/date-utilities.md | 105 + .../vc-shell/reference/api/directives/.pages | 6 + .../reference/api/directives/v-autofocus.md | 130 ++ .../reference/api/directives/v-loading.md | 178 ++ .../vc-shell/reference/api/injection-keys.md | 174 ++ .../vc-shell/reference/api/platform-client.md | 173 ++ .../reference/api/shared-utilities.md | 91 + .../vc-shell/reference/api/thumbnail.md | 118 + .../vc-shell/reference/api/types-core.md | 191 ++ .../vc-shell/reference/api/types-ui.md | 181 ++ .../reference/api/utilities-overview.md | 187 ++ .../vc-shell/reference/modules/.pages | 6 + .../reference/modules/assets-manager.md | 166 ++ .../vc-shell/reference/modules/assets.md | 121 + 148 files changed, 32001 insertions(+) create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/vc-accordion.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/vc-data-table.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/vc-gallery.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/vc-image-tile.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/vc-banner.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/vc-hint.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/vc-loading.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/vc-popup.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/vc-progress.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/vc-skeleton.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/vc-status-icon.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/vc-status.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/vc-toast.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/feedback/vc-tooltip.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/multilanguage-selector.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-checkbox-group.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-checkbox.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-color-input.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-date-picker.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-dynamic-property.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-editor.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-field.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-file-upload.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-form.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-input-currency.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-input-dropdown.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-input-group.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-input.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-multivalue.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-radio-button.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-radio-group.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-rating.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-select.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-slider.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-switch.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/form/vc-textarea.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/layout/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/layout/vc-app.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/layout/vc-auth-layout.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/layout/vc-blade.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/layout/vc-card.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/layout/vc-col.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/layout/vc-container.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/layout/vc-row.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/layout/vc-scrollable-container.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/layout/vc-sidebar.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/media/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/media/vc-image-upload.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/media/vc-image.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/media/vc-video.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/misc/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/misc/vc-badge.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/misc/vc-button.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/misc/vc-icon.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/misc/vc-label.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/misc/vc-widget.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/navigation/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/navigation/vc-breadcrumbs.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/navigation/vc-dropdown-panel.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/navigation/vc-dropdown.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/navigation/vc-link.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/navigation/vc-menu.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/components/navigation/vc-pagination.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/blade-navigation/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/blade-navigation/blade-nav-composables.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/blade-navigation/useBlade.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/blade-navigation/useBladeContext.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/blade-navigation/useBladeRegistry.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/blade-navigation/useBladeWidgets.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/data/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/data/table-composables.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/data/useApiClient.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/data/useAssets.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/data/useAssetsManager.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/data/useDataTablePagination.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/data/useDataTableSort.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/data/useTableSelection.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/data/useTableSort.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/forms/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/forms/useBladeForm.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/forms/useDynamicProperties.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/forms/useModificationTracker.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/notifications/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/notifications/useNotifications.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/notifications/usePopup.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/services/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/services/index.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/services/useAppBarMobileButtons.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/services/useAppBarWidget.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/services/useDashboard.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/services/useMenuService.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/services/useSettings.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/services/useSettingsMenu.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/services/useToolbar.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/services/useWidgets.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/ui-composables-overview.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/useBreadcrumbs.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/useConnectionStatus.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/useKeyboardNavigation.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/useLoading.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/useMenuExpanded.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/useResponsive.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/useSidebarState.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/useSlowNetworkDetection.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/ui-state/useTheme.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/user/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/user/useLanguages.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/user/usePermissions.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/user/usePlatformLocaleSync.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/user/useUser.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/utilities/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/utilities/useAppInsights.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/utilities/useAsync.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/utilities/useBeforeUnload.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/utilities/useErrorHandler.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/utilities/useFunctions.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/composables/utilities/useWebVitals.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/plugins/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/plugins/ai-agent.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/plugins/extension-points.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/plugins/global-error-handler.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/plugins/i18n.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/plugins/modularity.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/plugins/notifications.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/plugins/permissions.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/plugins/signalr.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/plugins/validation.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/date-utilities.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/directives/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/directives/v-autofocus.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/directives/v-loading.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/injection-keys.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/platform-client.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/shared-utilities.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/thumbnail.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/types-core.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/types-ui.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/api/utilities-overview.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/modules/.pages create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/modules/assets-manager.md create mode 100644 platform/developer-guide/docs/custom-apps-development/vc-shell/reference/modules/assets.md diff --git a/platform/developer-guide/docs/custom-apps-development/vc-shell/components/.pages b/platform/developer-guide/docs/custom-apps-development/vc-shell/components/.pages new file mode 100644 index 0000000000..111529b9fc --- /dev/null +++ b/platform/developer-guide/docs/custom-apps-development/vc-shell/components/.pages @@ -0,0 +1,11 @@ +# AUTO-GENERATED FROM vc-shell — DO NOT EDIT MANUALLY +# To update: edit a *.docs.md in vc-shell, then run yarn docs:sync +title: Components +nav: + - layout + - form + - data-display + - feedback + - navigation + - media + - misc diff --git a/platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/.pages b/platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/.pages new file mode 100644 index 0000000000..7908a3783d --- /dev/null +++ b/platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/.pages @@ -0,0 +1,8 @@ +# AUTO-GENERATED FROM vc-shell — DO NOT EDIT MANUALLY +# To update: edit a *.docs.md in vc-shell, then run yarn docs:sync +title: Data Display +nav: + - VcAccordion: vc-accordion.md + - VcDataTable: vc-data-table.md + - VcGallery: vc-gallery.md + - VcImageTile: vc-image-tile.md diff --git a/platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/vc-accordion.md b/platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/vc-accordion.md new file mode 100644 index 0000000000..8974098497 --- /dev/null +++ b/platform/developer-guide/docs/custom-apps-development/vc-shell/components/data-display/vc-accordion.md @@ -0,0 +1,311 @@ + + + + + +# VcAccordion + +Collapsible content sections with smooth CSS grid animations, customizable collapsed heights with fade-out preview, and four visual variants. Supports both data-driven rendering via `items` array and slot-based composition with `VcAccordionItem`. + +## When to Use + +- FAQ sections, expandable product details, or grouped settings +- Progressive disclosure to reduce visual clutter on content-heavy pages +- Partial content preview in collapsed state (via `collapsedHeight`) +- Expandable form sections or configuration panels + +When NOT to use: + +- For navigation groups -- use `VcMenuGroup` +- For tab-based content switching -- use `VcTabs` +- For single collapsible panels without siblings -- use `VcAccordionItem` directly + +## Quick Start + +
+ + Open in Storybook ↗ +
+ +```vue + + + +``` + +## Features + +!!! tip "Use v-model to control initial open state" +Without `v-model`, no items are expanded on mount. Pass an initial value to pre-open a specific item. + +### Visual Variants + +Four variants control the visual grouping and spacing of accordion items. + +| Variant | Description | +| ----------- | ------------------------------------------------------------------------ | +| `default` | Items stacked with shared top/bottom borders, no gaps | +| `bordered` | Single outer border wrapping all items, items separated by inner borders | +| `separated` | Card-like items with 12px gaps between them, each with its own border | +| `ghost` | Transparent background, minimal styling, no borders or padding | + +```vue + +``` + +### Controlled with v-model + +Use `v-model` to control which items are expanded. In single mode, the value is a single `string | number`. In multiple mode, the value is an array. + +```vue + + + +``` + + + +### Multiple Open Items + +Set `multiple` to `true` to allow expanding several items simultaneously. The `v-model` value becomes an array. + +```vue + +``` + + + +### Partial Content Preview (collapsedHeight) + +When `collapsedHeight` > 0, collapsed items show that many pixels of content with a fade-out gradient. The chevron only appears when content overflows. + +```vue + +``` + +### Maximum Expanded Height + +Limit expanded content height with `maxExpandedHeight`. Content scrolls when it exceeds the limit. + +```vue + +``` + +### Per-Item Height Overrides + +Each item can override the global `collapsedHeight` and `maxExpandedHeight`: + +```ts +const items = [ + { id: "summary", title: "Summary", content: longText, collapsedHeight: 0 }, + { id: "preview", title: "Description", content: longText, collapsedHeight: 80 }, + { id: "terms", title: "Terms", content: veryLongText, maxExpandedHeight: 300 }, +]; +``` + +### Custom Title and Slot-based Composition + +For full control, use the default slot with `VcAccordionItem` children instead of the `items` prop. + +```vue + + + + Details about the new feature... + + Standard content. + +``` + +### Dynamic Component Content + +The `content` property in `AccordionItem` accepts both strings and Vue components, allowing you to embed interactive content inside accordion panels. + +## Recipes + +### FAQ Page with Preselected Item + +```vue + + + +``` + +## Common Mistakes + +### 1. Expecting items to open by default without v-model + +```vue + + + + + +``` + +### 2. Mixing items prop with default slot + +Both render together -- items-prop items appear first, then slot content. Omit `items` if using only slots. + +### 3. Using multiple mode with single-value v-model + +```vue + + + + + +``` + +## AccordionItem Interface + +```ts +interface AccordionItem { + id?: string | number; // Unique identifier (falls back to array index) + title: string; // Header text + content?: string | Component; // Body content (string or Vue component) + titleSlot?: Component; // Custom title component (alternative to #title slot) + collapsedHeight?: number; // Per-item collapsed height override (px) + maxExpandedHeight?: number; // Per-item max expanded height override (px) + disabled?: boolean; // Prevents toggling this item +} +``` + +## Props + +| Prop | Type | Default | Description | +| ------------------- | --------------------------------------------------- | ----------- | ----------------------------------------------------- | +| `items` | `AccordionItem[]` | `[]` | Array of items to render | +| `modelValue` | `(string \| number) \| (string \| number)[]` | -- | Controlled expanded state via `v-model` | +| `multiple` | `boolean` | `false` | Allow multiple items to be expanded simultaneously | +| `variant` | `"default" \| "bordered" \| "separated" \| "ghost"` | `"default"` | Visual style variant | +| `collapsedHeight` | `number` | `0` | Default collapsed height in pixels for all items | +| `maxExpandedHeight` | `number` | -- | Maximum expanded height (content scrolls if exceeded) | + +## Events + +| Event | Payload | Description | +| ------------------- | -------------------------------------------- | ------------------------------------ | +| `update:modelValue` | `(string \| number) \| (string \| number)[]` | Emitted when expanded item(s) change | + +## Slots + +| Slot | Description | +| --------- | ---------------------------------------------------------------- | +| `default` | Place `VcAccordionItem` components directly for custom rendering | + +### VcAccordionItem Slots + +| Slot | Description | +| --------- | ------------------------------------------------------- | +| `title` | Custom title rendering (replaces the `title` prop text) | +| `default` | Content body of the accordion item | + +## CSS Variables + +| Variable | Default | Description | +| ------------------------------------------ | ---------------------- | ----------------------------------------- | +| `--accordion-item-border-color` | `var(--neutrals-200)` | Border color for items and dividers | +| `--accordion-item-border-radius` | `6px` | Border radius of item containers | +| `--accordion-item-header-padding` | `12px 16px` | Header button padding | +| `--accordion-item-header-background` | `var(--additional-50)` | Header background color | +| `--accordion-item-header-background-hover` | `var(--neutrals-50)` | Header background on hover | +| `--accordion-item-header-color` | `var(--secondary-950)` | Header text color | +| `--accordion-item-content-padding` | `16px` | Content body padding | +| `--accordion-item-content-background` | `var(--additional-50)` | Content body background | +| `--accordion-item-transition-duration` | `300ms` | Expand/collapse animation duration | +| `--accordion-item-fade-height` | `60px` | Fade gradient height on collapsed preview | +| `--accordion-item-focus-ring-color` | `var(--primary-100)` | Focus ring color for keyboard navigation | + +> **Note:** The `ghost` variant overrides several variables to transparent/zero values for minimal appearance. + +## Accessibility + +- Each header is a focusable `