@dloizides/ui-forms 1.6.0 → 1.8.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.
- package/CHANGELOG.md +118 -0
- package/README.md +42 -0
- package/dist/index.d.mts +436 -9
- package/dist/index.d.ts +436 -9
- package/dist/index.js +625 -52
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +616 -54
- package/dist/index.mjs.map +1 -1
- package/package.json +110 -108
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,31 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
|
-
import { ViewStyle, TextInputProps, TextInput,
|
|
2
|
+
import { StyleProp, TextStyle, ViewStyle, TextInputProps, TextInput, View } from 'react-native';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* The TWO legitimate label voices, per the shared forms contract
|
|
6
|
+
* (`PROOViD/AMLService/AMLService/wwwroot/shared/FORMS.md` → "The TWO legitimate label voices").
|
|
7
|
+
*
|
|
8
|
+
* - `field` — 13 / 600 / sentence case. A label that is READ: prose addressed to the person
|
|
9
|
+
* filling the form. This is `Field`'s historical, unchanged default, so every
|
|
10
|
+
* existing consumer renders byte-identically.
|
|
11
|
+
* - `control` — 11 / 700 / UPPERCASE + letter-spacing. A label that is SCANNED: a key over a value
|
|
12
|
+
* in a dense row (filter bars, compact toolbars, pager controls). These are exactly
|
|
13
|
+
* the metrics `@dloizides/ui-tables` forked into its private `FieldShell` because
|
|
14
|
+
* `Field` hard-coded the `field` voice and offered no way out.
|
|
15
|
+
*
|
|
16
|
+
* A THIRD voice is drift, not a variant. Pick the voice from the SURFACE, not the component: every
|
|
17
|
+
* label on one surface uses one voice, and voices are never mixed within a single row.
|
|
18
|
+
*
|
|
19
|
+
* Why a plain string union and not a `const enum`: this type crosses the package boundary into
|
|
20
|
+
* consumers' `.d.ts`, and a cross-boundary `const enum` breaks `isolatedModules` / Babel-only
|
|
21
|
+
* builds. `@dloizides/ui-buttons` sets the same precedent for `ButtonVariant` for the same reason.
|
|
22
|
+
*/
|
|
23
|
+
|
|
24
|
+
/** Which of the two contract voices a field label speaks. */
|
|
25
|
+
type FieldLabelVariant = 'field' | 'control';
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Field — the generic "label over a control, hint + error under it" wrapper.
|
|
6
29
|
*
|
|
7
30
|
* `FormField` is hard-wired to a text input, so any NON-text control (a dropdown, a date picker,
|
|
8
31
|
* a chip selector) had no shared way to get a label — and ended up visually misaligned next to
|
|
@@ -13,13 +36,20 @@ import { ViewStyle, TextInputProps, TextInput, TextStyle } from 'react-native';
|
|
|
13
36
|
* truth: `FormField` composes `Field` internally, so the two can never drift apart.
|
|
14
37
|
*
|
|
15
38
|
* Children may be a plain node (the common case — just wrap your control) or a render function
|
|
16
|
-
* receiving `{ describedById, hasError }`, so a custom control can wire the
|
|
17
|
-
* own `aria-describedby` / invalid state exactly the way `FormField` does.
|
|
39
|
+
* receiving `{ describedById, hasError }`, so a custom control can wire the hint AND error lines
|
|
40
|
+
* into its own `aria-describedby` / invalid state exactly the way `FormField` does.
|
|
41
|
+
*
|
|
42
|
+
* The anatomy (label → control → hint → error), the two label voices, the mutually-exclusive
|
|
43
|
+
* required/optional markers and the collapsing error slot all implement the shared cross-stack
|
|
44
|
+
* contract in `PROOViD/AMLService/AMLService/wwwroot/shared/FORMS.md`.
|
|
18
45
|
*/
|
|
19
46
|
|
|
20
47
|
/** What a render-function child receives, so it can mirror `FormField`'s error wiring. */
|
|
21
48
|
interface FieldChildContext {
|
|
22
|
-
/**
|
|
49
|
+
/**
|
|
50
|
+
* Space-separated ids of the lines describing this control — the hint, the error, or both, in
|
|
51
|
+
* reading order. `undefined` when there is neither. Assign straight to `aria-describedby`.
|
|
52
|
+
*/
|
|
23
53
|
describedById?: string;
|
|
24
54
|
hasError: boolean;
|
|
25
55
|
}
|
|
@@ -34,11 +64,123 @@ interface FieldProps {
|
|
|
34
64
|
label?: string;
|
|
35
65
|
children: FieldChildren;
|
|
36
66
|
required?: boolean;
|
|
67
|
+
/**
|
|
68
|
+
* Marks the field explicitly optional. MUTUALLY EXCLUSIVE with `required` — if both are set,
|
|
69
|
+
* `required` wins (the safe direction: an under-marked required field causes a failed submit).
|
|
70
|
+
* Use it to mark the MINORITY: on a mostly-required form, marking the two optional fields is far
|
|
71
|
+
* less noise than asterisking the other eleven.
|
|
72
|
+
*/
|
|
73
|
+
optional?: boolean;
|
|
74
|
+
/**
|
|
75
|
+
* Pre-localized text for the optional marker. Defaults to the English `DEFAULT_OPTIONAL_LABEL`
|
|
76
|
+
* so a single-locale app can adopt `optional` in one line; a localized app MUST pass this.
|
|
77
|
+
*/
|
|
78
|
+
optionalLabel?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Help line rendered UNDER the control and ABOVE the error — the sentence that stops the user
|
|
81
|
+
* guessing. It coexists with `error` (the hint states the rule, the error says which rule was
|
|
82
|
+
* broken) and both are reachable from the control via `aria-describedby`.
|
|
83
|
+
*
|
|
84
|
+
* Rendering a hint INSIDE the field is the point: as an outside sibling it lands past the
|
|
85
|
+
* container's 16px bottom margin and detaches from the control it explains.
|
|
86
|
+
*/
|
|
87
|
+
hint?: string;
|
|
37
88
|
error?: string;
|
|
38
|
-
|
|
89
|
+
/**
|
|
90
|
+
* Which of the two contract label voices to speak: `field` (13/600 sentence case — the default,
|
|
91
|
+
* unchanged) or `control` (11/700 uppercase — dense filter bars and toolbars).
|
|
92
|
+
*/
|
|
93
|
+
labelVariant?: FieldLabelVariant;
|
|
94
|
+
/**
|
|
95
|
+
* Escape hatch applied AFTER `labelVariant`, for the genuine one-off a variant does not cover.
|
|
96
|
+
* Prefer `labelVariant`: it is the reviewable, named choice, and a bare `labelStyle` is the thing
|
|
97
|
+
* to grep for when auditing label drift.
|
|
98
|
+
*/
|
|
99
|
+
labelStyle?: StyleProp<TextStyle>;
|
|
100
|
+
/**
|
|
101
|
+
* `StyleProp` (not a bare `ViewStyle`) so a caller can compose an array — e.g. a base field style
|
|
102
|
+
* plus a `grow` modifier — instead of having to restate a COMPLETE style per variant.
|
|
103
|
+
*/
|
|
104
|
+
containerStyle?: StyleProp<ViewStyle>;
|
|
105
|
+
testID?: string;
|
|
106
|
+
}
|
|
107
|
+
declare const Field: ({ label, children, required, optional, optionalLabel, hint, error, labelVariant, labelStyle, containerStyle, testID, }: FieldProps) => React.ReactElement;
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Required / optional markers, per the shared forms contract
|
|
111
|
+
* (`…/wwwroot/shared/FORMS.md` → "Required and optional markers").
|
|
112
|
+
*
|
|
113
|
+
* The contract says the two markers are MUTUALLY EXCLUSIVE — a field is required or optional, never
|
|
114
|
+
* annotated as both — and that you mark the MINORITY: on a mostly-required form mark the optional
|
|
115
|
+
* fields, on a mostly-optional form mark the required ones. Asterisking twelve of thirteen fields
|
|
116
|
+
* is noise that trains the eye to ignore the marker.
|
|
117
|
+
*
|
|
118
|
+
* Exclusivity is enforced here rather than in the type system so that a caller spreading a props
|
|
119
|
+
* object (`<Field {...fieldProps} />`, where both flags may be computed) still gets a defined,
|
|
120
|
+
* single-marker result instead of a compile error it cannot act on.
|
|
121
|
+
*
|
|
122
|
+
* Precedence when a caller asks for BOTH: `required` wins. That is the safe failure direction —
|
|
123
|
+
* showing "optional" on a field the server will reject sends the user into a failed submit, while
|
|
124
|
+
* showing "required" on a genuinely optional field costs, at worst, an unnecessary keystroke.
|
|
125
|
+
*/
|
|
126
|
+
/** Which marker a field label carries. Exactly one, never both. */
|
|
127
|
+
type FieldMarker = 'none' | 'required' | 'optional';
|
|
128
|
+
/**
|
|
129
|
+
* The English fallback for the optional marker's text.
|
|
130
|
+
*
|
|
131
|
+
* `@dloizides/ui-forms` contains NO i18n runtime by design — aml-v2 uses `@dloizides/i18n` with
|
|
132
|
+
* positional `{0}` params while the other six apps use i18next `{{p1}}`, and nothing bridges them,
|
|
133
|
+
* so all user-visible copy arrives as pre-localized props. This constant exists ONLY so a
|
|
134
|
+
* single-locale app can adopt `optional` in one line. It is exported precisely so it is greppable:
|
|
135
|
+
* **a localized app MUST pass `optionalLabel`.** The required marker needs no such escape — `*` is
|
|
136
|
+
* a glyph, not copy.
|
|
137
|
+
*/
|
|
138
|
+
declare const DEFAULT_OPTIONAL_LABEL = "(optional)";
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* `FormActions` — the submit/cancel button row every form ends with.
|
|
142
|
+
*
|
|
143
|
+
* Promoted from the BYTE-IDENTICAL `erevna-web/src/components/Forms/FormActions.tsx` and
|
|
144
|
+
* `katalogos-web/src/components/Forms/FormActions.tsx` (68 lines each, `diff` returns nothing);
|
|
145
|
+
* all seven apps hand-roll the same row. Buttons come from the shared `@dloizides/ui-buttons` kit
|
|
146
|
+
* rather than being forked here, so there is exactly one button implementation in the estate.
|
|
147
|
+
*
|
|
148
|
+
* The layout implements the contract's actions row
|
|
149
|
+
* (`…/wwwroot/shared/FORMS.md` → "Actions row"): the primary action is LAST in DOM order, so tab
|
|
150
|
+
* order reaches Cancel before Save, and `saving` drives the primary button's spinner rather than
|
|
151
|
+
* disabling-and-relabelling it.
|
|
152
|
+
*
|
|
153
|
+
* Two minimal generalizations over the app-local twins:
|
|
154
|
+
* 1. Labels and hints arrive as PRE-LOCALIZED props. The twins called `FM()` internally, which
|
|
155
|
+
* cannot work here: aml-v2 localizes via `@dloizides/i18n` with positional `{0}` params while
|
|
156
|
+
* the other six use i18next `{{p1}}`, and nothing bridges them.
|
|
157
|
+
* 2. `testID`s are overridable but default to the twins' `save-button` / `cancel-button`, so the
|
|
158
|
+
* existing Playwright selectors in every app keep matching.
|
|
159
|
+
*/
|
|
160
|
+
|
|
161
|
+
interface FormActionsProps {
|
|
162
|
+
/** Submit handler. May be async — the shared Button drives its own spinner for the promise. */
|
|
163
|
+
onSave: () => void | Promise<unknown>;
|
|
164
|
+
/** Cancel handler. Omit it entirely to render a save-only row (no empty Cancel slot). */
|
|
165
|
+
onCancel?: () => void | Promise<unknown>;
|
|
166
|
+
/** Pre-localized label for the primary action. */
|
|
167
|
+
saveLabel: string;
|
|
168
|
+
/** Pre-localized label for the cancel action. Required whenever `onCancel` is supplied. */
|
|
169
|
+
cancelLabel?: string;
|
|
170
|
+
/** Pre-localized accessibility hint for the primary action. Falls back to its label. */
|
|
171
|
+
saveHint?: string;
|
|
172
|
+
/** Pre-localized accessibility hint for the cancel action. Falls back to its label. */
|
|
173
|
+
cancelHint?: string;
|
|
174
|
+
/** In-flight submit: spins the primary action and disables cancel so the form can't be abandoned mid-write. */
|
|
175
|
+
saving?: boolean;
|
|
176
|
+
/** Disables the primary action independently of `saving` (e.g. an invalid form). */
|
|
177
|
+
saveDisabled?: boolean;
|
|
178
|
+
containerStyle?: StyleProp<ViewStyle>;
|
|
179
|
+
saveTestID?: string;
|
|
180
|
+
cancelTestID?: string;
|
|
39
181
|
testID?: string;
|
|
40
182
|
}
|
|
41
|
-
declare const
|
|
183
|
+
declare const FormActions: ({ onSave, onCancel, saveLabel, cancelLabel, saveHint, cancelHint, saving, saveDisabled, containerStyle, saveTestID, cancelTestID, testID, }: FormActionsProps) => React.ReactElement;
|
|
42
184
|
|
|
43
185
|
/**
|
|
44
186
|
* Reusable form field — labelled text input with optional required mark + error.
|
|
@@ -153,8 +295,20 @@ interface ChipSelectorProps<T> {
|
|
|
153
295
|
/** Validation message under the chips, wired to the chip group via `aria-describedby`. */
|
|
154
296
|
error?: string;
|
|
155
297
|
testID?: string;
|
|
298
|
+
/**
|
|
299
|
+
* Stem for each chip's testID — a chip becomes `${chipTestIDPrefix}-${value}`. Defaults to
|
|
300
|
+
* `chip-selector-chip`, which existing specs select on; supply your own when a screen has
|
|
301
|
+
* several chip groups that must be addressed independently.
|
|
302
|
+
*/
|
|
303
|
+
chipTestIDPrefix?: string;
|
|
304
|
+
/**
|
|
305
|
+
* Accessibility hint applied to every chip in the group. Supply a LOCALIZED string — the
|
|
306
|
+
* built-in default (`Selects <label>`) is English-only and exists solely so pre-existing
|
|
307
|
+
* consumers keep their current announcement.
|
|
308
|
+
*/
|
|
309
|
+
optionAccessibilityHint?: string;
|
|
156
310
|
}
|
|
157
|
-
declare const ChipSelector: <T extends string | number>({ label, options, value, onChange, multiple, disabled, variant, containerStyle, required, error, testID, }: ChipSelectorProps<T>) => React.ReactElement;
|
|
311
|
+
declare const ChipSelector: <T extends string | number>({ label, options, value, onChange, multiple, disabled, variant, containerStyle, required, error, testID, chipTestIDPrefix, optionAccessibilityHint, }: ChipSelectorProps<T>) => React.ReactElement;
|
|
158
312
|
|
|
159
313
|
/**
|
|
160
314
|
* Reusable form switch/toggle with an optional description.
|
|
@@ -197,4 +351,277 @@ interface FormCheckboxProps {
|
|
|
197
351
|
}
|
|
198
352
|
declare const FormCheckbox: ({ label, value, onValueChange, onChange, hint, description, disabled, containerStyle, testID, accessibilityLabel, accessibilityHint, }: FormCheckboxProps) => React.ReactElement;
|
|
199
353
|
|
|
200
|
-
|
|
354
|
+
/**
|
|
355
|
+
* Shared value types for the dense CONTROLS (select / typeahead / date-range) promoted out of
|
|
356
|
+
* `@dloizides/ui-tables`' private filter bar.
|
|
357
|
+
*
|
|
358
|
+
* They live here, not in `ui-tables`, because a control's option list and a date range are form
|
|
359
|
+
* concepts — a filter bar is only one surface that happens to compose them. `ui-tables` aliases
|
|
360
|
+
* its long-standing public names (`FilterOption`, `DateRangeValue`) onto these, so there is ONE
|
|
361
|
+
* definition and the two can never drift into structurally-compatible-but-separate twins.
|
|
362
|
+
*/
|
|
363
|
+
/** A single choice in a select / typeahead. `label` is PRE-LOCALIZED by the caller. */
|
|
364
|
+
interface ControlOption {
|
|
365
|
+
readonly label: string;
|
|
366
|
+
readonly value: string;
|
|
367
|
+
}
|
|
368
|
+
/** The inclusive from/to value of a date-range control (each an ISO `YYYY-MM-DD` string, or ''). */
|
|
369
|
+
interface DateRangeValue {
|
|
370
|
+
readonly from: string;
|
|
371
|
+
readonly to: string;
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
/**
|
|
375
|
+
* `SelectControl` — a single-select enum/status dropdown. A bordered trigger shows the selected
|
|
376
|
+
* option's label (or the placeholder when unset) plus a chevron; pressing it opens the shared
|
|
377
|
+
* {@link AnchoredMenu}. Selecting fires `onChange` and closes.
|
|
378
|
+
*
|
|
379
|
+
* Promoted out of `@dloizides/ui-tables`' private `Filters/fields/SelectField`, where six portals
|
|
380
|
+
* could see it working and none could import it — which is why the fleet grew SIX independent
|
|
381
|
+
* select implementations.
|
|
382
|
+
*
|
|
383
|
+
* The control is LABEL-FREE by design: wrap it in a `Field` (with `labelVariant="control"` on a
|
|
384
|
+
* dense surface) to get the label, hint and error slots. That keeps one label implementation for
|
|
385
|
+
* every control instead of one per control.
|
|
386
|
+
*
|
|
387
|
+
* i18n: this package never calls `t`. `accessibilityLabel`, `placeholder`, `accessibilityHint`
|
|
388
|
+
* and `optionHint` are PRE-LOCALIZED strings supplied by the caller — the only shape that can
|
|
389
|
+
* serve both aml-v2's positional `{0}` `@dloizides/i18n` and the other six portals' i18next
|
|
390
|
+
* `{{p1}}` from one component.
|
|
391
|
+
*/
|
|
392
|
+
|
|
393
|
+
interface SelectControlProps {
|
|
394
|
+
options: readonly ControlOption[];
|
|
395
|
+
/** The selected option's `value`. `''` (or any unmatched value) renders the placeholder. */
|
|
396
|
+
value: string;
|
|
397
|
+
onChange: (value: string) => void;
|
|
398
|
+
/** PRE-LOCALIZED text shown when the value matches no option. */
|
|
399
|
+
placeholder?: string;
|
|
400
|
+
/**
|
|
401
|
+
* PRE-LOCALIZED accessible NAME of the trigger. It REPLACES the trigger's visible text for a
|
|
402
|
+
* screen reader, so it must carry the SELECTION too — "Status: Active", not just "Status",
|
|
403
|
+
* which announces the control but silently hides its value.
|
|
404
|
+
*/
|
|
405
|
+
accessibilityLabel: string;
|
|
406
|
+
accessibilityHint?: string;
|
|
407
|
+
/** PRE-LOCALIZED accessibility hint applied to every option in the menu. */
|
|
408
|
+
optionHint?: string;
|
|
409
|
+
/** Merged LAST onto the anchor wrapper — the consumer always wins over the shared style. */
|
|
410
|
+
style?: StyleProp<ViewStyle>;
|
|
411
|
+
/** Trigger is `${testID}-trigger`, menu `${testID}-menu`, options `${testID}-option-${value}`. */
|
|
412
|
+
testID: string;
|
|
413
|
+
}
|
|
414
|
+
declare function SelectControl({ options, value, onChange, placeholder, accessibilityLabel, accessibilityHint, optionHint, style, testID, }: SelectControlProps): React.ReactElement;
|
|
415
|
+
|
|
416
|
+
/**
|
|
417
|
+
* `TypeaheadControl` — a search-as-you-type combobox (aml-v2's CountryPicker, generalized). A
|
|
418
|
+
* text input plus a floating {@link AnchoredMenu} of ranked suggestions ({@link suggestOptions});
|
|
419
|
+
* picking one fills the canonical label.
|
|
420
|
+
*
|
|
421
|
+
* Free typing is PRESERVED: the value is the raw text, so a caller can accept "CY", "cyprus" or
|
|
422
|
+
* "Cyprus (CY)" and normalise it themselves at query time, exactly as aml does. An optional
|
|
423
|
+
* PRE-LOCALIZED `error` shows a persistent banner and tints the border.
|
|
424
|
+
*
|
|
425
|
+
* Promoted out of `@dloizides/ui-tables`' private `Filters/fields/TypeaheadField`.
|
|
426
|
+
*
|
|
427
|
+
* Label-free by design — wrap in a `Field` for the label/hint slots.
|
|
428
|
+
*/
|
|
429
|
+
|
|
430
|
+
/** Default min characters before suggestions surface. */
|
|
431
|
+
declare const DEFAULT_TYPEAHEAD_MIN_CHARS = 1;
|
|
432
|
+
/** Default cap on rendered suggestions. */
|
|
433
|
+
declare const DEFAULT_TYPEAHEAD_MAX_SUGGESTIONS = 8;
|
|
434
|
+
interface TypeaheadControlProps {
|
|
435
|
+
options: readonly ControlOption[];
|
|
436
|
+
/** The raw text in the box — NOT necessarily an option value. */
|
|
437
|
+
value: string;
|
|
438
|
+
onChange: (value: string) => void;
|
|
439
|
+
/** Called on Enter/submit (after the menu closes). Omit if the surface has nothing to commit. */
|
|
440
|
+
onSubmit?: () => void;
|
|
441
|
+
placeholder?: string;
|
|
442
|
+
/** PRE-LOCALIZED accessible name of the input. */
|
|
443
|
+
accessibilityLabel: string;
|
|
444
|
+
accessibilityHint?: string;
|
|
445
|
+
/** PRE-LOCALIZED accessibility hint applied to every suggestion. */
|
|
446
|
+
optionHint?: string;
|
|
447
|
+
/** PRE-LOCALIZED inline error (e.g. "Unrecognised country"). Shows a persistent banner. */
|
|
448
|
+
error?: string;
|
|
449
|
+
/** Minimum characters before suggestions surface. Default 1. */
|
|
450
|
+
minChars?: number;
|
|
451
|
+
/** Cap on rendered suggestions. Default 8. */
|
|
452
|
+
maxSuggestions?: number;
|
|
453
|
+
/** Merged LAST onto the anchor wrapper. */
|
|
454
|
+
style?: StyleProp<ViewStyle>;
|
|
455
|
+
/** Input is `${testID}-input`, menu `${testID}-menu`, error `${testID}-error`. */
|
|
456
|
+
testID: string;
|
|
457
|
+
}
|
|
458
|
+
declare function TypeaheadControl({ options, value, onChange, onSubmit, placeholder, accessibilityLabel, accessibilityHint, optionHint, error, minChars, maxSuggestions, style, testID, }: TypeaheadControlProps): React.ReactElement;
|
|
459
|
+
|
|
460
|
+
/**
|
|
461
|
+
* `DateRangeControl` — an inclusive from/to pair (aml cases `from`/`to`, kefi audit `from`/`to`).
|
|
462
|
+
* Each side is a `YYYY-MM-DD` text input; on web the browser's native date UI is offered via
|
|
463
|
+
* `type="date"` (a react-native-web `TextInput` passes unknown props to the DOM input). Editing
|
|
464
|
+
* either side patches ONLY that side, so the other survives the edit.
|
|
465
|
+
*
|
|
466
|
+
* Promoted out of `@dloizides/ui-tables`' private `Filters/fields/DateRangeField`, which is why
|
|
467
|
+
* the fleet grew FIVE independent date fields.
|
|
468
|
+
*
|
|
469
|
+
* Label-free by design — the From/To sub-labels name the two HALVES; wrap in a `Field` for the
|
|
470
|
+
* range's own label.
|
|
471
|
+
*/
|
|
472
|
+
|
|
473
|
+
interface DateRangeControlProps {
|
|
474
|
+
value: DateRangeValue;
|
|
475
|
+
onChange: (value: DateRangeValue) => void;
|
|
476
|
+
/** Called on Enter/submit in either side. */
|
|
477
|
+
onSubmit?: () => void;
|
|
478
|
+
/** PRE-LOCALIZED sub-label for the FROM input (e.g. "From"). Also its accessible name. */
|
|
479
|
+
fromLabel: string;
|
|
480
|
+
/** PRE-LOCALIZED sub-label for the TO input (e.g. "To"). Also its accessible name. */
|
|
481
|
+
toLabel: string;
|
|
482
|
+
fromPlaceholder?: string;
|
|
483
|
+
toPlaceholder?: string;
|
|
484
|
+
/** PRE-LOCALIZED hint applied to BOTH inputs. */
|
|
485
|
+
accessibilityHint?: string;
|
|
486
|
+
/** Merged LAST onto the row wrapper. */
|
|
487
|
+
style?: StyleProp<ViewStyle>;
|
|
488
|
+
/** Row is `${testID}-range`, inputs `${testID}-from` / `${testID}-to`. */
|
|
489
|
+
testID: string;
|
|
490
|
+
}
|
|
491
|
+
declare function DateRangeControl({ value, onChange, onSubmit, fromLabel, toLabel, fromPlaceholder, toPlaceholder, accessibilityHint, style, testID, }: DateRangeControlProps): React.ReactElement;
|
|
492
|
+
|
|
493
|
+
/**
|
|
494
|
+
* `AnchoredMenu` — the floating option list shared by `SelectControl` and `TypeaheadControl`.
|
|
495
|
+
*
|
|
496
|
+
* Renders an in-tree, absolutely-positioned popover under its anchor (the pattern aml-v2's
|
|
497
|
+
* CountryPicker proved: `position:absolute; top:100%; zIndex; elevation`), so it floats over
|
|
498
|
+
* sibling fields without a portal. On web it dismisses on outside-click / Escape; on native the
|
|
499
|
+
* caller closes it on blur/select. Purely presentational + theme-flat, so it stays reusable.
|
|
500
|
+
*
|
|
501
|
+
* Promoted verbatim out of `@dloizides/ui-tables`' private `Filters/components/AnchoredMenu`.
|
|
502
|
+
*
|
|
503
|
+
* Deliberately in-tree (no `ui-layout` dependency). That was a considered choice in `ui-tables`
|
|
504
|
+
* and it still holds here: `ui-forms` is a low-level primitive and must not take a runtime
|
|
505
|
+
* dependency on the higher-level `ui-layout` `ModalDropdown` — that would invert the graph for
|
|
506
|
+
* every consumer. Apps needing the responsive modal/bottom-sheet variant inject it instead.
|
|
507
|
+
*/
|
|
508
|
+
|
|
509
|
+
/** The four theme colours the menu paints with — passed in, so the menu stays theme-flat. */
|
|
510
|
+
interface AnchoredMenuColors {
|
|
511
|
+
text: string;
|
|
512
|
+
border: string;
|
|
513
|
+
surface: string;
|
|
514
|
+
brand: string;
|
|
515
|
+
}
|
|
516
|
+
interface AnchoredMenuProps {
|
|
517
|
+
options: readonly ControlOption[];
|
|
518
|
+
/** The currently-selected value, highlighted in the list ('' = none). */
|
|
519
|
+
selectedValue: string;
|
|
520
|
+
onSelect: (value: string) => void;
|
|
521
|
+
onDismiss: () => void;
|
|
522
|
+
colors: AnchoredMenuColors;
|
|
523
|
+
/** PRE-LOCALIZED accessibility hint applied to every option. */
|
|
524
|
+
optionHint: string;
|
|
525
|
+
/** Base testID: the menu is `${testID}-menu`, each option `${testID}-option-${value}`. */
|
|
526
|
+
testID: string;
|
|
527
|
+
/** Node whose clicks count as "inside" (the anchor) so its own press doesn't self-dismiss. */
|
|
528
|
+
anchorRef: React.RefObject<View | null>;
|
|
529
|
+
}
|
|
530
|
+
declare function AnchoredMenu({ options, selectedValue, onSelect, onDismiss, colors, optionHint, testID, anchorRef, }: AnchoredMenuProps): React.ReactElement;
|
|
531
|
+
|
|
532
|
+
declare const controlStyles: {
|
|
533
|
+
/** The shared bordered box every dense text control renders in. */
|
|
534
|
+
input: {
|
|
535
|
+
borderWidth: number;
|
|
536
|
+
borderRadius: number;
|
|
537
|
+
paddingHorizontal: number;
|
|
538
|
+
paddingVertical: number;
|
|
539
|
+
fontSize: number;
|
|
540
|
+
};
|
|
541
|
+
/** The select trigger: a bordered field box matching the text inputs + a chevron. */
|
|
542
|
+
selectTrigger: {
|
|
543
|
+
flexDirection: "row";
|
|
544
|
+
alignItems: "center";
|
|
545
|
+
justifyContent: "space-between";
|
|
546
|
+
gap: number;
|
|
547
|
+
borderWidth: number;
|
|
548
|
+
borderRadius: number;
|
|
549
|
+
paddingHorizontal: number;
|
|
550
|
+
paddingVertical: number;
|
|
551
|
+
};
|
|
552
|
+
selectTriggerText: {
|
|
553
|
+
fontSize: number;
|
|
554
|
+
flexShrink: number;
|
|
555
|
+
};
|
|
556
|
+
chevron: {
|
|
557
|
+
fontSize: number;
|
|
558
|
+
};
|
|
559
|
+
dateRow: {
|
|
560
|
+
flexDirection: "row";
|
|
561
|
+
gap: number;
|
|
562
|
+
};
|
|
563
|
+
dateCol: {
|
|
564
|
+
gap: number;
|
|
565
|
+
flex: number;
|
|
566
|
+
};
|
|
567
|
+
/**
|
|
568
|
+
* The micro-caption above a sub-control (a date range's From/To) and beside a switch. Note it
|
|
569
|
+
* is deliberately NOT the `control` label voice: it carries no `700`/uppercase, because it
|
|
570
|
+
* names a HALF of a control that already has a `control`-voice label above it. Uppercasing it
|
|
571
|
+
* too would make one field shout twice.
|
|
572
|
+
*/
|
|
573
|
+
subLabel: {
|
|
574
|
+
fontSize: number;
|
|
575
|
+
letterSpacing: number;
|
|
576
|
+
};
|
|
577
|
+
/** Positioning context for a floating `AnchoredMenu` (`position:absolute; top:100%`). */
|
|
578
|
+
anchor: {
|
|
579
|
+
position: "relative";
|
|
580
|
+
};
|
|
581
|
+
menu: {
|
|
582
|
+
position: "absolute";
|
|
583
|
+
top: "100%";
|
|
584
|
+
left: number;
|
|
585
|
+
marginTop: number;
|
|
586
|
+
minWidth: number;
|
|
587
|
+
maxHeight: number;
|
|
588
|
+
borderWidth: number;
|
|
589
|
+
borderRadius: number;
|
|
590
|
+
paddingVertical: number;
|
|
591
|
+
zIndex: number;
|
|
592
|
+
boxShadow: string;
|
|
593
|
+
elevation: number;
|
|
594
|
+
overflow: "hidden";
|
|
595
|
+
};
|
|
596
|
+
option: {
|
|
597
|
+
paddingHorizontal: number;
|
|
598
|
+
paddingVertical: number;
|
|
599
|
+
};
|
|
600
|
+
optionText: {
|
|
601
|
+
fontSize: number;
|
|
602
|
+
};
|
|
603
|
+
error: {
|
|
604
|
+
fontSize: number;
|
|
605
|
+
marginTop: number;
|
|
606
|
+
};
|
|
607
|
+
};
|
|
608
|
+
|
|
609
|
+
/**
|
|
610
|
+
* `suggestOptions` — the ranked substring matcher behind `TypeaheadControl`, generalized from
|
|
611
|
+
* aml-v2's `suggestCountries` and promoted verbatim out of `@dloizides/ui-tables`' private
|
|
612
|
+
* `Filters/utils/suggest.ts`.
|
|
613
|
+
*
|
|
614
|
+
* Ranks: value exact (0) > value prefix (1) > label prefix (2) > label contains (3); ties broken
|
|
615
|
+
* by `label.localeCompare`. Empty/short queries return `[]` — nothing surfaces until `minChars`
|
|
616
|
+
* is typed, mirroring a native `<datalist>`.
|
|
617
|
+
*/
|
|
618
|
+
|
|
619
|
+
/**
|
|
620
|
+
* Rank + cap the options matching `query`. Returns `[]` until `query` (trimmed) is at least
|
|
621
|
+
* `minChars` long, then the best `limit` matches, ranked as documented above.
|
|
622
|
+
*/
|
|
623
|
+
declare function suggestOptions(options: readonly ControlOption[], query: string, minChars: number, limit: number): readonly ControlOption[];
|
|
624
|
+
/** True when `text` is non-empty yet matches no option's value or label exactly (case-insensitive). */
|
|
625
|
+
declare function isUnmatched(options: readonly ControlOption[], text: string): boolean;
|
|
626
|
+
|
|
627
|
+
export { AnchoredMenu, type AnchoredMenuColors, type AnchoredMenuProps, type ChipOption, ChipSelector, type ChipSelectorProps, type ChipVariant, type ControlOption, DEFAULT_OPTIONAL_LABEL, DEFAULT_TYPEAHEAD_MAX_SUGGESTIONS, DEFAULT_TYPEAHEAD_MIN_CHARS, DateRangeControl, type DateRangeControlProps, type DateRangeValue, Field, type FieldChildContext, type FieldChildren, type FieldLabelVariant, type FieldMarker, type FieldProps, FormActions, type FormActionsProps, FormCheckbox, type FormCheckboxProps, FormField, type FormFieldProps, FormSwitch, type FormSwitchProps, SelectControl, type SelectControlProps, type ThemedInput, ThemedTextInput, type ThemedTextInputProps, TypeaheadControl, type TypeaheadControlProps, type UseThemedInputOptions, controlStyles, isUnmatched, suggestOptions, useThemedInput };
|