feat(modal): Allow to prevent default for secondary action

What does this MR do?

This MR aims to solve the scenario presented in this discussion along with providing a more coherent DX. It:

• allows the secondary event to prevent the default close
• adds the relevant tests

Does this MR meet the acceptance criteria?

Conformity

• Code review guidelines.
• GitLab UI's contributing guidlines.
• If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
• If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
• If the MR changes a component's API, integration MR(s) have been opened in the following projects to ensure that the @gitlab/ui package can be upgraded quickly after the changes are released:
  • GitLab: mr_url
  • Customers Portal: mr_url
  • Status Page: mr_url
• Added the ~"component:*" label(s) if applicable.

Closes #969 (closed)