rei-kit 3.1.0 → 3.2.0

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.
@@ -34,6 +34,14 @@ declare const __VLS_export: <M extends "single" | "range" = "single">(__VLS_prop
34
34
  size?: "sm" | "md" | undefined;
35
35
  labelHidden?: boolean | undefined;
36
36
  disabled?: boolean | undefined;
37
+ /**
38
+ * Ties the generated id to a name you choose, so `ErrorSummary` can link
39
+ * to this field. Its links point at nothing without it, and the kit's
40
+ * own `FormField` has taken one since 2.22.0 while the fields built on
41
+ * it did not — which left building a form out of these and summarising
42
+ * its errors impossible without hand-writing the control.
43
+ */
44
+ fieldId?: string | undefined;
37
45
  } & {
38
46
  /** The chosen day, or range, with `v-model`. */
39
47
  modelValue?: (M extends "range" ? DateRange : string) | undefined;
@@ -34,6 +34,14 @@ declare const __VLS_export: <T extends string | number | undefined = string>(__V
34
34
  * paint.
35
35
  */
36
36
  variant?: "default" | "unstyled" | undefined;
37
+ /**
38
+ * Ties the generated id to a name you choose, so `ErrorSummary` can link
39
+ * to this field. Its links point at nothing without it, and the kit's
40
+ * own `FormField` has taken one since 2.22.0 while the fields built on
41
+ * it did not — which left building a form out of these and summarising
42
+ * its errors impossible without hand-writing the control.
43
+ */
44
+ fieldId?: string | undefined;
37
45
  } & Omit<InputHTMLAttributes, "type" | "size">) & {
38
46
  "onUpdate:modelValue"?: (value: T) => any;
39
47
  }> & (typeof globalThis extends {
@@ -36,6 +36,14 @@ declare const __VLS_export: <T extends string | number>(__VLS_props: NonNullable
36
36
  * paint.
37
37
  */
38
38
  variant?: "default" | "unstyled" | undefined;
39
+ /**
40
+ * Ties the generated id to a name you choose, so `ErrorSummary` can link
41
+ * to this field. Its links point at nothing without it, and the kit's
42
+ * own `FormField` has taken one since 2.22.0 while the fields built on
43
+ * it did not — which left building a form out of these and summarising
44
+ * its errors impossible without hand-writing the control.
45
+ */
46
+ fieldId?: string | undefined;
39
47
  } & {
40
48
  modelValue?: T | undefined;
41
49
  }) & {
@@ -27,6 +27,14 @@ type __VLS_Props = {
27
27
  * paint.
28
28
  */
29
29
  variant?: 'default' | 'unstyled' | undefined;
30
+ /**
31
+ * Ties the generated id to a name you choose, so `ErrorSummary` can link
32
+ * to this field. Its links point at nothing without it, and the kit's
33
+ * own `FormField` has taken one since 2.22.0 while the fields built on
34
+ * it did not — which left building a form out of these and summarising
35
+ * its errors impossible without hand-writing the control.
36
+ */
37
+ fieldId?: string | undefined;
30
38
  };
31
39
  declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
32
40
  "update:modelValue": (value: string) => any;
@@ -48,6 +48,14 @@ type __VLS_Props = {
48
48
  error?: string | undefined;
49
49
  disabled?: boolean | undefined;
50
50
  labelHidden?: boolean | undefined;
51
+ /**
52
+ * Ties the generated id to a name you choose, so `ErrorSummary` can link
53
+ * to this field. Its links point at nothing without it, and the kit's
54
+ * own `FormField` has taken one since 2.22.0 while the fields built on
55
+ * it did not — which left building a form out of these and summarising
56
+ * its errors impossible without hand-writing the control.
57
+ */
58
+ fieldId?: string | undefined;
51
59
  };
52
60
  declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
53
61
  "update:modelValue": (value: string) => any;
@@ -27,6 +27,14 @@ type __VLS_Props = {
27
27
  size?: 'sm' | 'md' | undefined;
28
28
  labelHidden?: boolean | undefined;
29
29
  disabled?: boolean | undefined;
30
+ /**
31
+ * Ties the generated id to a name you choose, so `ErrorSummary` can link
32
+ * to this field. Its links point at nothing without it, and the kit's
33
+ * own `FormField` has taken one since 2.22.0 while the fields built on
34
+ * it did not — which left building a form out of these and summarising
35
+ * its errors impossible without hand-writing the control.
36
+ */
37
+ fieldId?: string | undefined;
30
38
  };
31
39
  type __VLS_ModelProps = {
32
40
  /** The number, with `v-model`. `undefined` while the field is empty. */
@@ -16,6 +16,12 @@ export interface Tone {
16
16
  * that knows its own categories anyway.
17
17
  */
18
18
  type __VLS_Props = {
19
+ /**
20
+ * The colour classes for the dot and the label, as written-out class names.
21
+ * `Tone` is a pair rather than a role token because the categories here are
22
+ * the app's own, and Tailwind reads source as plain text: a class assembled
23
+ * at runtime never reaches the stylesheet.
24
+ */
19
25
  tone: Tone;
20
26
  label: string;
21
27
  /** Hidden when zero, so an empty group's heading stays quiet. */
@@ -8,6 +8,11 @@
8
8
  * flat figure.
9
9
  */
10
10
  type __VLS_Props = {
11
+ /**
12
+ * Already formatted — "₺1.240", "68%", "12 days". A number would make this
13
+ * component choose a currency, a locale and a number of decimals, which are
14
+ * three product decisions it has no way to be right about.
15
+ */
11
16
  value: string;
12
17
  label: string;
13
18
  trend?: 'up' | 'down' | 'flat' | null | undefined;
@@ -27,6 +27,14 @@ type __VLS_Props = {
27
27
  size?: 'sm' | 'md' | undefined;
28
28
  labelHidden?: boolean | undefined;
29
29
  disabled?: boolean | undefined;
30
+ /**
31
+ * Ties the generated id to a name you choose, so `ErrorSummary` can link
32
+ * to this field. Its links point at nothing without it, and the kit's
33
+ * own `FormField` has taken one since 2.22.0 while the fields built on
34
+ * it did not — which left building a form out of these and summarising
35
+ * its errors impossible without hand-writing the control.
36
+ */
37
+ fieldId?: string | undefined;
30
38
  };
31
39
  type __VLS_ModelProps = {
32
40
  /** The tags, with `v-model`. */
@@ -28,6 +28,14 @@ type __VLS_Props = {
28
28
  size?: 'sm' | 'md' | undefined;
29
29
  labelHidden?: boolean | undefined;
30
30
  disabled?: boolean | undefined;
31
+ /**
32
+ * Ties the generated id to a name you choose, so `ErrorSummary` can link
33
+ * to this field. Its links point at nothing without it, and the kit's
34
+ * own `FormField` has taken one since 2.22.0 while the fields built on
35
+ * it did not — which left building a form out of these and summarising
36
+ * its errors impossible without hand-writing the control.
37
+ */
38
+ fieldId?: string | undefined;
31
39
  };
32
40
  type __VLS_ModelProps = {
33
41
  /** The time as `HH:mm`, with `v-model`. */