@bigbinary/neeto-molecules 3.2.18 → 3.2.19

package/types/PublishBlock.d.ts

@@ -1,14 +1,28 @@
 import React from "react";
 import { AlertProps, ButtonProps } from "@bigbinary/neetoui";
+interface PublishPaneProps {
+  isSubmitting: boolean;
+  onPublish: (params: {
+    isPublishLaterChecked: boolean;
+    datetimeValue: Date | null;
+    onClose: () => void;
+  }) => void;
+  onCancel: (params: {
+    onClose: () => void;
+  }) => void;
+  datetime: Date | null;
+}
+interface PublishButtonProps extends ButtonProps {
+  showTooltipWhenDisabled?: boolean;
+  publishPaneProps?: PublishPaneProps;
+}
 interface PublishBlockProps {
   renderDraftButtons: (props: {
     ViewDraftButton: React.FC<ButtonProps>;
     ResetDraftButton: React.FC<ButtonProps>;
   }) => React.ReactNode;
   renderPublishButtons: (props: {
-    PublishButton: React.FC<ButtonProps & {
-      showTooltipWhenDisabled?: boolean;
-    }>;
+    PublishButton: React.FC<PublishButtonProps>;
     PublishPreviewButton: React.FC<ButtonProps>;
   }) => React.ReactNode;
 }
@@ -52,6 +66,51 @@ interface PublishBlockProps {
  *   );
  * };
  * @endexample
+ * To use scheduling of publication:
+ *
+ * @example 
+ *
+ * import PublishBlock from "@bigbinary/neeto-molecules/PublishBlock";
+ * 
+ * const PublishActionBlock = (
+ *   {
+ *     //all variables used in the below example can be passed as props or can be defined in the component itself
+ *   }
+ * ) => {
+ *   const renderDraftButtons = ({ ViewDraftButton, ResetDraftButton }) =>
+ *     !isDraftBlockHidden && (
+ *       <>
+ *         <ViewDraftButton to={previewDraftUrl} />
+ *         {hasDraftVersion && <ResetDraftButton onClick={handleResetDraft} />}
+ *       </>
+ *     );
+ * 
+ *   const renderPublishButtons = ({ PublishButton, PublishPreviewButton }) => (
+ *     <>
+ *       <PublishButton
+ *         disabled={isPublishDisabled}
+ *         onClick={handlePublish}
+ *         publishPaneProps={{
+ *           isSubmitting: false,
+ *           onPublish: ({ onClose }) => onClose(),
+ *           onCancel: ({ onClose }) => onClose(),
+ *           datetime: null,
+ *         }}
+ *       />
+ *       <PublishPreviewButton
+ *         disabled={isPublishPreviewDisabled}
+ *         to={previewPublishedUrl}
+ *       />
+ *     </>
+ *   );
+ *   return (
+ *     <PublishBlock
+ *       renderDraftButtons={renderDraftButtons}
+ *       renderPublishButtons={renderPublishButtons}
+ *     />
+ *   );
+ * };
+ * @endexample
  * This optional component can be used to render the reset alert modal for
  *
  * discarding draft.