@stonecrop/aform 0.9.1 → 0.10.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/dist/aform.d.ts CHANGED
@@ -55,10 +55,10 @@ export declare type BaseSchema = {
55
55
  */
56
56
  component?: string;
57
57
  /**
58
- * A placeholder value for the field
59
- * @beta
58
+ * Per-field rendering mode override; takes precedence over the AForm-level `mode` prop
59
+ * @public
60
60
  */
61
- value?: any;
61
+ mode?: FormMode;
62
62
  };
63
63
 
64
64
  /**
@@ -87,10 +87,10 @@ export declare type ComponentProps = {
87
87
  */
88
88
  required?: boolean;
89
89
  /**
90
- * Indicate whether elements inside the component are read-only
90
+ * The rendering mode for the component
91
91
  * @public
92
92
  */
93
- readOnly?: boolean;
93
+ mode?: FormMode;
94
94
  /**
95
95
  * Set a unique identifier for elements inside the component
96
96
  * @public
@@ -147,11 +147,6 @@ export declare type DoctypeSchema = BaseSchema & {
147
147
  * @public
148
148
  */
149
149
  schema?: SchemaTypes[];
150
- /**
151
- * Indicate whether the nested form is read-only
152
- * @public
153
- */
154
- readOnly?: boolean;
155
150
  };
156
151
 
157
152
  /**
@@ -176,6 +171,12 @@ export declare type FieldsetSchema = BaseSchema & {
176
171
  collapsible?: boolean;
177
172
  };
178
173
 
174
+ /**
175
+ * The rendering mode for AForm components
176
+ * @public
177
+ */
178
+ export declare type FormMode = 'edit' | 'read' | 'display';
179
+
179
180
  /**
180
181
  * Schema structure for defining forms inside AForm
181
182
  * @public
@@ -290,11 +291,6 @@ export declare type TableDoctypeSchema = BaseSchema & {
290
291
  * @public
291
292
  */
292
293
  rows?: TableRow[];
293
- /**
294
- * Indicate whether the table is read-only
295
- * @public
296
- */
297
- readOnly?: boolean;
298
294
  };
299
295
 
300
296
  /**