mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-05 09:49:57 +08:00
cbcfd38ca7
* build: try to use dumi as doc tool
* docs: migrate demo structure to dumi way
* refactor: use type export & import
* docs: migrate demo previewer to dumi
* docs: create empty layout & components
* docs: apply custom rehype plugin
* docs: create empty extra pages
* docs: Add Banner component
* chore: move theme tsconfig.json
* docs: home page init
* docs: migrate header (#37896)
* docs: header
* docs: update
* docs: home init
* clean up
* test: fix site lint
* chore: tsc ignore demo
* chore: dumi demo migrate script
* chore: cards
* docs: home layout
* docs: Update locale logic
* docs: fix getLink logic
* chore: fix ci (#37899)
* chore: fix ci
* ci: remove check-ts-demo
* ci: preview build
* test: ignore demo.tsx
* chore: update script
* test: update snapshot
* test: update node and image test
* chore: add .surgeignore
* docs: layout providers (#37908)
* docs: add components sidebar (#37923)
* docs: sidebar
* docs: update docs title
* docs: update design doc
* chore: code clean
* docs: handle changelog page
* docs: add title
* docs: add subtitle
* docs: active header nav
* chore: code clean
* docs: overview
* chore: code clean
* docs: update intl (#37918)
* docs: update intl
* chore: code clean
* docs: update favicons
* chore: update testPathIgnorePatterns
* chore: code clean
* chore: code clean
* chore: copy 404.html (#37996)
* docs: Home page theme picker
* chore: Update migrate script
* docs: home page update
* docs: theme editor style
* docs: theme lang
* chore: update migrate.js
* docs: fix demo (#38094)
* chore: update migrate.js
* docs: update md
* docs: update demo
* test: fix snapshot
* chore: move debug to code attr in migrate script
* chore: update md
Co-authored-by: PeachScript <scdzwyxst@gmail.com>
* feat: overview page
* feat: Migrate `404` page (#38118)
* feat: migrate IconSearch component (#37916)
* feat<site/IconSearch>: copy IconDisplay from site to .dumi
* feat<site/IconSearch>: change docs of icon
* feat<site/IconSearch>: tweak
* feat<site/IconSearch>: use useIntl instead of injectIntl
* feat<site/IconSearch>: fix ts type error
* feat<site/IconSearch>: use intl.formatMessage to render text
* docs: Adjust home btn sizw
* docs: Update doc
* feat: v5 site overview page (#38131)
* feat: site
* fix: fix
* feat: v5 site overview page
* fix: fix path
* fix: fix
* fix: fix
* docs: fix margin logic
* feat: v5 site change-log page (#38137)
* feat: v5 site change-log page (#38162)
* docs: site redirect to home pag
* docs: theme picker
* docs: use react-intl from dumi (#38183)
* docs: Theme Picker
* docs: update dumi config
* docs: home back fix
* docs: picker colorful
* docs: locale of it
* docs: update components desc
* docs: site of links
* docs: update components list
* docs: update desc
* feat: Migrate `DemoWrapper` component (#38166)
* feat: Migrate `DemoWrapper` component
* feat: remove invalid comments and add comment for `key` prop
* docs: FloatButton pure panel
* chore: update demo
* chore: update dumi config
* Revert "chore: update demo"
This reverts commit 028265d3ba
.
* chore: test logic adjust to support cnpm modules
* chore: add locale alias
* docs: /index to /
* docs: add locale redirect head script
* chore: adjust compact
* docs: fix missing token
* feat: compact switch
* chore: code clean
* docs: update home
* docs: fix radius token
* docs: hash of it
* chore: adjust home page
* docs: Add background map
* docs: site theme bac logic
* docs: avatar
* docs: update logo color
* docs: home banner
* docs: adjust tour size
* docs: purepanl update
* docs: transfooter
* docs: update banner gif
* docs: content (#38361)
* docs: title & EditButton
* docs: content
* chore: fix toc
* docs: resource page
* docs: transform resource data from hast
* docs: filename & Resource Card
* chore: enable prerender
* chore: remove less
* docs: toc style
* chore: fix lint
* docs: fix Layout page
* docs: fix CP page
* chore: update demos
* docs: workaround for export dynamic html
* chore: enable demo eslint
* docs: table style
* fix: header shadow
* chore: update snapshot
* fix: toc style
* docs: add title
* docs: Adjust site
* feat: helmet
* docs: site css
* fix: description
* feat: toc debug
* docs: update config-provider
* feat: use colorPanel
* fix: colorPanel value
* feat: anchor ink ball style
* feat: apply theme editor
* fix: code block style
* chore: update demo
* chore: fix lint
* chore: code clean
* chore: update snapshot
* feat: ts2js
* chore: description
* docs: site ready for ssr
includes:
- move client render logic to useEffect in site theme
- extract antd cssinjs to a single css file like bisheng
- workaround to support react@18 pipeableStream for emotion
* chore: bump testing lib
* docs: font size of title
* chore: remove react-sortable-hoc
* chore: update snapshot
* chore: update script
Co-authored-by: PeachScript <scdzwyxst@gmail.com>
Co-authored-by: MadCcc <1075746765@qq.com>
Co-authored-by: zqran <uuxnet@gmail.com>
Co-authored-by: TrickyPi <530257315@qq.com>
Co-authored-by: lijianan <574980606@qq.com>
161 lines
4.8 KiB
TypeScript
161 lines
4.8 KiB
TypeScript
import classNames from 'classnames';
|
|
import FieldForm, { List, useWatch } from 'rc-field-form';
|
|
import type { FormProps as RcFormProps } from 'rc-field-form/lib/Form';
|
|
import type { ValidateErrorEntity } from 'rc-field-form/lib/interface';
|
|
import * as React from 'react';
|
|
import { useMemo } from 'react';
|
|
import type { Options } from 'scroll-into-view-if-needed';
|
|
import { ConfigContext } from '../config-provider';
|
|
import DisabledContext, { DisabledContextProvider } from '../config-provider/DisabledContext';
|
|
import type { SizeType } from '../config-provider/SizeContext';
|
|
import SizeContext, { SizeContextProvider } from '../config-provider/SizeContext';
|
|
import type { ColProps } from '../grid/col';
|
|
import type { FormContextProps } from './context';
|
|
import { FormContext } from './context';
|
|
import useForm, { type FormInstance } from './hooks/useForm';
|
|
import type { FormLabelAlign } from './interface';
|
|
|
|
import useStyle from './style';
|
|
|
|
export type RequiredMark = boolean | 'optional';
|
|
export type FormLayout = 'horizontal' | 'inline' | 'vertical';
|
|
|
|
export interface FormProps<Values = any> extends Omit<RcFormProps<Values>, 'form'> {
|
|
prefixCls?: string;
|
|
colon?: boolean;
|
|
name?: string;
|
|
layout?: FormLayout;
|
|
labelAlign?: FormLabelAlign;
|
|
labelWrap?: boolean;
|
|
labelCol?: ColProps;
|
|
wrapperCol?: ColProps;
|
|
form?: FormInstance<Values>;
|
|
size?: SizeType;
|
|
disabled?: boolean;
|
|
scrollToFirstError?: Options | boolean;
|
|
requiredMark?: RequiredMark;
|
|
/** @deprecated Will warning in future branch. Pls use `requiredMark` instead. */
|
|
hideRequiredMark?: boolean;
|
|
}
|
|
|
|
const InternalForm: React.ForwardRefRenderFunction<FormInstance, FormProps> = (props, ref) => {
|
|
const contextSize = React.useContext(SizeContext);
|
|
const contextDisabled = React.useContext(DisabledContext);
|
|
const { getPrefixCls, direction, form: contextForm } = React.useContext(ConfigContext);
|
|
|
|
const {
|
|
prefixCls: customizePrefixCls,
|
|
className = '',
|
|
size = contextSize,
|
|
disabled = contextDisabled,
|
|
form,
|
|
colon,
|
|
labelAlign,
|
|
labelWrap,
|
|
labelCol,
|
|
wrapperCol,
|
|
hideRequiredMark,
|
|
layout = 'horizontal',
|
|
scrollToFirstError,
|
|
requiredMark,
|
|
onFinishFailed,
|
|
name,
|
|
...restFormProps
|
|
} = props;
|
|
|
|
const mergedRequiredMark = useMemo(() => {
|
|
if (requiredMark !== undefined) {
|
|
return requiredMark;
|
|
}
|
|
|
|
if (contextForm && contextForm.requiredMark !== undefined) {
|
|
return contextForm.requiredMark;
|
|
}
|
|
|
|
if (hideRequiredMark) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}, [hideRequiredMark, requiredMark, contextForm]);
|
|
|
|
const mergedColon = colon ?? contextForm?.colon;
|
|
|
|
const prefixCls = getPrefixCls('form', customizePrefixCls);
|
|
|
|
// Style
|
|
const [wrapSSR, hashId] = useStyle(prefixCls);
|
|
|
|
const formClassName = classNames(
|
|
prefixCls,
|
|
{
|
|
[`${prefixCls}-${layout}`]: true,
|
|
[`${prefixCls}-hide-required-mark`]: mergedRequiredMark === false,
|
|
[`${prefixCls}-rtl`]: direction === 'rtl',
|
|
[`${prefixCls}-${size}`]: size,
|
|
},
|
|
hashId,
|
|
className,
|
|
);
|
|
|
|
const [wrapForm] = useForm(form);
|
|
const { __INTERNAL__ } = wrapForm;
|
|
__INTERNAL__.name = name;
|
|
|
|
const formContextValue = useMemo<FormContextProps>(
|
|
() => ({
|
|
name,
|
|
labelAlign,
|
|
labelCol,
|
|
labelWrap,
|
|
wrapperCol,
|
|
vertical: layout === 'vertical',
|
|
colon: mergedColon,
|
|
requiredMark: mergedRequiredMark,
|
|
itemRef: __INTERNAL__.itemRef,
|
|
form: wrapForm,
|
|
}),
|
|
[name, labelAlign, labelCol, wrapperCol, layout, mergedColon, mergedRequiredMark, wrapForm],
|
|
);
|
|
|
|
React.useImperativeHandle(ref, () => wrapForm);
|
|
|
|
const onInternalFinishFailed = (errorInfo: ValidateErrorEntity) => {
|
|
onFinishFailed?.(errorInfo);
|
|
|
|
let defaultScrollToFirstError: Options = { block: 'nearest' };
|
|
|
|
if (scrollToFirstError && errorInfo.errorFields.length) {
|
|
if (typeof scrollToFirstError === 'object') {
|
|
defaultScrollToFirstError = scrollToFirstError;
|
|
}
|
|
wrapForm.scrollToField(errorInfo.errorFields[0].name, defaultScrollToFirstError);
|
|
}
|
|
};
|
|
|
|
return wrapSSR(
|
|
<DisabledContextProvider disabled={disabled}>
|
|
<SizeContextProvider size={size}>
|
|
<FormContext.Provider value={formContextValue}>
|
|
<FieldForm
|
|
id={name}
|
|
{...restFormProps}
|
|
name={name}
|
|
onFinishFailed={onInternalFinishFailed}
|
|
form={wrapForm}
|
|
className={formClassName}
|
|
/>
|
|
</FormContext.Provider>
|
|
</SizeContextProvider>
|
|
</DisabledContextProvider>,
|
|
);
|
|
};
|
|
|
|
const Form = React.forwardRef<FormInstance, FormProps>(InternalForm) as <Values = any>(
|
|
props: React.PropsWithChildren<FormProps<Values>> & { ref?: React.Ref<FormInstance<Values>> },
|
|
) => React.ReactElement;
|
|
|
|
export { useForm, List, type FormInstance, useWatch };
|
|
|
|
export default Form;
|