@db-ux/v-core-components 5.1.6 → 5.2.1-shell-797019e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/CHANGELOG.md +27 -3
  2. package/agent/ControlPanelBrand.md +15 -0
  3. package/agent/ControlPanelDesktop.md +48 -0
  4. package/agent/ControlPanelMeta.md +19 -0
  5. package/agent/ControlPanelMobile.md +40 -0
  6. package/agent/ControlPanelNavigation.md +24 -0
  7. package/agent/ControlPanelNavigationItem.md +39 -0
  8. package/agent/Shell.md +28 -0
  9. package/agent/_instructions.md +7 -0
  10. package/dist/components/accordion/accordion.vue.d.ts +1 -1
  11. package/dist/components/accordion/model.d.ts +2 -8
  12. package/dist/components/control-panel-actions/control-panel-actions-1.vue.d.ts +18 -0
  13. package/dist/components/control-panel-actions/control-panel-actions-2.vue.d.ts +18 -0
  14. package/dist/components/control-panel-actions/index.d.ts +2 -0
  15. package/dist/components/control-panel-actions/model.d.ts +9 -0
  16. package/dist/components/control-panel-brand/control-panel-brand.vue.d.ts +22 -0
  17. package/dist/components/control-panel-brand/index.d.ts +1 -0
  18. package/dist/components/control-panel-brand/model.d.ts +7 -0
  19. package/dist/components/control-panel-desktop/control-panel-desktop.vue.d.ts +35 -0
  20. package/dist/components/control-panel-desktop/index.d.ts +1 -0
  21. package/dist/components/control-panel-desktop/model.d.ts +7 -0
  22. package/dist/components/control-panel-flat-icon/control-panel-flat-icon.vue.d.ts +22 -0
  23. package/dist/components/control-panel-flat-icon/index.d.ts +1 -0
  24. package/dist/components/control-panel-flat-icon/model.d.ts +12 -0
  25. package/dist/components/control-panel-meta/control-panel-meta.vue.d.ts +18 -0
  26. package/dist/components/control-panel-meta/index.d.ts +1 -0
  27. package/dist/components/control-panel-meta/model.d.ts +5 -0
  28. package/dist/components/control-panel-mobile/control-panel-mobile.vue.d.ts +33 -0
  29. package/dist/components/control-panel-mobile/index.d.ts +1 -0
  30. package/dist/components/control-panel-mobile/model.d.ts +21 -0
  31. package/dist/components/control-panel-navigation/control-panel-navigation.vue.d.ts +26 -0
  32. package/dist/components/control-panel-navigation/index.d.ts +1 -0
  33. package/dist/components/control-panel-navigation/model.d.ts +27 -0
  34. package/dist/components/control-panel-navigation-item/control-panel-navigation-item.vue.d.ts +27 -0
  35. package/dist/components/control-panel-navigation-item/index.d.ts +1 -0
  36. package/dist/components/control-panel-navigation-item/model.d.ts +16 -0
  37. package/dist/components/control-panel-navigation-item-group/control-panel-navigation-item-group.vue.d.ts +32 -0
  38. package/dist/components/control-panel-navigation-item-group/index.d.ts +1 -0
  39. package/dist/components/control-panel-navigation-item-group/model.d.ts +42 -0
  40. package/dist/components/control-panel-skip-navigation/control-panel-skip-navigation.vue.d.ts +21 -0
  41. package/dist/components/control-panel-skip-navigation/index.d.ts +1 -0
  42. package/dist/components/control-panel-skip-navigation/model.d.ts +16 -0
  43. package/dist/components/custom-select/custom-select.vue.d.ts +1 -1
  44. package/dist/components/custom-select/model.d.ts +1 -1
  45. package/dist/components/custom-select-list/custom-select-list.vue.d.ts +1 -1
  46. package/dist/components/drawer/model.d.ts +1 -0
  47. package/dist/components/header/header.vue.d.ts +2 -2
  48. package/dist/components/heading/custom-heading.vue.d.ts +27 -0
  49. package/dist/components/heading/heading-h1.vue.d.ts +24 -0
  50. package/dist/components/heading/heading-h2.vue.d.ts +24 -0
  51. package/dist/components/heading/heading-h3.vue.d.ts +24 -0
  52. package/dist/components/heading/heading-h4.vue.d.ts +24 -0
  53. package/dist/components/heading/heading-h5.vue.d.ts +24 -0
  54. package/dist/components/heading/heading-h6.vue.d.ts +24 -0
  55. package/dist/components/heading/index.d.ts +7 -0
  56. package/dist/components/heading/model.d.ts +73 -0
  57. package/dist/components/input/input.vue.d.ts +1 -1
  58. package/dist/components/navigation-item/navigation-item.vue.d.ts +2 -2
  59. package/dist/components/notification/notification.vue.d.ts +1 -1
  60. package/dist/components/popover/popover.vue.d.ts +1 -0
  61. package/dist/components/select/select.vue.d.ts +1 -1
  62. package/dist/components/shell/index.d.ts +1 -0
  63. package/dist/components/shell/model.d.ts +38 -0
  64. package/dist/components/shell/shell.vue.d.ts +25 -0
  65. package/dist/components/shell-content/index.d.ts +1 -0
  66. package/dist/components/shell-content/model.d.ts +28 -0
  67. package/dist/components/shell-content/shell-content.vue.d.ts +27 -0
  68. package/dist/components/shell-sub-navigation/index.d.ts +1 -0
  69. package/dist/components/shell-sub-navigation/model.d.ts +7 -0
  70. package/dist/components/shell-sub-navigation/shell-sub-navigation.vue.d.ts +23 -0
  71. package/dist/components/stack/stack.vue.d.ts +1 -1
  72. package/dist/components/tooltip/tooltip.vue.d.ts +1 -0
  73. package/dist/db-ux.es.js +3040 -1512
  74. package/dist/db-ux.umd.js +1 -1
  75. package/dist/index.d.ts +28 -0
  76. package/dist/shared/constants.d.ts +5 -1
  77. package/dist/shared/model.d.ts +94 -3
  78. package/dist/utils/floating-components.d.ts +7 -2
  79. package/dist/utils/index.d.ts +10 -0
  80. package/dist/utils/navigation.d.ts +30 -11
  81. package/package.json +5 -5
@@ -0,0 +1,38 @@
1
+ import { GlobalProps, GlobalState, ShellControlPanelDesktopPositionType, ShellControlPanelMobilePositionType } from '../../shared/model.js';
2
+ export declare const ShellSubNavigationMobilePosition: readonly ["top", "bottom", "none"];
3
+ export type ShellSubNavigationMobilePositionType = (typeof ShellSubNavigationMobilePosition)[number];
4
+ export type DBShellDefaultProps = {
5
+ /**
6
+ * Change the position of the desktop content panel
7
+ */
8
+ controlPanelDesktopPosition?: ShellControlPanelDesktopPositionType;
9
+ /**
10
+ * Change the position of the mobile content panel
11
+ */
12
+ controlPanelMobilePosition?: ShellControlPanelMobilePositionType;
13
+ /**
14
+ * Set this to have a transition with opacity to avoid layout-shifts https://simonhearne.com/2021/layout-shifts-webfonts/
15
+ */
16
+ fadeIn?: boolean | string;
17
+ /**
18
+ * Change the position of the optional sub navigation for desktop
19
+ */
20
+ subNavigationDesktopPosition?: ShellControlPanelDesktopPositionType;
21
+ /**
22
+ * Change the position of the optional sub navigation for mobile
23
+ */
24
+ subNavigationMobilePosition?: ShellSubNavigationMobilePositionType;
25
+ /**
26
+ * Shows sub-navigation
27
+ */
28
+ showSubNavigation?: boolean | string;
29
+ };
30
+ export type DBShellProps = DBShellDefaultProps & GlobalProps;
31
+ export type DBShellDefaultState = {
32
+ fontsLoaded?: boolean;
33
+ _controlPanelDesktopPosition?: ShellControlPanelDesktopPositionType;
34
+ _controlPanelMobilePosition?: ShellControlPanelMobilePositionType;
35
+ _subNavigationDesktopPosition?: ShellControlPanelDesktopPositionType;
36
+ _subNavigationMobilePosition?: ShellSubNavigationMobilePositionType;
37
+ };
38
+ export type DBShellState = DBShellDefaultState & GlobalState;
@@ -0,0 +1,25 @@
1
+ import { DBShellProps } from "./model.js";
2
+ declare var __VLS_1: {};
3
+ type __VLS_Slots = {} & {
4
+ default?: (props: typeof __VLS_1) => any;
5
+ };
6
+ declare const __VLS_base: import("@vue/runtime-core").DefineComponent<DBShellProps, {}, {}, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {}, string, import("@vue/runtime-core").PublicProps, Readonly<DBShellProps> & Readonly<{}>, {
7
+ id: string;
8
+ children: any;
9
+ className: string;
10
+ propOverrides: import("../../index.js", { with: { "resolution-mode": "import" } }).PropOverridesType;
11
+ fadeIn: boolean | string;
12
+ controlPanelDesktopPosition: import("../../index.js", { with: { "resolution-mode": "import" } }).ShellControlPanelDesktopPositionType;
13
+ controlPanelMobilePosition: import("../../index.js", { with: { "resolution-mode": "import" } }).ShellControlPanelMobilePositionType;
14
+ subNavigationDesktopPosition: import("../../index.js", { with: { "resolution-mode": "import" } }).ShellControlPanelDesktopPositionType;
15
+ subNavigationMobilePosition: import("./model.js", { with: { "resolution-mode": "import" } }).ShellSubNavigationMobilePositionType;
16
+ showSubNavigation: boolean | string;
17
+ }, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
18
+ declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
19
+ declare const _default: typeof __VLS_export;
20
+ export default _default;
21
+ type __VLS_WithSlots<T, S> = T & {
22
+ new (): {
23
+ $slots: S;
24
+ };
25
+ };
@@ -0,0 +1 @@
1
+ export { default as DBShellContent } from './shell-content.vue';
@@ -0,0 +1,28 @@
1
+ import type { EndSlotProps, GlobalProps, GlobalState, StartSlotProps } from '../../shared/model.js';
2
+ export declare const ShellContentVariantList: readonly ["auto", "fixed"];
3
+ export type ShellContentVariantType = (typeof ShellContentVariantList)[number];
4
+ export type DBShellContentDefaultProps = {
5
+ /**
6
+ * Adds `class` to `<main>` element
7
+ */
8
+ mainClass?: string;
9
+ /**
10
+ * Overrides the default `id` on the `<main>` element.
11
+ * This id is used as the target for the shell skip-navigation link.
12
+ * Only one `DBShellContent` should exist per page to avoid duplicate IDs.
13
+ * @default 'main-content'
14
+ */
15
+ mainId?: string;
16
+ /**
17
+ * Adds `aria-label` to `<main>` element
18
+ */
19
+ mainLabel?: string;
20
+ /**
21
+ * Change the scrolling behavior. `auto` scrolling on complete wrapper, `fixed` scrolling only in for main.
22
+ * @default auto
23
+ */
24
+ variant?: ShellContentVariantType;
25
+ };
26
+ export type DBShellContentProps = DBShellContentDefaultProps & GlobalProps & StartSlotProps & EndSlotProps;
27
+ export type DBShellContentDefaultState = {};
28
+ export type DBShellContentState = DBShellContentDefaultState & GlobalState;
@@ -0,0 +1,27 @@
1
+ import { DBShellContentProps } from "./model.js";
2
+ declare var __VLS_1: {}, __VLS_3: {}, __VLS_5: {};
3
+ type __VLS_Slots = {} & {
4
+ 'start-slot'?: (props: typeof __VLS_1) => any;
5
+ } & {
6
+ default?: (props: typeof __VLS_3) => any;
7
+ } & {
8
+ 'end-slot'?: (props: typeof __VLS_5) => any;
9
+ };
10
+ declare const __VLS_base: import("@vue/runtime-core").DefineComponent<DBShellContentProps, {}, {}, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {}, string, import("@vue/runtime-core").PublicProps, Readonly<DBShellContentProps> & Readonly<{}>, {
11
+ id: string;
12
+ children: any;
13
+ className: string;
14
+ propOverrides: import("../../index.js", { with: { "resolution-mode": "import" } }).PropOverridesType;
15
+ variant: import("./model.js", { with: { "resolution-mode": "import" } }).ShellContentVariantType;
16
+ mainClass: string;
17
+ mainId: string;
18
+ mainLabel: string;
19
+ }, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
20
+ declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
21
+ declare const _default: typeof __VLS_export;
22
+ export default _default;
23
+ type __VLS_WithSlots<T, S> = T & {
24
+ new (): {
25
+ $slots: S;
26
+ };
27
+ };
@@ -0,0 +1 @@
1
+ export { default as DBShellSubNavigation } from './shell-sub-navigation.vue';
@@ -0,0 +1,7 @@
1
+ import { GlobalProps, GlobalState, SidebarProps, SidebarState, ToggleEventState } from '../../shared/model.js';
2
+ export type DBShellSubNavigationDefaultProps = {};
3
+ export type DBShellSubNavigationProps = DBShellSubNavigationDefaultProps & GlobalProps & SidebarProps;
4
+ export type DBShellSubNavigationDefaultState = {
5
+ syncExpanded: () => void;
6
+ };
7
+ export type DBShellSubNavigationState = DBShellSubNavigationDefaultState & GlobalState & ToggleEventState<HTMLButtonElement> & SidebarState;
@@ -0,0 +1,23 @@
1
+ import { DBShellSubNavigationProps } from "./model.js";
2
+ declare var __VLS_1: {};
3
+ type __VLS_Slots = {} & {
4
+ default?: (props: typeof __VLS_1) => any;
5
+ };
6
+ declare const __VLS_base: import("@vue/runtime-core").DefineComponent<DBShellSubNavigationProps, {}, {}, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {}, string, import("@vue/runtime-core").PublicProps, Readonly<DBShellSubNavigationProps> & Readonly<{}>, {
7
+ id: string;
8
+ children: any;
9
+ className: string;
10
+ propOverrides: import("../../index.js", { with: { "resolution-mode": "import" } }).PropOverridesType;
11
+ expanded: boolean | string;
12
+ expandButtonTooltip: string;
13
+ expandButtonTooltipFn: (open: boolean) => string;
14
+ onExpandButtonTooltipFn: (open: boolean) => string;
15
+ }, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
16
+ declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
17
+ declare const _default: typeof __VLS_export;
18
+ export default _default;
19
+ type __VLS_WithSlots<T, S> = T & {
20
+ new (): {
21
+ $slots: S;
22
+ };
23
+ };
@@ -11,8 +11,8 @@ declare const __VLS_base: import("@vue/runtime-core").DefineComponent<DBStackPro
11
11
  variant: import("./model.js", { with: { "resolution-mode": "import" } }).StackVariantType;
12
12
  wrap: boolean | string;
13
13
  direction: import("./model.js", { with: { "resolution-mode": "import" } }).StackDirectionType;
14
- gap: import("../../index.js", { with: { "resolution-mode": "import" } }).GapSpacingType;
15
14
  alignment: import("./model.js", { with: { "resolution-mode": "import" } }).StackAlignmentType;
15
+ gap: import("../../index.js", { with: { "resolution-mode": "import" } }).GapSpacingType;
16
16
  justifyContent: import("./model.js", { with: { "resolution-mode": "import" } }).StackJustifyContentType;
17
17
  }, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
18
18
  declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
@@ -14,6 +14,7 @@ declare const __VLS_base: import("@vue/runtime-core").DefineComponent<DBTooltipP
14
14
  emphasis: import("../../shared/model.js", { with: { "resolution-mode": "import" } }).EmphasisType;
15
15
  wrap: boolean | string;
16
16
  width: import("../../shared/model.js", { with: { "resolution-mode": "import" } }).PopoverWidthType;
17
+ forceAbsolute: boolean | string;
17
18
  showArrow: boolean | string;
18
19
  delay: import("../../shared/model.js", { with: { "resolution-mode": "import" } }).PopoverDelayType;
19
20
  animation: boolean | string;