ui/build/data-renderer/formatted-value.renderer.svelte
ui/build/data-renderer/formatted-value.renderer.svelte
Interfaces
FormattedValueRendererProps
Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/formatted-value.renderer.svelte.d.ts:2
Props every datatype renderer receives from the strategy router.
Extends
Properties
class?
optional class?: string;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:18
Inherited from
disabled?
optional disabled?: boolean;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:9
Inherited from
field
field: CollectionField;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:5
Inherited from
format
format: (context) => string | number | null | undefined;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/formatted-value.renderer.svelte.d.ts:3
Parameters
| Parameter | Type |
|---|---|
context |
{ field: CollectionField<string>; row: any; value: unknown; } |
context.field |
CollectionField<string> |
context.row |
any |
context.value |
unknown |
Returns
string | number | null | undefined
id?
optional id?: string;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:7
Inherited from
locale?
optional locale?: string;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:17
Inherited from
mode?
optional mode?: "display" | "edit";Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:8
Inherited from
onPendingChange?
optional onPendingChange?: (pending) => void;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:13
Prevent submission while this control is still preparing its value (for example, an upload).
Parameters
| Parameter | Type |
|---|---|
pending |
boolean |
Returns
void
Inherited from
FieldRendererProps.onPendingChange
onRowChange?
optional onRowChange?: (patch) => void;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:16
Parameters
| Parameter | Type |
|---|---|
patch |
Record<string, unknown> |
Returns
void
Inherited from
FieldRendererProps.onRowChange
onValueChange?
optional onValueChange?: (value) => void;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:11
Parameters
| Parameter | Type |
|---|---|
value |
unknown |
Returns
void
Inherited from
FieldRendererProps.onValueChange
placeholder?
optional placeholder?: string;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:10
Inherited from
FieldRendererProps.placeholder
row?
optional row?: Record<string, unknown>;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:15
Full matrix/form row when the renderer needs sibling fields.
Inherited from
value
value: unknown;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/data-renderer.types.d.ts:6
Inherited from
Type Aliases
default
type default = ReturnType<typeof default>;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/formatted-value.renderer.svelte.d.ts:9
Variables
default
const default: Component;Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/formatted-value.renderer.svelte.d.ts:9