@pantograph/vue 0.33.12 → 0.33.13

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.
@@ -0,0 +1,221 @@
1
+ import { ClassValue } from 'clsx';
2
+ import { ButtonProps } from '../Button';
3
+ import { CoachMarkTrigger } from './CoachMark.model';
4
+ import { HoverCardEmits, HoverCardProps, HoverCardSlots } from '../HoverCard';
5
+ import { FloatButtonProps } from '../FloatButton';
6
+ import { PopoverProps } from '../Popover';
7
+ import { PaginationProps } from '../Pagination';
8
+ /**
9
+ * Default props for the Next button in CoachMark
10
+ */
11
+ export declare const COACH_MARK_NEXT_DEFAULT_PROPS: {
12
+ readonly text: "Next";
13
+ };
14
+ /**
15
+ * Default props for the Previous button in CoachMark
16
+ */
17
+ export declare const COACH_MARK_PREV_DEFAULT_PROPS: {
18
+ readonly text: "Previous";
19
+ readonly type: "ghost";
20
+ readonly color: "neutral";
21
+ };
22
+ /**
23
+ * Default props for the step indicator (Pagination) in CoachMark
24
+ */
25
+ export declare const COACH_MARK_STEP_DEFAULT_PROPS: {
26
+ simple: boolean;
27
+ hidePerv: boolean;
28
+ hideNext: boolean;
29
+ hideSize: boolean;
30
+ hideTotal: boolean;
31
+ sizes: number[];
32
+ pageText: string;
33
+ justify: "between";
34
+ pervText: "Previous";
35
+ nextText: "Next";
36
+ total: 0;
37
+ disabled: undefined;
38
+ };
39
+ /**
40
+ * Default props for the CoachMark component
41
+ */
42
+ export declare const COACH_MARK_DEFAULT_PROPS: {
43
+ readonly trigger: "click";
44
+ readonly footer: true;
45
+ readonly width: 312;
46
+ readonly stepProps: () => {
47
+ simple: boolean;
48
+ hidePerv: boolean;
49
+ hideNext: boolean;
50
+ hideSize: boolean;
51
+ hideTotal: boolean;
52
+ sizes: number[];
53
+ pageText: string;
54
+ justify: "between";
55
+ pervText: "Previous";
56
+ nextText: "Next";
57
+ total: 0;
58
+ disabled: undefined;
59
+ };
60
+ readonly nextProps: () => {
61
+ readonly text: "Next";
62
+ };
63
+ readonly prevProps: () => {
64
+ readonly text: "Previous";
65
+ readonly type: "ghost";
66
+ readonly color: "neutral";
67
+ };
68
+ readonly open: undefined;
69
+ readonly size: "md";
70
+ readonly sticky: "always";
71
+ readonly prioritizePosition: true;
72
+ readonly avoidCollisions: true;
73
+ readonly placement: "bottom";
74
+ readonly zIndex: 1000;
75
+ readonly updatePositionStrategy: "optimized";
76
+ readonly renderPopupsInContent: true;
77
+ };
78
+ /**
79
+ * Props for the CoachMark component
80
+ */
81
+ export interface CoachMarkProps extends PopoverProps, HoverCardProps {
82
+ /** Step indicator configuration using Pagination component */
83
+ stepProps?: PaginationProps & {
84
+ hide?: boolean;
85
+ };
86
+ /** Width of the coach mark content in pixels */
87
+ width?: number;
88
+ /** Trigger type (click | hover) */
89
+ trigger?: CoachMarkTrigger;
90
+ /** Title text */
91
+ title?: string;
92
+ /** Description text */
93
+ description?: string;
94
+ /** Show footer with navigation buttons */
95
+ footer?: boolean;
96
+ /** Root classes */
97
+ class?: ClassValue;
98
+ /** Body classes */
99
+ bodyCls?: ClassValue;
100
+ /** Content classes */
101
+ contentCls?: ClassValue;
102
+ /** Wrapper classes (contains leading and body) */
103
+ wrapperCls?: ClassValue;
104
+ /** Title classes */
105
+ titleCls?: ClassValue;
106
+ /** Description classes */
107
+ descriptionCls?: ClassValue;
108
+ /** Footer classes */
109
+ footerCls?: ClassValue;
110
+ /** Leading/Media classes */
111
+ leadingCls?: ClassValue;
112
+ /** Close button classes */
113
+ closeCls?: ClassValue;
114
+ /** Next button configuration */
115
+ nextProps?: ButtonProps & {
116
+ text: string;
117
+ hide?: boolean;
118
+ };
119
+ /** Previous button configuration */
120
+ prevProps?: ButtonProps & {
121
+ text: string;
122
+ hide?: boolean;
123
+ };
124
+ /** Close button (FloatButton) configuration */
125
+ closeActionProps?: FloatButtonProps & {
126
+ showOnHover?: boolean;
127
+ show?: boolean;
128
+ };
129
+ }
130
+ /**
131
+ * Slots for the CoachMark component
132
+ */
133
+ export interface CoachMarkSlots extends HoverCardSlots {
134
+ /** Custom leading/media content */
135
+ leading: (data?: object) => never;
136
+ /** Custom title */
137
+ title: (data?: object) => never;
138
+ /** Custom description */
139
+ description: (data?: object) => never;
140
+ /** Custom body (including title, description, and extra) */
141
+ body: (data?: object) => never;
142
+ /** Custom content (including leading and body) */
143
+ content: (data?: object) => never;
144
+ /** Custom extra content (after body) */
145
+ extra: (data?: object) => never;
146
+ /** Custom footer */
147
+ footer: (data?: object) => never;
148
+ /** Custom close button */
149
+ closeButton: (data?: object) => never;
150
+ /** Custom steps indicator (overrides Pagination component) */
151
+ steps: (data?: object) => never;
152
+ /** Custom Next button content */
153
+ next?: (data?: object) => never;
154
+ /** Custom Next button pre-icon */
155
+ nextPreIcon?: (data?: object) => never;
156
+ /** Custom Next button post-icon */
157
+ nextPostIcon?: (data?: object) => never;
158
+ /** Custom Previous button content */
159
+ prev?: (data?: object) => never;
160
+ /** Custom Previous button pre-icon */
161
+ prevPreIcon?: (data?: object) => never;
162
+ /** Custom Previous button post-icon */
163
+ prevPostIcon?: (data?: object) => never;
164
+ }
165
+ /**
166
+ * Emits for the CoachMark component
167
+ */
168
+ export interface CoachMarkEmits extends HoverCardEmits {
169
+ next: [e: PointerEvent];
170
+ prev: [e: PointerEvent];
171
+ close: [e: PointerEvent];
172
+ }
173
+ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<CoachMarkProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
174
+ close: (e: PointerEvent) => any;
175
+ "update:open": (value: boolean) => any;
176
+ escapeKeyDown: (event: KeyboardEvent) => any;
177
+ pointerDownOutside: (event: import('reka-ui').PointerDownOutsideEvent) => any;
178
+ focusOutside: (event: import('reka-ui').FocusOutsideEvent) => any;
179
+ interactOutside: (event: import('reka-ui').PointerDownOutsideEvent | import('reka-ui').FocusOutsideEvent) => any;
180
+ next: (e: PointerEvent) => any;
181
+ prev: (e: PointerEvent) => any;
182
+ }, string, import('vue').PublicProps, Readonly<CoachMarkProps> & Readonly<{
183
+ onClose?: ((e: PointerEvent) => any) | undefined;
184
+ "onUpdate:open"?: ((value: boolean) => any) | undefined;
185
+ onEscapeKeyDown?: ((event: KeyboardEvent) => any) | undefined;
186
+ onPointerDownOutside?: ((event: import('reka-ui').PointerDownOutsideEvent) => any) | undefined;
187
+ onFocusOutside?: ((event: import('reka-ui').FocusOutsideEvent) => any) | undefined;
188
+ onInteractOutside?: ((event: import('reka-ui').PointerDownOutsideEvent | import('reka-ui').FocusOutsideEvent) => any) | undefined;
189
+ onNext?: ((e: PointerEvent) => any) | undefined;
190
+ onPrev?: ((e: PointerEvent) => any) | undefined;
191
+ }>, {
192
+ footer: boolean;
193
+ size: "sm" | "md" | "none" | "lg";
194
+ width: number;
195
+ open: boolean;
196
+ prioritizePosition: boolean;
197
+ placement: "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end";
198
+ sticky: "partial" | "always";
199
+ avoidCollisions: boolean;
200
+ updatePositionStrategy: "always" | "optimized";
201
+ zIndex: string | number;
202
+ renderPopupsInContent: boolean;
203
+ trigger: "click" | "hover";
204
+ nextProps: Partial<Omit<import('../..').BaseButtonProps, "flipOnDir" | "icon" | "variant" | "action" | "active" | "badgeText" | "badgeIcon" | "badgeIconFlipOnDir">> & {
205
+ text: string;
206
+ hide?: boolean | undefined;
207
+ };
208
+ prevProps: Partial<Omit<import('../..').BaseButtonProps, "flipOnDir" | "icon" | "variant" | "action" | "active" | "badgeText" | "badgeIcon" | "badgeIconFlipOnDir">> & {
209
+ text: string;
210
+ hide?: boolean | undefined;
211
+ };
212
+ stepProps: PaginationProps & {
213
+ hide?: boolean | undefined;
214
+ };
215
+ }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>, Readonly<CoachMarkSlots> & CoachMarkSlots>;
216
+ export default _default;
217
+ type __VLS_WithTemplateSlots<T, S> = T & {
218
+ new (): {
219
+ $slots: S;
220
+ };
221
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Array of available trigger types for CoachMark component
3
+ */
4
+ export declare const CoachMarkTriggers: readonly ["click", "hover"];
5
+ /**
6
+ * Type representing available trigger types for CoachMark component
7
+ */
8
+ export type CoachMarkTrigger = (typeof CoachMarkTriggers)[number];
@@ -0,0 +1,9 @@
1
+ import { default as CoachMark, CoachMarkProps, CoachMarkEmits, CoachMarkSlots, COACH_MARK_DEFAULT_PROPS, COACH_MARK_STEP_DEFAULT_PROPS, COACH_MARK_NEXT_DEFAULT_PROPS, COACH_MARK_PREV_DEFAULT_PROPS } from './CoachMark';
2
+ import { DefineComponent } from '@pantograph/utils-vue';
3
+ export { CoachMark, type CoachMarkProps, type CoachMarkEmits, type CoachMarkSlots, COACH_MARK_DEFAULT_PROPS, COACH_MARK_STEP_DEFAULT_PROPS, COACH_MARK_NEXT_DEFAULT_PROPS, COACH_MARK_PREV_DEFAULT_PROPS, };
4
+ declare module 'vue' {
5
+ interface GlobalComponents {
6
+ CoachMark: DefineComponent<CoachMarkProps, CoachMarkSlots, CoachMarkEmits>;
7
+ }
8
+ }
9
+ export * from './CoachMark.model';
@@ -26,8 +26,8 @@ export declare const HOVER_CARD_DEFAULT_PROPS: {
26
26
  readonly prioritizePosition: true;
27
27
  readonly avoidCollisions: true;
28
28
  readonly placement: "bottom";
29
- readonly updatePositionStrategy: "optimized";
30
29
  readonly zIndex: 1000;
30
+ readonly updatePositionStrategy: "optimized";
31
31
  readonly renderPopupsInContent: true;
32
32
  };
33
33
  declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<HoverCardProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
@@ -24,7 +24,7 @@ export interface PopoverSlots {
24
24
  /**
25
25
  * The content slot for the Popover
26
26
  */
27
- content?: () => never;
27
+ content?: (data?: object) => never;
28
28
  }
29
29
  /**
30
30
  * The base props for the Popover component