camera.ui Node SDK

Appearance

@camera.ui/sdk / storage / JsonSchemaString

Interface: JsonSchemaString ​

Defined in: storage/index.ts:175

Complete string schema with callbacks.

Extends ​

Properties ​

condition? ​

optional condition?: SchemaCondition | SchemaCondition[]

Defined in: storage/index.ts:77

Condition for conditional field visibility. Array = all must be true (AND).

Inherited from ​

JsonBaseSchema.condition

defaultValue? ​

optional defaultValue?: string

Defined in: storage/index.ts:75

Default value when not set

Inherited from ​

JsonBaseSchema.defaultValue

description ​

description: string

Defined in: storage/index.ts:56

Field description/help text

Inherited from ​

JsonBaseSchema.description

format? ​

optional format?: "date-time" | "date" | "time" | "email" | "uuid" | "ipv4" | "ipv6" | "password" | "qrCode" | "image"

Defined in: storage/index.ts:123

String format for validation/display. See type docs for behavior per format.

Inherited from ​

JsonStringSchema.format

group? ​

optional group?: string

Defined in: storage/index.ts:58

Optional group name for organizing fields

Inherited from ​

JsonBaseSchema.group

hidden? ​

optional hidden?: boolean

Defined in: storage/index.ts:67

Hide field from UI

Inherited from ​

JsonBaseSchema.hidden

key ​

key: string

Defined in: storage/index.ts:52

Unique field identifier

Inherited from ​

JsonBaseSchema.key

maxLength? ​

optional maxLength?: number

Defined in: storage/index.ts:127

Maximum string length (inclusive).

Inherited from ​

JsonStringSchema.maxLength

minLength? ​

optional minLength?: number

Defined in: storage/index.ts:125

Minimum string length (inclusive).

Inherited from ​

JsonStringSchema.minLength

onGet? ​

optional onGet?: () => Promise<any>

Defined in: storage/index.ts:102

Callback to get computed value

Returns ​

Promise<any>

Inherited from ​

JsonBaseSchema.onGet

onSet? ​

optional onSet?: (newValue, oldValue) => Promise<void>

Defined in: storage/index.ts:100

Callback when value changes

Parameters ​

newValue ​

any

oldValue ​

any

Returns ​

Promise<void>

Inherited from ​

JsonBaseSchema.onSet

placeholder? ​

optional placeholder?: string

Defined in: storage/index.ts:73

Placeholder text for empty fields

Inherited from ​

JsonBaseSchema.placeholder

readonly? ​

optional readonly?: boolean

Defined in: storage/index.ts:71

Make field read-only

Inherited from ​

JsonBaseSchema.readonly

required? ​

optional required?: boolean

Defined in: storage/index.ts:69

Mark field as required

Inherited from ​

JsonBaseSchema.required

store? ​

optional store?: boolean

Defined in: storage/index.ts:98

Whether to persist this field to storage

Inherited from ​

JsonBaseSchema.store

title ​

title: string

Defined in: storage/index.ts:54

Display title

Inherited from ​

JsonBaseSchema.title

type ​

type: "string"

Defined in: storage/index.ts:176

Field type

Overrides ​

JsonBaseSchema.type