@stonecrop/aform 0.9.2 → 0.10.1

package/dist/aform.d.ts

@@ -55,10 +55,10 @@ export declare type BaseSchema = {
      */
     component?: string;
     /**
-     * A placeholder value for the field
-     * @beta
+     * Per-field rendering mode override; takes precedence over the AForm-level `mode` prop
+     * @public
      */
-    value?: any;
+    mode?: FormMode;
 };
 
 /**
@@ -77,7 +77,10 @@ export declare type ComponentProps = {
      */
     label?: string;
     /**
-     * The masking string to apply to inputs inside the component
+     * The mask to apply to inputs inside the component. Accepts either a plain
+     * mask string (e.g. `"(###) ###-####"`) or a stringified arrow function that
+     * receives `locale` and returns a mask string
+     * (e.g. `"(locale) => locale === 'en-US' ? '(###) ###-####' : '####-######'"`).
      * @public
      */
     mask?: string;
@@ -87,10 +90,10 @@ export declare type ComponentProps = {
      */
     required?: boolean;
     /**
-     * Indicate whether elements inside the component are read-only
+     * The rendering mode for the component
      * @public
      */
-    readOnly?: boolean;
+    mode?: FormMode;
     /**
      * Set a unique identifier for elements inside the component
      * @public
@@ -147,11 +150,6 @@ export declare type DoctypeSchema = BaseSchema & {
      * @public
      */
     schema?: SchemaTypes[];
-    /**
-     * Indicate whether the nested form is read-only
-     * @public
-     */
-    readOnly?: boolean;
 };
 
 /**
@@ -176,6 +174,12 @@ export declare type FieldsetSchema = BaseSchema & {
     collapsible?: boolean;
 };
 
+/**
+ * The rendering mode for AForm components
+ * @public
+ */
+export declare type FormMode = 'edit' | 'read' | 'display';
+
 /**
  * Schema structure for defining forms inside AForm
  * @public
@@ -193,17 +197,6 @@ export declare type FormSchema = BaseSchema & {
     edit?: boolean;
     /**
      * The field type for the schema field
-     *
-     * @remarks
-     * This must be a string that represents the field type. A mask string will be automatically
-     * applied for the following field types:
-     * - Date ('##/##/####')
-     * - Datetime ('####/##/## ##:##')
-     * - Time ('##:##')
-     * - Fulltime ('##:##:##')
-     * - Phone ('(###) ### - ####')
-     * - Card ('#### #### #### ####')
-     *
      * @public
      */
     fieldtype?: string;
@@ -223,8 +216,11 @@ export declare type FormSchema = BaseSchema & {
      */
     width?: string;
     /**
-     * The mask string for the field
-     * @beta
+     * The mask to apply to the field. Accepts either a plain mask string
+     * (e.g. `"##/##/####"`) or a stringified arrow function that receives `locale`
+     * and returns a mask string
+     * (e.g. `"(locale) => locale === 'en-US' ? '(###) ###-####' : '####-######'"`).
+     * @public
      */
     mask?: string;
 };
@@ -290,11 +286,6 @@ export declare type TableDoctypeSchema = BaseSchema & {
      * @public
      */
     rows?: TableRow[];
-    /**
-     * Indicate whether the table is read-only
-     * @public
-     */
-    readOnly?: boolean;
 };
 
 /**