@avenirs-esr/avenirs-dsav 0.1.80 → 0.1.81

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.
@@ -1,45 +1,23 @@
1
1
  import type { Meta, StoryFn } from '@storybook/vue3';
2
2
  import { type AvIconProps } from '@/components/base/AvIcon/AvIcon.vue';
3
3
  /**
4
- * <h2 class="n2">✨ Introduction</h2>
5
- *
6
- * <p>
7
- * <span class="b2-regular">
8
- * The <code>AvIcon</code> component places an <code>Icon</code>
9
- * (see <a href="https://iconify.design/docs/icon-components/vue/" target="_blank">Icon component from Iconify</a>)
10
- * in a square <code>div</code> of configurable size.
11
- * It is a Vue.js component for displaying icons with a wide range of customization options,
12
- * including animations, colors, and sizes.
13
- * </span>
14
- * </p>
15
- *
16
- * <p>
17
- * <span class="b2-regular">
18
- * It's designed to be flexible and performant, with support for various display options,
19
- * flip options, and accessible titles.
20
- * </span>
21
- * </p>
4
+ * <h1 class="n1">Messages - <code>AvMessage</code></h1>
22
5
  *
23
- * <p>
24
- * <span class="b2-regular">
25
- * It has exactly the same API as <code>OhVueIcon</code>, and uses <code>@iconify/vue</code> under the hood.
26
- * </span>
27
- * </p>
6
+ * <h2 class="n2">✨ Introduction</h2>
28
7
  *
29
- * <p>
30
- * <span class="b2-regular">
31
- * <strong>⚠️ Icon names must be those from </strong>
32
- * <a href="https://icon-sets.iconify.design/" target="_blank" rel="noopener noreferrer">Iconify-vue</a>
33
- * </span>
8
+ * <p class="b2-regular">
9
+ * The <code>AvMessage</code> component allows you to display short texts accompanied by an icon on the left,
10
+ * depending on the type of information. This component is useful for displaying contextual feedback messages,
11
+ * such as errors or successes, to the user.
34
12
  * </p>
35
13
  *
36
14
  * <h2 class="n2">🏗️ Structure</h2>
37
15
  *
38
- * <p>
39
- * <span class="b2-regular">
40
- * The icon is composed of a square <code>div</code> of configurable size containing the <code>Icon</code> component.
41
- * </span>
42
- * </p>
16
+ * <ul>
17
+ * <li>The component is based on an <code>AvIconText</code> element.</li>
18
+ * <li>The icon and color are automatically adjusted according to the <code>type</code> prop.</li>
19
+ * <li>Common types include <code>error</code> and <code>success</code>.</li>
20
+ * </ul>
43
21
  */
44
22
  declare const meta: Meta<AvIconProps>;
45
23
  export default meta;
@@ -60,6 +60,7 @@ export interface AvButtonProps {
60
60
  /**
61
61
  * Function called when button is clicked.
62
62
  * @param event The click MouseEvent
63
+ * @deprecated Use `@click` event listener instead.
63
64
  */
64
65
  onClick?: ($event: MouseEvent) => void;
65
66
  }
@@ -25,6 +25,7 @@ export interface AvRichButtonProps {
25
25
  /**
26
26
  * Function called when button is clicked.
27
27
  * @param event The MouseEvent of the click.
28
+ * @deprecated Use `@click` event listener instead.
28
29
  */
29
30
  onClick?: (event: MouseEvent) => void;
30
31
  }
@@ -38,3 +38,4 @@ export declare const Hint: StoryFn<AvCheckboxProps>;
38
38
  export declare const Small: StoryFn<AvCheckboxProps>;
39
39
  export declare const SmallWithIcon: StoryFn<AvCheckboxProps>;
40
40
  export declare const SmallRequired: StoryFn<AvCheckboxProps>;
41
+ export declare const LabelSlot: StoryFn<AvCheckboxProps>;
@@ -1,3 +1,4 @@
1
+ import type { Slot } from 'vue';
1
2
  /**
2
3
  * AvCheckbox component props
3
4
  */
@@ -41,8 +42,9 @@ export interface AvCheckboxProps {
41
42
  disabled?: boolean;
42
43
  /**
43
44
  * Label to be displayed next to the checkbox
45
+ * This prop is optional if you use the `label` slot.
44
46
  */
45
- label: string;
47
+ label?: string;
46
48
  /**
47
49
  * Error message to be displayed under the checkbox
48
50
  * @default ''
@@ -60,12 +62,28 @@ export interface AvCheckboxProps {
60
62
  hint?: string;
61
63
  }
62
64
  type __VLS_Props = AvCheckboxProps;
65
+ /**
66
+ * Slots available in the AvCheckbox component.
67
+ *
68
+ * @slot label - Slot for the checkbox label.
69
+ */
70
+ type __VLS_Slots = {
71
+ /**
72
+ * Slot for the checkbox label
73
+ */
74
+ label?: Slot;
75
+ };
63
76
  type __VLS_PublicProps = __VLS_Props & {
64
77
  modelValue: (string | number | boolean | undefined)[];
65
78
  };
66
- declare const _default: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
79
+ declare const _default: __VLS_WithSlots<import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
67
80
  "update:modelValue": (value: (string | number | boolean | undefined)[]) => any;
68
81
  }, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
69
82
  "onUpdate:modelValue"?: ((value: (string | number | boolean | undefined)[]) => any) | undefined;
70
- }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
83
+ }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, __VLS_Slots>;
71
84
  export default _default;
85
+ type __VLS_WithSlots<T, S> = T & {
86
+ new (): {
87
+ $slots: S;
88
+ };
89
+ };
@@ -60,11 +60,6 @@ declare const meta: {
60
60
  serverSideFiltering?: boolean | undefined;
61
61
  modelValue?: T[] | undefined;
62
62
  } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
63
- emit: {
64
- (e: "search", query: string): void;
65
- (e: "loadMore"): void;
66
- (e: "clear"): void;
67
- } & ((evt: "update:modelValue", value: T[]) => void);
68
63
  attrs: any;
69
64
  slots: {
70
65
  requiredTip?: (() => import("vue").Slot) | undefined;
@@ -79,6 +74,11 @@ declare const meta: {
79
74
  }> | undefined;
80
75
  empty?: import("vue").Slot | undefined;
81
76
  };
77
+ emit: {
78
+ (e: "search", query: string): void;
79
+ (e: "loadMore"): void;
80
+ (e: "clear"): void;
81
+ } & ((evt: "update:modelValue", value: T[]) => void);
82
82
  } | undefined, __VLS_expose?: ((exposed: import("vue").ShallowUnwrapRef<{}>) => void) | undefined, __VLS_setup?: Promise<{
83
83
  props: {
84
84
  readonly "onUpdate:modelValue"?: ((value: T[]) => any) | undefined;
@@ -345,11 +345,6 @@ export declare const WithCustomItemSlotExample: {
345
345
  serverSideFiltering?: boolean | undefined;
346
346
  modelValue?: T[] | undefined;
347
347
  } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
348
- emit: {
349
- (e: "search", query: string): void;
350
- (e: "loadMore"): void;
351
- (e: "clear"): void;
352
- } & ((evt: "update:modelValue", value: T[]) => void);
353
348
  attrs: any;
354
349
  slots: {
355
350
  requiredTip?: (() => import("vue").Slot) | undefined;
@@ -364,6 +359,11 @@ export declare const WithCustomItemSlotExample: {
364
359
  }> | undefined;
365
360
  empty?: import("vue").Slot | undefined;
366
361
  };
362
+ emit: {
363
+ (e: "search", query: string): void;
364
+ (e: "loadMore"): void;
365
+ (e: "clear"): void;
366
+ } & ((evt: "update:modelValue", value: T[]) => void);
367
367
  } | undefined, __VLS_expose?: ((exposed: import("vue").ShallowUnwrapRef<{}>) => void) | undefined, __VLS_setup?: Promise<{
368
368
  props: {
369
369
  readonly "onUpdate:modelValue"?: ((value: T[]) => any) | undefined;
@@ -27,11 +27,6 @@ declare const _default: <T extends AvAutocompleteOption = AvAutocompleteOption>(
27
27
  serverSideFiltering?: boolean | undefined;
28
28
  modelValue?: T[] | undefined;
29
29
  } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
30
- emit: {
31
- (e: 'search', query: string): void;
32
- (e: 'loadMore'): void;
33
- (e: 'clear'): void;
34
- } & ((evt: "update:modelValue", value: T[]) => void);
35
30
  attrs: any;
36
31
  slots: {
37
32
  /**
@@ -63,6 +58,11 @@ declare const _default: <T extends AvAutocompleteOption = AvAutocompleteOption>(
63
58
  */
64
59
  empty?: Slot | undefined;
65
60
  };
61
+ emit: {
62
+ (e: 'search', query: string): void;
63
+ (e: 'loadMore'): void;
64
+ (e: 'clear'): void;
65
+ } & ((evt: "update:modelValue", value: T[]) => void);
66
66
  } | undefined, __VLS_expose?: ((exposed: import('vue').ShallowUnwrapRef<{}>) => void) | undefined, __VLS_setup?: Promise<{
67
67
  props: {
68
68
  readonly "onUpdate:modelValue"?: ((value: T[]) => any) | undefined;
@@ -3,7 +3,6 @@ import { type AvAutocompleteOption } from '@/components/interaction/selects/AvAu
3
3
  declare const _default: <T extends AvAutocompleteOption = AvAutocompleteOption>(__VLS_props: {
4
4
  readonly onLoadMore?: (() => any) | undefined;
5
5
  } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
6
- emit: (evt: "loadMore") => void;
7
6
  attrs: any;
8
7
  slots: {
9
8
  item?: Slot<{
@@ -13,6 +12,7 @@ declare const _default: <T extends AvAutocompleteOption = AvAutocompleteOption>(
13
12
  }> | undefined;
14
13
  empty?: Slot | undefined;
15
14
  };
15
+ emit: (evt: "loadMore") => void;
16
16
  } | undefined, __VLS_expose?: ((exposed: import("vue").ShallowUnwrapRef<{
17
17
  dropdownRef: import("vue").Ref<HTMLElement | undefined, HTMLElement | undefined>;
18
18
  }>) => void) | undefined, __VLS_setup?: Promise<{
@@ -4,11 +4,11 @@ declare const _default: <T extends AvAutocompleteOption = AvAutocompleteOption>(
4
4
  readonly onSearch?: ((query: string) => any) | undefined;
5
5
  readonly onClear?: (() => any) | undefined;
6
6
  } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
7
- emit: ((evt: "search", query: string) => void) & ((evt: "clear") => void);
8
7
  attrs: any;
9
8
  slots: {
10
9
  requiredTip?: Slot | undefined;
11
10
  };
11
+ emit: ((evt: "search", query: string) => void) & ((evt: "clear") => void);
12
12
  } | undefined, __VLS_expose?: ((exposed: import("vue").ShallowUnwrapRef<{
13
13
  inputRef: import("vue").Ref<({
14
14
  $: import("vue").ComponentInternalInstance;
@@ -1,7 +1,6 @@
1
1
  import type { Slot } from 'vue';
2
2
  import type { AvAutocompleteOption } from '@/components/interaction/selects/AvAutocomplete/AvAutocomplete.types';
3
3
  declare const _default: <T extends AvAutocompleteOption = AvAutocompleteOption>(__VLS_props: {} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
4
- emit: {};
5
4
  attrs: any;
6
5
  slots: {
7
6
  selectedItem?: Slot<{
@@ -9,6 +8,7 @@ declare const _default: <T extends AvAutocompleteOption = AvAutocompleteOption>(
9
8
  remove: () => void;
10
9
  }> | undefined;
11
10
  };
11
+ emit: {};
12
12
  } | undefined, __VLS_expose?: ((exposed: import('vue').ShallowUnwrapRef<{}>) => void) | undefined, __VLS_setup?: Promise<{
13
13
  props: {} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
14
14
  expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;