@frigade/react 1.37.21 → 1.38.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -104,7 +104,6 @@ interface StepData {
104
104
  */
105
105
  handleSecondaryButtonClick?: () => void;
106
106
  ctaActionType?: 'complete';
107
- imageStyle?: CSSProperties;
108
107
  props?: any;
109
108
  /**
110
109
  * Criteria that needs to be met for the step to complete
@@ -243,7 +242,7 @@ declare function useFlows(): {
243
242
  markFlowNotStarted: (flowId: string, data?: any) => Promise<void>;
244
243
  markFlowStarted: (flowId: string, data?: any) => Promise<void>;
245
244
  markFlowCompleted: (flowId: string, data?: any) => Promise<void>;
246
- markFlowAborted: (flowId: string, data?: any) => Promise<void>;
245
+ markFlowSkipped: (flowId: string, data?: any) => Promise<void>;
247
246
  markStepNotStarted: (flowId: string, stepId: string, data?: any) => Promise<void>;
248
247
  getFlowStatus: (flowId: string) => "COMPLETED_FLOW" | "STARTED_FLOW" | "NOT_STARTED_FLOW";
249
248
  getNumberOfStepsCompleted: (flowId: string) => number;
@@ -634,10 +633,10 @@ interface FrigadeTourProps extends Omit<DefaultFrigadeFlowProps, 'flowId'> {
634
633
  */
635
634
  showStepCount?: boolean;
636
635
  /**
637
- * `complete-flow` (default): Completes the entire flow/tour when a single tooltip is dismissed.
638
- * `complete-step`: Completes the current step when a tooltip is dismissed.
636
+ * `skip-flow` (default): Completes the entire flow/tour when a single tooltip is dismissed.
637
+ * `complete-step`: Completes the current step when a tooltip is dismissed. The user can continue in the tour.
639
638
  */
640
- dismissBehavior?: 'complete-flow' | 'complete-step';
639
+ dismissBehavior?: 'skip-flow' | 'complete-step';
641
640
  /**
642
641
  * @ignore
643
642
  */
@@ -701,6 +700,10 @@ interface FrigadeAnnouncementProps extends DefaultFrigadeFlowProps {
701
700
  * Indicates the position of the modal if the form type is a modal. Default is center.
702
701
  */
703
702
  modalPosition?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center' | 'inline';
703
+ /**
704
+ * Show a pagination indicator at the bottom of the announcement when using more than 1 page. Default is true.
705
+ */
706
+ showPagination?: boolean;
704
707
  }
705
708
  declare const FrigadeAnnouncement: React__default.FC<FrigadeAnnouncementProps>;
706
709
 
@@ -744,6 +747,7 @@ declare function useUserFlowStates(): {
744
747
  isLoadingUserFlowStateData: boolean;
745
748
  mutateUserFlowState: () => any;
746
749
  optimisticallyMarkFlowCompleted: (flowId: string) => void;
750
+ optimisticallyMarkFlowSkipped: (flowId: string) => void;
747
751
  optimisticallyMarkFlowNotStarted: (flowId: string) => void;
748
752
  optimisticallyMarkStepCompleted: (flowId: string, stepId: string, flowResponse: FlowResponse) => void;
749
753
  optimisticallyMarkStepNotStarted: (flowId: string, stepId: string, flowResponse: FlowResponse) => void;