Update the open dialog API with more options.

[maheichyk]

This PR suggest to update module API with more options to control rendering of the dialog shown:

1. Enable/disable dialog submit button.
2. Custom labels for cancel and submit (action) buttons.

[richvdh]

Thank you for the contribution. I have a few requests.

[dhenneke]

@richvdh Thanks for your comments and sorry for not coming back to them earlier. I applied the requested changes and changed the interface slightly, so that we can also change the labels and the title from the component if necessary.

[richvdh]

Context on this PR: it seems to be documenting the changes made to openDialog in matrix-org/matrix-react-sdk#10536 matrix-org/matrix-react-sdk#11395

[richvdh]

I think I'm beginning to get my head round this. I think what would really help is clearer documentation about how the various classes and functions interact.

I've made some suggestions, but please check if my suggestions are accurate and make sense to you -- and feel free to improve on my suggestions too!

[dhenneke]

Just a comment: thb, I'm unsure why this was not defined as BodyComponent: React.Component<P>. Then the users wouldn't need to work with the ref and also the props in here would be more clear.

// could do this:
openDialog("title", DialogBody, { greeting: 'Hi!' });

// instead of this:
openDialog(
  "title",
  (props, ref) => (
    <DialogBody
      ref={ref}
      {...props}
      // why not add greeting="Hi!" here instead of passing it in the next line?
    />
  ),
  { greeting: 'Hi!' },
);

But nothing I want to change (or even do without breaking compatibility).

[richvdh]

yeah, no idea :(

[dhenneke]

@richvdh Thanks for the feedback. I applied your suggestions and slightly tweaked them.

[richvdh]

Thank you for your work on this; I think it's ready to merge!

[dhenneke]

Thanks for the review! If you could create a release of the module api, I can finish matrix-org/matrix-react-sdk#11395 as the next step.

[richvdh]

Done: https://github.com/matrix-org/matrix-react-sdk-module-api/releases/tag/v2.0.0