feat: add optional extra prop to ChooseOptions (#5)

Author: atheck

README.md

@@ -150,6 +150,7 @@ You can use the `ConfirmComponentHost` in multiple places in your application. T
 | cancelCaption | The caption of the action to cancel the choice. |
 | onConfirm | Call this function when a choice is selected. |
 | onCancel | Call this function when the choice is cancelled. |
+| extra | Optional custom data. |
 
 ## How to use the `ConfirmService`
 
@@ -185,6 +186,7 @@ To show a choice to the user, use the `choose` function. It takes one options pa
 | options | yes | The possible choices. |
 | type | no | The optional type of the options to distinguish when rendering. |
 | cancelCaption | no | The caption of the cancel action. If not provided the `cancel` property of `strings` is used. The default is "Cancel". |
+| extra | no | Optional custom data. |
 
 This function returns a `Promise`. It will be resolved with the selected option and rejected if the choice is cancelled.
 

src/Component.tsx

@@ -20,8 +20,9 @@ interface State {
         isOpen: boolean,
         title: string | undefined,
         options: Service.Option [],
-        type?: string,
+        type: string | undefined,
         cancelCaption: string,
+        extra: unknown,
         callback: (result: Service.Option | null) => void,
     },
 }
@@ -50,6 +51,7 @@ interface ChoiceRenderProps {
     options: Service.Option [],
     type?: string,
     cancelCaption: string,
+    extra: unknown,
     onConfirm: (option: Service.Option) => void,
     onCancel: () => void,
 }
@@ -103,6 +105,7 @@ class ConfirmComponentHost extends React.Component<Props, State> {
                 options: [],
                 type: undefined,
                 cancelCaption: "",
+                extra: undefined,
                 callback () {
                     // blank
                 },
@@ -229,6 +232,7 @@ class ConfirmComponentHost extends React.Component<Props, State> {
                 title: props.title,
                 options: props.options,
                 type: props.type,
+                extra: props.extra,
                 cancelCaption: props.cancelCaption ?? strings?.cancel ?? "Cancel",
                 callback,
             },

src/Service.ts

@@ -60,6 +60,10 @@ interface ChooseOptions<TData extends Option = Option> {
      * The optional caption of the cancel action.
      */
     cancelCaption?: string,
+    /**
+     * Optional custom data.
+     */
+    extra?: unknown,
 }
 
 interface Handlers {