@object-ui/fields 17.3.0 → 17.5.0

package/dist/index.d.ts

@@ -29,24 +29,36 @@ export interface CellRendererProps {
  */
 export declare function coerceToSafeValue(value: unknown): string | number | boolean | null | undefined;
 export { resolveFieldCurrency };
-export declare function formatCurrency(value: number, currency?: string): string;
+export declare function formatCurrency(value: number, currency?: string, locale?: string): string;
 /**
  * Format currency value in compact form for mobile display.
  * E.g., $150,000 → $150K, $1,200,000 → $1.2M
  * When `currency` is undefined, returns a compact number without symbol.
  */
-export declare function formatCompactCurrency(value: number, currency?: string): string;
+export declare function formatCompactCurrency(value: number, currency?: string, locale?: string): string;
 /**
  * Format a plain number with thousands separators, no currency symbol.
  * Used as a safe fallback when a currency-typed field has no `currency`
  * configured — we'd rather render `1,234.50` than silently assume USD.
  */
-export declare function formatNumber(value: number, decimals?: number): string;
+export declare function formatNumber(value: number, decimals?: number, locale?: string): string;
 /**
- * Format percent value
+ * Format percent value.
  * Handles both decimal (0.8 = 80%) and whole number (80 = 80%) inputs.
+ *
+ * `locale` is the third positional parameter, matching {@link formatNumber} and
+ * {@link formatCurrency} — the shape the sibling formatters already use.
+ * Callers should pass the tag from `useDisplayLocale()`.
+ *
+ * Before objectui#4553 this function took no locale and never touched `Intl`:
+ * its whole body was `${percentDisplayValue(value).toFixed(precision)}%`, so it
+ * rendered in NO locale rather than the machine's — an ASCII decimal mark and
+ * never a grouping separator, byte-identical on every machine. That made
+ * `1235%` the output everywhere, which is wrong in en-US as well as in German,
+ * so the grouping and the locale are fixed together: en output MOVES from
+ * `1235%` to `1,235%` at four digits and up, and that move is the fix.
  */
-export declare function formatPercent(value: number, precision?: number): string;
+export declare function formatPercent(value: number, precision?: number, locale?: string): string;
 /**
  * Humanize a snake_case or kebab-case string into Title Case.
  * Used as fallback label when no explicit option.label exists.
@@ -81,9 +93,17 @@ export declare function formatRelativeDate(value: string | Date | number, option
  */
 export declare function formatDate(value: string | Date | number, style?: string, options?: DateDisplayOptions): string;
 /**
- * Format datetime value
+ * Format datetime value.
+ *
+ * `options` mirrors {@link formatDate}'s and is optional, so an existing
+ * caller that passes nothing keeps the exact runtime-default behavior it had.
+ * Before objectui#4272 the parameter did not exist at all, which meant no
+ * caller could localize this function however hard it tried — it always handed
+ * `Intl` an `undefined` tag, i.e. the MACHINE's locale, which is neither of
+ * the repo's two locale channels. Callers should pass the tag from
+ * `useDisplayLocale()`.
  */
-export declare function formatDateTime(value: string | Date | number): string;
+export declare function formatDateTime(value: string | Date | number, options?: DateDisplayOptions): string;
 /**
  * Text field cell renderer
  */
@@ -240,6 +260,26 @@ export declare function HtmlCellRenderer({ value }: CellRendererProps): React.Re
  * or a `[lat, lng]` array. Falls back to compact JSON for anything else.
  */
 export declare function LocationCellRenderer({ value }: CellRendererProps): React.ReactElement;
+/**
+ * Renders an `address` value as a formatted single-line postal address instead
+ * of stringified JSON (objectui#4037).
+ *
+ * The detail page's display registry mapped `address` to {@link JsonCellRenderer},
+ * so a populated address read as `{"street":"中策路 1 号","city":"杭州",…}` on the
+ * detail page and in its inline-edit read state — while the very same value
+ * rendered correctly in the create/edit dialog, whose input registry has always
+ * carried `address`. Read side only: nothing about the input widget changes.
+ *
+ * Layout is not invented here. It is {@link formatAddress} — the rule
+ * `AddressField`'s own readonly branch already applied, over the sub-field set
+ * its inputs expose — so a readonly form and a detail page cannot spell one
+ * stored address two ways.
+ *
+ * Anything `formatAddress` cannot recognize falls back to compact JSON rather
+ * than rendering blank: an unknown shape stays visible (today's behaviour) and
+ * is never silently swallowed by the fix.
+ */
+export declare function AddressCellRenderer({ value }: CellRendererProps): React.ReactElement;
 /**
  * Get the appropriate cell renderer for a field type
  */
@@ -304,11 +344,6 @@ export declare function registerField(fieldType: string): void;
  * registerAllFields();
  */
 export declare function registerAllFields(): void;
-/**
- * Legacy function - kept for backward compatibility
- * @deprecated Use registerAllFields() instead
- */
-export declare function registerFields(): void;
 export * from './widgets/types';
 export * from './widgets/file-value';
 export * from './FieldEditWidget';
@@ -363,3 +398,4 @@ export * from './widgets/TagsField';
 export { withFieldCarrier } from './withFieldCarrier';
 export { toDomProps } from './widgets/toDomProps';
 export type { DomProps } from './widgets/toDomProps';
+export { toDateInputValue, toDateTimeInputValue, fromDateTimeInputValue, } from './widgets/nativeDateValue';