Yup validation requiring at least one selection

Question

I'm trying to require one of two checkboxes to be selected in a form. The following doesn't seem to work according to the documentation:

yearGroups: yup.object().shape({
          primary: yup.bool().when('yearGroups.primary', {
            is: false,
            then: yup
              .bool()
              .oneOf([true], '')
              .required()
          }),
          secondary: yup.bool().when('yearGroups.secondary', {
            is: false,
            then: yup
              .bool()
              .oneOf([true], '')
              .required()
          }),
        }),

Do you have any error message? – NearHuscarl Oct 04 '21 at 11:45 — NearHuscarl, Oct 04 '21 at 11:45
no, I just don't get the validation I require @NearHuscarl – Oct 04 '21 at 11:49 — , Oct 04 '21 at 11:49

score 3 · Accepted Answer · answered Oct 04 '21 at 11:59

Try this one. See the explanation here:

const schema = yup.object().shape({
  yearGroups: yup.object().shape(
    {
      primary: yup.bool().when("secondary", {
        is: (secondary) => !secondary,
        then: yup.bool().oneOf([true], "At least one needs to be checked")
      }),
      secondary: yup.bool().when("primary", {
        is: (primary) => !primary,
        then: yup.bool().oneOf([true], "At least one needs to be checked")
      })
    },
    [
      ["primary", "secondary"],
      ["secondary", "primary"]
    ]
  )
});

Live Demo

This example worked for me. Note that u need to use the dependencies array into the .shape() function. :) — Janis Basis Basovs, Nov 13 '22 at 20:29

score 0 · Answer 2 · answered Oct 04 '21 at 11:46

This is some kind of duplication, but here are solutions: using .test() function or create your own Method - .addMethod

.test function, example here
.addMethod function, example here

I am using .addMethod in my code, it's more flexible, you can define all params you need. Once you defined it in the file, you can call it everywhere you need.

Yup validation requiring at least one selection

2 Answers2

Live Demo