@frigade/react 2.7.0 → 2.7.2

package/dist/index.d.ts

@@ -1344,6 +1344,26 @@ declare function useStepHandlers(step: FlowStep, { onPrimary, onSecondary }?: St
 interface BoxPropsWithoutChildren extends Omit<BoxProps, 'children'> {
 }
 interface FlowPropsWithoutChildren extends BoxPropsWithoutChildren {
+    /**
+     * Whether to automatically mark the Flow started (i.e. in progress) when the Flow is eligible to be shown.
+     * You will need to call `flow.start()` or `step.start()` from the parent component if you set this to `false`. Most components should not need to override this behavior.
+     *
+     * Defaults to `true`.
+     */
+    autoStart?: boolean;
+    /**
+     * Optional component to wrap the child components in, e.g. `as={Dialog}` will render the Flow in a modal Dialog. Defaults to `Box`.
+     */
+    as?: React$1.ElementType;
+    /**
+     * Emotion CSS prop to apply to the component. See [Theming documentation](https://docs.frigade.com/v2/sdk/styling/css-overrides) for more information.
+     *
+     * Example usage:
+     * ```
+     * <Frigade.Checklist css={{ backgroundColor: "pink", ".fr-button-primary": { backgroundColor: "fuchsia" } }} />
+     * ```
+     */
+    css?: React$1.Attributes['css'];
     /**
      * Whether the Flow is dismissible or not
      *
@@ -1385,19 +1405,6 @@ interface FlowPropsWithoutChildren extends BoxPropsWithoutChildren {
      * For instance, you can use `title: Hello, ${name}!` in the Flow configuration and pass `variables={{name: 'John'}}` to customize the copy.
      */
     variables?: Record<string, unknown>;
-    /**
-     * Optional component to wrap the child components in, e.g. `as={Dialog}` will render the Flow in a modal Dialog. Defaults to `Box`.
-     */
-    as?: React$1.ElementType;
-    /**
-     * Emotion CSS prop to apply to the component. See [Theming documentation](https://docs.frigade.com/v2/sdk/styling/css-overrides) for more information.
-     *
-     * Example usage:
-     * ```
-     * <Frigade.Checklist css={{ backgroundColor: "pink", ".fr-button-primary": { backgroundColor: "fuchsia" } }} />
-     * ```
-     */
-    css?: React$1.Attributes['css'];
 }
 interface FlowProps extends FlowPropsWithoutChildren {
     /**
@@ -1445,7 +1452,7 @@ declare namespace Dialog {
     var displayName: string;
 }
 
-declare function Flow({ as, children, flowId, onComplete, onDismiss, onPrimary, onSecondary, variables, ...props }: FlowProps): _emotion_react_jsx_runtime.JSX.Element;
+declare function Flow({ as, autoStart, children, flowId, onComplete, onDismiss, onPrimary, onSecondary, variables, ...props }: FlowProps): _emotion_react_jsx_runtime.JSX.Element;
 
 interface AnnouncementProps extends FlowPropsWithoutChildren, DialogProps {
     /**
@@ -1679,14 +1686,16 @@ interface HintProps extends BoxProps {
     autoScroll?: ScrollIntoViewOptions | boolean;
     children?: React.ReactNode;
     defaultOpen?: boolean;
+    lockScroll?: boolean;
     modal?: boolean;
+    onMount?: () => void;
     onOpenChange?: (open: boolean) => void;
     open?: boolean;
     side?: SideValue;
     sideOffset?: number;
     spotlight?: boolean;
 }
-declare function Hint({ align, alignOffset, anchor, autoScroll, children, css, defaultOpen, modal, onOpenChange, open, part, side, sideOffset, spotlight, style, ...props }: HintProps): _emotion_react_jsx_runtime.JSX.Element;
+declare function Hint({ align, alignOffset, anchor, autoScroll, children, css, defaultOpen, lockScroll, modal, onMount, onOpenChange, open, part, side, sideOffset, spotlight, style, ...props }: HintProps): _emotion_react_jsx_runtime.JSX.Element;
 
 declare function SelectField(props: FormFieldProps): _emotion_react_jsx_runtime.JSX.Element;
 
@@ -1712,6 +1721,29 @@ interface BaseFieldProps extends FormFieldProps {
 }
 declare function BaseField({ children, field, fieldData, fieldState }: BaseFieldProps): _emotion_react_jsx_runtime.JSX.Element;
 
+type NPSOptions = {
+    label: string;
+    value: string;
+}[];
+interface NPSProps extends FormProps {
+    /**
+     * The options to display in the NPS field.
+     * If not provided, the default NPS numbers from 0 to 10 will be used.
+     */
+    options?: NPSOptions;
+    /**
+     * The label to display for the positive end of the NPS scale.
+     * If not provided, the default label "Extremely likely" will be used.
+     */
+    positiveLabel?: string;
+    /**
+     * The label to display for the negative end of the NPS scale.
+     * If not provided, the default label "Not likely at all" will be used.
+     */
+    negativeLabel?: string;
+}
+declare function NPS({ as, flowId, fieldTypes, part, options, positiveLabel, negativeLabel, ...props }: NPSProps): _emotion_react_jsx_runtime.JSX.Element;
+
 interface ProgressProps extends BoxProps {
     current: number;
     total: number;
@@ -1834,40 +1866,21 @@ interface ProviderProps {
 declare function Provider({ children, css, defaultCollection, navigate, theme, ...props }: ProviderProps): _emotion_react_jsx_runtime.JSX.Element;
 
 interface OverlayProps extends BoxProps {
+    lockScroll?: boolean;
 }
 
 interface SpotlightProps extends OverlayProps {
     anchor: string;
+    lockScroll?: boolean;
 }
-declare function Spotlight({ anchor, part, style, ...props }: SpotlightProps): _emotion_react_jsx_runtime.JSX.Element;
-
-type NPSOptions = {
-    label: string;
-    value: string;
-}[];
-interface NPSProps extends FormProps {
-    /**
-     * The options to display in the NPS field.
-     * If not provided, the default NPS numbers from 0 to 10 will be used.
-     */
-    options?: NPSOptions;
-    /**
-     * The label to display for the positive end of the NPS scale.
-     * If not provided, the default label "Extremely likely" will be used.
-     */
-    positiveLabel?: string;
-    /**
-     * The label to display for the negative end of the NPS scale.
-     * If not provided, the default label "Not likely at all" will be used.
-     */
-    negativeLabel?: string;
-}
-declare function NPS({ as, flowId, fieldTypes, part, options, positiveLabel, negativeLabel, ...props }: NPSProps): _emotion_react_jsx_runtime.JSX.Element;
+declare function Spotlight({ anchor, lockScroll, part, style, ...props }: SpotlightProps): _emotion_react_jsx_runtime.JSX.Element;
 
 declare const index_NPS: typeof NPS;
+type index_NPSProps = NPSProps;
 declare namespace index {
   export {
     index_NPS as NPS,
+    index_NPSProps as NPSProps,
   };
 }
 
@@ -1934,6 +1947,11 @@ interface TourProps extends FlowPropsWithoutChildren, Omit<HintProps, 'anchor'>
      * Whether the tooltip should be open by default.
      */
     defaultOpen?: boolean;
+    /**
+     * Whether to lock the scroll of the container when the Spotlight is enabled.
+     * Defaults to `true`.
+     */
+    lockScroll?: boolean;
     /**
      * Whether to render a modal overlay behind the tooltip.
      */
@@ -2002,4 +2020,4 @@ declare function useGroup(): {
     isLoading: boolean;
 };
 
-export { Announcement, AnnouncementProps, Banner, BannerProps, BaseField, Box, BoxProps, Button, ButtonProps, Card, CardHeaderProps, CardProps, index$2 as Checklist, CollapsibleProps, CollapsibleStepProps, Collection, Dialog, DialogProps, DismissHandler, FieldTypes, Flex, Flow, FlowChildrenProps, FlowConfig, FlowHandlerProp, FlowHandlerProps, FlowProps, FlowPropsWithoutChildren, Form, FormFieldData, FormFieldProps, FormProps, Hint, Image, Label, Media, index$1 as Progress, ProgressBadge, ProgressBadgeProps, Provider, ProviderProps, RadioField, SelectField, Spotlight, StepHandler, StepHandlerProp, StepHandlerProps, index as Survey, Text, TextField, TextProps, TextareaField, Theme, Tokens, Tooltip, TooltipProps, Tour, TourProps, Video, themeVariables, tokens, useBoundingClientRect, useFlow, useFlowHandlers, useFrigade, useGroup, useStepHandlers, useUser };
+export { Announcement, AnnouncementProps, Banner, BannerProps, BaseField, Box, BoxProps, Button, ButtonProps, Card, CardHeaderProps, CardProps, index$2 as Checklist, CollapsibleProps, CollapsibleStepProps, Collection, Dialog, DialogProps, DismissHandler, FieldTypes, Flex, Flow, FlowChildrenProps, FlowConfig, FlowHandlerProp, FlowHandlerProps, FlowProps, FlowPropsWithoutChildren, Form, FormFieldData, FormFieldProps, FormProps, Hint, Image, Label, Media, NPSProps, index$1 as Progress, ProgressBadge, ProgressBadgeProps, Provider, ProviderProps, RadioField, SelectField, Spotlight, StepHandler, StepHandlerProp, StepHandlerProps, index as Survey, Text, TextField, TextProps, TextareaField, Theme, Tokens, Tooltip, TooltipProps, Tour, TourProps, Video, themeVariables, tokens, useBoundingClientRect, useFlow, useFlowHandlers, useFrigade, useGroup, useStepHandlers, useUser };