List.d.ts 970 B

1234567891011121314151617181920212223
  1. import * as React from 'react';
  2. import type { NamePath, StoreValue, ValidatorRule, Meta } from './interface';
  3. export interface ListField {
  4. name: number;
  5. key: number;
  6. isListField: boolean;
  7. }
  8. export interface ListOperations {
  9. add: (defaultValue?: StoreValue, index?: number) => void;
  10. remove: (index: number | number[]) => void;
  11. move: (from: number, to: number) => void;
  12. }
  13. export interface ListProps<Values = any> {
  14. name: NamePath<Values>;
  15. rules?: ValidatorRule[];
  16. validateTrigger?: string | string[] | false;
  17. initialValue?: any[];
  18. children?: (fields: ListField[], operations: ListOperations, meta: Meta) => JSX.Element | React.ReactNode;
  19. /** @private Passed by Form.List props. Do not use since it will break by path check. */
  20. isListField?: boolean;
  21. }
  22. declare function List<Values = any>({ name, initialValue, children, rules, validateTrigger, isListField, }: ListProps<Values>): React.JSX.Element;
  23. export default List;