frontend-plus-react 0.4.2 → 0.6.0

package/dist/index.d.cts

@@ -62,7 +62,7 @@ interface CellFeedback {
 }
 type CellFeedbackMap = Map<string, CellFeedback>;
 /** Lo que el manejo de teclas del editor necesita saber de la tecla (sirve para un evento real o uno encolado) */
-type TeclaDeEditor = Pick<React.KeyboardEvent, 'key' | 'target'>;
+type TeclaDeEditor = Pick<React.KeyboardEvent, 'key' | 'target'> & Partial<Pick<React.KeyboardEvent, 'shiftKey' | 'ctrlKey' | 'altKey' | 'metaKey'>>;
 interface InputRendererProps<R extends FilaDeDatos, S> {
     column: Column<R, S>;
     row: R;
@@ -70,7 +70,8 @@ interface InputRendererProps<R extends FilaDeDatos, S> {
     onRowChange: (row: R, commitChanges?: boolean) => void;
     onClose: (commitChanges?: boolean, shouldFocusCell?: boolean) => void;
     tableDefinition: TableDefinition;
-    onKeyPress?: (rowIndex: number, columnKey: string, event: TeclaDeEditor, handleCommit: (currentValue: unknown, closeEditor: boolean, focusNextCell: boolean) => Promise<void>) => void;
+    /** Con cada tecla del editor. `valorActual` es el texto que tiene el editor; devuelve true si la tecla la resolvió la grilla (dejó la celda) y hay que cancelar su efecto nativo */
+    onKeyPress?: (rowIndex: number, columnKey: string, event: TeclaDeEditor, handleCommit: (currentValue: unknown, closeEditor: boolean, focusNextCell: boolean) => Promise<void>, valorActual: unknown) => boolean;
     /** El editor se registra para recibir las teclas (F4) que caen en la celda antes de que él tenga el foco; devuelve la baja */
     registrarEditor?: (procesar: (key: string) => void) => () => void;
     setTableData: React.Dispatch<React.SetStateAction<FilaDeDatos[]>>;
@@ -93,6 +94,10 @@ interface FixedField {
     fieldName: string;
     value: unknown;
     until?: unknown;
+    /** Como en backend-plus (my-tables.js): un fixedField con `range` o `until` no fija el valor de la columna (la deja visible y editable) */
+    range?: boolean;
+    /** Como en backend-plus: el campo fijo no oculta su columna */
+    show?: boolean;
 }
 interface ConfirmDialogProps {
     open: boolean;
@@ -230,9 +235,23 @@ interface DataGridOption {
     visible?: boolean;
 }
 
+/** Una condición de la fila de filtros: `operator` es uno de los de backend-plus (=, ~, !~, >, >=, <, <=, !=, ∅, !=∅, /R/i) */
+interface FiltroInicial {
+    column: string;
+    operator: string;
+    value: unknown;
+}
+
 interface GenericDataGridProps {
     tableName: string;
     fixedFields?: FixedField[];
+    /** Como en backend-plus (`fc` de la dirección o del menú): la fila de filtros con la que se abre la grilla */
+    filterColumns?: FiltroInicial[][];
+    /** `td`: lo que se le cambia a la definición de la tabla que manda el servidor */
+    tableDef?: Record<string, unknown>;
+    /** `pf` y `pick` de backend-plus: viajan con el pedido de datos */
+    parameterFunctions?: Record<string, unknown>;
+    pick?: string;
     /** Abre un detalle en otra pestaña (Ctrl+click o botón del medio en el botón del detalle) */
     onOpenDetail?: (tableName: string, fixedFields: FixedField[], label: string, ancestors: Ancestor[]) => void;
     gridStyles?: React$1.CSSProperties;

package/dist/index.d.ts

@@ -62,7 +62,7 @@ interface CellFeedback {
 }
 type CellFeedbackMap = Map<string, CellFeedback>;
 /** Lo que el manejo de teclas del editor necesita saber de la tecla (sirve para un evento real o uno encolado) */
-type TeclaDeEditor = Pick<React.KeyboardEvent, 'key' | 'target'>;
+type TeclaDeEditor = Pick<React.KeyboardEvent, 'key' | 'target'> & Partial<Pick<React.KeyboardEvent, 'shiftKey' | 'ctrlKey' | 'altKey' | 'metaKey'>>;
 interface InputRendererProps<R extends FilaDeDatos, S> {
     column: Column<R, S>;
     row: R;
@@ -70,7 +70,8 @@ interface InputRendererProps<R extends FilaDeDatos, S> {
     onRowChange: (row: R, commitChanges?: boolean) => void;
     onClose: (commitChanges?: boolean, shouldFocusCell?: boolean) => void;
     tableDefinition: TableDefinition;
-    onKeyPress?: (rowIndex: number, columnKey: string, event: TeclaDeEditor, handleCommit: (currentValue: unknown, closeEditor: boolean, focusNextCell: boolean) => Promise<void>) => void;
+    /** Con cada tecla del editor. `valorActual` es el texto que tiene el editor; devuelve true si la tecla la resolvió la grilla (dejó la celda) y hay que cancelar su efecto nativo */
+    onKeyPress?: (rowIndex: number, columnKey: string, event: TeclaDeEditor, handleCommit: (currentValue: unknown, closeEditor: boolean, focusNextCell: boolean) => Promise<void>, valorActual: unknown) => boolean;
     /** El editor se registra para recibir las teclas (F4) que caen en la celda antes de que él tenga el foco; devuelve la baja */
     registrarEditor?: (procesar: (key: string) => void) => () => void;
     setTableData: React.Dispatch<React.SetStateAction<FilaDeDatos[]>>;
@@ -93,6 +94,10 @@ interface FixedField {
     fieldName: string;
     value: unknown;
     until?: unknown;
+    /** Como en backend-plus (my-tables.js): un fixedField con `range` o `until` no fija el valor de la columna (la deja visible y editable) */
+    range?: boolean;
+    /** Como en backend-plus: el campo fijo no oculta su columna */
+    show?: boolean;
 }
 interface ConfirmDialogProps {
     open: boolean;
@@ -230,9 +235,23 @@ interface DataGridOption {
     visible?: boolean;
 }
 
+/** Una condición de la fila de filtros: `operator` es uno de los de backend-plus (=, ~, !~, >, >=, <, <=, !=, ∅, !=∅, /R/i) */
+interface FiltroInicial {
+    column: string;
+    operator: string;
+    value: unknown;
+}
+
 interface GenericDataGridProps {
     tableName: string;
     fixedFields?: FixedField[];
+    /** Como en backend-plus (`fc` de la dirección o del menú): la fila de filtros con la que se abre la grilla */
+    filterColumns?: FiltroInicial[][];
+    /** `td`: lo que se le cambia a la definición de la tabla que manda el servidor */
+    tableDef?: Record<string, unknown>;
+    /** `pf` y `pick` de backend-plus: viajan con el pedido de datos */
+    parameterFunctions?: Record<string, unknown>;
+    pick?: string;
     /** Abre un detalle en otra pestaña (Ctrl+click o botón del medio en el botón del detalle) */
     onOpenDetail?: (tableName: string, fixedFields: FixedField[], label: string, ancestors: Ancestor[]) => void;
     gridStyles?: React$1.CSSProperties;