Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: support groupId and ignore rule #589

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: support groupId and ignore rule #589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 42 additions & 5 deletions docs/examples/validate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export default () => {

return (
<React.Fragment>
<Field name="username" rules={[{ required: true }]}>
<Field name="username" rules={[{ required: true, groupId: 'GroupA', id: '1' }]}>
<Input
placeholder="Username"
onChange={({ target: { value } }) => {
Expand All @@ -64,8 +64,10 @@ export default () => {
<Field
name="password"
rules={[
{ required: true },
{ required: true, groupId: 'GroupA', id: '2' },
context => ({
groupId: 'GroupA',
id: '3',
validator(_, __, callback) {
if (context.isFieldTouched('password2')) {
context.validateFields(['password2']);
Expand All @@ -85,8 +87,10 @@ export default () => {
<Field
name="password2"
rules={[
{ required: true },
{ required: true, groupId: 'GroupB', id: '4' },
context => ({
groupId: 'GroupB',
id: '5',
validator(rule, value, callback) {
const { password } = context.getFieldsValue(true);
if (password !== value) {
Expand All @@ -102,7 +106,7 @@ export default () => {
<FieldState form={form} name="password2" />
<Error>{password2Error}</Error>

<Field name="renderProps" rules={[{ required: true }]}>
<Field name="renderProps" rules={[{ required: true, id: '6' }]}>
{(control, meta) => (
<div>
Use Meta:
Expand All @@ -117,8 +121,9 @@ export default () => {
name="validateTrigger"
validateTrigger={['onSubmit', 'onChange']}
rules={[
{ required: true, validateTrigger: 'onSubmit' },
{ required: true, validateTrigger: 'onSubmit', id: '7' },
{
id: '8',
validator(rule, value, callback) {
setTimeout(() => {
if (Number(value).toString() === value) {
Expand Down Expand Up @@ -155,6 +160,38 @@ export default () => {
>
Validate All
</button>
<button
type="button"
onClick={() => {
form.validateFields({
groupId: 'GroupA',
});
}}
>
Validate GroupA
</button>
<button
type="button"
onClick={() => {
form.validateFields({
groupId: 'GroupB',
});
}}
>
Validate GroupB
</button>
<button
type="button"
onClick={() => {
form.validateFields({
ignore: (rule) => {
return (Number(rule.id) % 2) === 0
}
});
}}
>
Validate Logical
</button>

<button type="submit">Submit</button>
</React.Fragment>
Expand Down
10 changes: 9 additions & 1 deletion src/Field.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ class Field extends React.Component<InternalFieldProps, FieldState> implements F
const namePath = this.getNamePath();
const currentValue = this.getValue();

const { triggerName, validateOnly = false } = options || {};
const { triggerName, validateOnly = false, groupId, ignore } = options || {};

// Force change to async to avoid rule OOD under renderProps field
const rootPromise = Promise.resolve().then(() => {
Expand All @@ -387,6 +387,14 @@ class Field extends React.Component<InternalFieldProps, FieldState> implements F
});
}

if (groupId) {
filteredRules = filteredRules.filter(rule => rule.groupId === groupId)
}

if (ignore) {
filteredRules = filteredRules.filter(rule => !ignore(rule))
}

const promise = validateRules(
namePath,
currentValue,
Expand Down
4 changes: 4 additions & 0 deletions src/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ interface BaseRule {
transform?: (value: StoreValue) => StoreValue;
type?: RuleType;
whitespace?: boolean;
id?: string
groupId?: string

/** Customize rule level `validateTrigger`. Must be subset of Field `validateTrigger` */
validateTrigger?: string | string[];
Expand Down Expand Up @@ -131,6 +133,8 @@ export interface ValidateOptions {
* Validate only and not trigger UI and Field status update
*/
validateOnly?: boolean;
groupId?: string
ignore?: (rule: RuleObject) => boolean
}

export type ValidateFields<Values = any> = {
Expand Down