@frigade/react 2.5.17 → 2.5.19

package/dist/index.d.ts

@@ -1388,6 +1388,15 @@ interface FlowPropsWithoutChildren extends BoxPropsWithoutChildren {
      * 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 {
     /**
@@ -1666,6 +1675,7 @@ interface HintProps extends BoxProps {
     align?: AlignValue;
     alignOffset?: number;
     anchor: string;
+    autoScroll?: ScrollIntoViewOptions | boolean;
     children?: React.ReactNode;
     defaultOpen?: boolean;
     modal?: boolean;
@@ -1675,7 +1685,7 @@ interface HintProps extends BoxProps {
     sideOffset?: number;
     spotlight?: boolean;
 }
-declare function Hint({ align, alignOffset, anchor, children, 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, modal, 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;
 
@@ -1872,13 +1882,14 @@ declare namespace Tooltip {
     var Title: ({ children, ...props }: TextProps) => _emotion_react_jsx_runtime.JSX.Element;
 }
 
+declare function useClientPortal(children: React.ReactNode, container: Element | DocumentFragment | string, key?: null | string): React$1.ReactPortal;
+
+interface ClientPortalProps {
+    children?: React.ReactNode;
+    container?: Parameters<typeof useClientPortal>[1];
+}
+
 interface TourProps extends FlowPropsWithoutChildren, Omit<HintProps, 'anchor'> {
-    /**
-     * Whether the tour should be completed by the end-user in sequential order.
-     * If `false`, all steps will be rendered at once.
-     * Defaults to `true`, which means only one step will be rendered at a time in sequential order.
-     */
-    sequential?: boolean;
     /**
      * The alignment of the tooltip relative to the anchor.
      * Possible values: `after`, `before`, `center`, `end`, `start`.
@@ -1888,6 +1899,14 @@ interface TourProps extends FlowPropsWithoutChildren, Omit<HintProps, 'anchor'>
      * The offset of the tooltip relative to the anchor along the alignment axis.
      */
     alignOffset?: number;
+    /**
+     * Automatically scroll to the anchor element of the current Step
+     */
+    autoScroll?: boolean;
+    /**
+     * Specify a container in the DOM render the Tour into
+     */
+    container?: ClientPortalProps['container'];
     /**
      * Whether the tooltip should be open by default.
      */
@@ -1904,6 +1923,12 @@ interface TourProps extends FlowPropsWithoutChildren, Omit<HintProps, 'anchor'>
      * Controls the open state of the tooltip. Use this for controlled components.
      */
     open?: boolean;
+    /**
+     * Whether the Tour should be completed by the end-user in sequential order.
+     * If `false`, all steps will be rendered at once.
+     * Defaults to `true`, which means only one step will be rendered at a time in sequential order.
+     */
+    sequential?: boolean;
     /**
      * The preferred side of the anchor to render the tooltip.
      * Possible values: `top`, `right`, `bottom`, `left`.
@@ -1918,7 +1943,7 @@ interface TourProps extends FlowPropsWithoutChildren, Omit<HintProps, 'anchor'>
      */
     spotlight?: boolean;
 }
-declare function Tour({ align, alignOffset, as, defaultOpen, dismissible, flowId, modal, part, sequential, side, sideOffset, spotlight, zIndex, ...props }: TourProps): React$1.ReactPortal;
+declare function Tour({ as, flowId, ...props }: TourProps): _emotion_react_jsx_runtime.JSX.Element;
 
 declare function useBoundingClientRect(): {
     node: any;