loon-bulma-react 2023.0.2 → 2023.0.4

package/README.md

@@ -264,7 +264,7 @@ export function MyComponent() {
 
 De `useConfirm()`-hook exporteert nog meer dan alleen de `confirm()`-function. Deze functies zijn voor intern gebruik.
 
-- confirm: `(content: string) => Promise<boolean>`;
+- confirm: `(content: string|React.ReactNode) => Promise<boolean>`;
 - (AFBLIJVEN) onConfirm: `() => void`;
 - (AFBLIJVEN) onCancel: `() => void`;
 - (AFBLIJVEN) confirmState: `State` van de confirm req;

package/dist/contexts/Confirm/ConfirmContextProvider.d.ts

@@ -6,7 +6,19 @@ declare type State = {
     cancel: string;
     others?: React.ReactNode;
 };
-export declare function ConfirmProvider({ children }: {
+/**
+ * Confirm provider om `useConfirm`-hook te kunnen gebruiken.
+ * @param children de children
+ * @returns
+ * @example // index.tsx of App.tsx
+ * root.render(
+ * <ConfirmProvider>
+ *   <>
+ *    // ...
+ *   </>
+ * </ConfirmProvider>)
+ */
+declare function ConfirmProvider({ children }: {
     children: React.ReactNode;
 }): JSX.Element;
 /**
@@ -14,12 +26,31 @@ export declare function ConfirmProvider({ children }: {
  * @param ok tekst voor op de OK-button (default = 'Ok')
  * @param cancel tekst voor opd e cancel-button (default = 'Annuleren')
  * @param others eventuele andere buttons (default = undefined)
- * @returns
+ * @returns onConfirm-fn, onCancel-fn, confirm-fn, confirmState
+ * @example
+ * const {  confirm } = useConfirm("Ja", "Nee", <Button>Extra</Button>);
+ * const confirmSomethingFromString = (msg: string) => {
+ *   const isConfirmed = await (confirm(msg))
+ * }
+ * @example
+ * const {  confirm } = useConfirm("Ja", "Nee", <Button>Extra</Button>);
+ * const confirmSomethingFromFragment = (fragment: React.ReactNode) => {
+ *   const isConfirmed = await (confirm(fragment))
+ * }
  */
-export declare function useConfirm(ok?: string, cancel?: string, others?: React.ReactNode): {
-    confirm: (content: string) => Promise<boolean>;
+declare function useConfirm(ok?: string, cancel?: string, others?: React.ReactNode): {
+    /** INTERNAL USE ONLY - DO NOT USE */
     onConfirm: () => void;
+    /** INTERNAL USE ONLY - DO NOT USE */
     onCancel: () => void;
+    /**
+     * awaitable confirm function. Geef een string of Fragment op om iets in de confirm-modal te tonen
+     * @param content string of Fragment met de boodschap voor de confirm
+     * @returns Promise<boolean> met true als de gebruiker op OK heeft geklikt, false als anders
+     * @example const isConfirmed = await confirm("Weet je het zeker?")
+     */
+    confirm: (content: string | React.ReactNode) => Promise<boolean>;
+    /** INTERNAL USE ONLY - DO NOT USE */
     confirmState: State;
 };
-export {};
+export { ConfirmProvider, useConfirm };