docs(@uform/core): improve docs (#402)

alibaba · Nov 19, 2019 · ded9b93 · ded9b93
1 parent 4cf4bb8
commit ded9b93
Show file tree

Hide file tree

Showing 8 changed files with 355 additions and 256 deletions.
diff --git a/packages/antd/src/index.tsx b/packages/antd/src/index.tsx
@@ -10,8 +10,6 @@ export * from '@uform/react-schema-renderer'
 export * from './components'
 export * from './types'
 export { mapStyledProps, mapTextComponent } from './shared'
-export const SchemaForm: React.FC<
-  IAntdSchemaFormProps
-> = SchemaMarkupForm as any
+export const SchemaForm: React.FC<IAntdSchemaFormProps> = SchemaMarkupForm as any
 export const Field: React.FC<IAntdSchemaFieldProps> = SchemaMarkupField
 export default SchemaForm
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -907,9 +907,24 @@ interface IMutators {
     }>
 }
 
+type InternalFormats =
+  | 'url'
+  | 'email'
+  | 'ipv6'
+  | 'ipv4'
+  | 'idcard'
+  | 'taodomain'
+  | 'qq'
+  | 'phone'
+  | 'money'
+  | 'zh'
+  | 'date'
+  | 'zip'
+  | string
+
 interface ValidateDescription {
      // Regular rule type
-     format?: string
+     format?: InternalFormats
      // Custom validator
      validator?: CustomValidator
      // Is it required?