@obosbbl/grunnmuren-react 3.3.4 → 3.4.0

package/dist/index.d.mts

@@ -2,10 +2,11 @@ import { DisclosureProps as DisclosureProps$1, ButtonProps as ButtonProps$1, Lin
 export { ListBoxItemProps as ComboboxItemProps, DisclosureGroup, DisclosureGroupProps, Form, Group, LabelProps, ListBoxItemProps as SelectItemProps } from 'react-aria-components';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import { RefAttributes, HTMLAttributes, HTMLProps, ComponentProps, Ref, JSX, ReactNode, RefObject, Dispatch, SetStateAction } from 'react';
+import { RefAttributes, HTMLAttributes, HTMLProps, ComponentProps, Ref, ReactNode, RefObject, Dispatch, SetStateAction, JSX } from 'react';
 import * as cva from 'cva';
 import { VariantProps } from 'cva';
 import { DisclosureState } from 'react-stately';
+import { EmblaViewportRefType } from 'embla-carousel-react';
 import { DateFormatterOptions } from 'react-aria';
 import { FormValidationProps } from '@react-stately/form';
 
@@ -95,19 +96,12 @@ declare const Alertbox: ({ children, role, className, icon, variant, isDismissab
 type AvatarProps = ComponentProps<'img'>;
 declare const Avatar: ({ src, alt, className, onError, loading, ...rest }: AvatarProps) => react_jsx_runtime.JSX.Element;
 
-type LinkProps = LinkProps$1 & React.RefAttributes<HTMLAnchorElement> & {
-    /** @private Used internally for slotted components */
-    _innerWrapper?: (props: LinkProps$1) => LinkProps['children'];
-};
-declare const _LinkContext: react.Context<ContextValue<Partial<LinkProps>, HTMLAnchorElement>>;
-declare const Link: ({ ref: _ref, ..._props }: LinkProps) => react_jsx_runtime.JSX.Element;
-
 type ButtonOrLinkProps$1 = {
     children?: React.ReactNode;
     /** Additional CSS className for the element. */
     className?: string;
     /** Determines whether to use an anchor or a button for the Backlink */
-    href?: LinkProps['href'];
+    href?: LinkProps$1['href'];
     /** To add a permanent underline on the link (not only on hover)
      * @default false
      */
@@ -115,7 +109,7 @@ type ButtonOrLinkProps$1 = {
     /** Ref to the element. */
     ref?: Ref<HTMLAnchorElement | HTMLButtonElement>;
 };
-type BacklinkProps = (ButtonProps$1 | LinkProps) & ButtonOrLinkProps$1;
+type BacklinkProps = (ButtonProps$1 | LinkProps$1) & ButtonOrLinkProps$1;
 declare function Backlink(props: BacklinkProps): react_jsx_runtime.JSX.Element;
 
 type BadgeProps = VariantProps<typeof badgeVariants> & {
@@ -137,6 +131,34 @@ declare const badgeVariants: (props?: ({
 })) | undefined) => string;
 declare function Badge(props: BadgeProps): react_jsx_runtime.JSX.Element;
 
+declare const _LinkContext: react.Context<ContextValue<Partial<LinkProps>, HTMLAnchorElement>>;
+declare const linkVariants: (props?: (((VariantProps<(props?: ({
+    animateIcon?: "right" | "left" | "down" | "up" | "up-right" | undefined;
+} & ({
+    class?: cva.ClassValue;
+    className?: never;
+} | {
+    class?: never;
+    className?: cva.ClassValue;
+})) | undefined) => string> & VariantProps<(props?: ({
+    class?: cva.ClassValue;
+    className?: never;
+} | {
+    class?: never;
+    className?: cva.ClassValue;
+}) | undefined) => string>) | undefined) & ({
+    class?: cva.ClassValue;
+    className?: never;
+} | {
+    class?: never;
+    className?: cva.ClassValue;
+})) | undefined) => string;
+type LinkProps = VariantProps<typeof linkVariants> & LinkProps$1 & React.RefAttributes<HTMLAnchorElement> & {
+    /** @private Used internally for slotted components */
+    _innerWrapper?: (props: LinkProps$1) => LinkProps['children'];
+};
+declare const Link: ({ ref: _ref, animateIcon, ..._props }: LinkProps) => react_jsx_runtime.JSX.Element;
+
 type BreadcrumbProps = {
     /** Additional CSS className for the element. */
     className?: string;
@@ -163,7 +185,15 @@ declare function Breadcrumbs(props: BreadcrumbsProps): react_jsx_runtime.JSX.Ele
 /**
  * Figma: https://www.figma.com/file/9OvSg0ZXI5E1eQYi7AWiWn/Grunnmuren-2.0-%E2%94%82-Designsystem?node-id=30%3A2574&mode=dev
  */
-declare const buttonVariants: (props?: ({
+declare const buttonVariants: (props?: (((VariantProps<(props?: ({
+    animateIcon?: "right" | "left" | "down" | "up" | "up-right" | undefined;
+} & ({
+    class?: cva.ClassValue;
+    className?: never;
+} | {
+    class?: never;
+    className?: cva.ClassValue;
+})) | undefined) => string> & VariantProps<(props?: ({
     variant?: "primary" | "secondary" | "tertiary" | undefined;
     color?: "blue" | "mint" | "white" | undefined;
     isIconOnly?: boolean | undefined;
@@ -174,6 +204,12 @@ declare const buttonVariants: (props?: ({
 } | {
     class?: never;
     className?: cva.ClassValue;
+})) | undefined) => string>) | undefined) & ({
+    class?: cva.ClassValue;
+    className?: never;
+} | {
+    class?: never;
+    className?: cva.ClassValue;
 })) | undefined) => string;
 type ButtonOrLinkProps = VariantProps<typeof buttonVariants> & {
     children?: React.ReactNode;
@@ -214,35 +250,79 @@ type CardLinkProps = (Omit<LinkProps$1, 'href'> & Required<Pick<LinkProps$1, 'hr
  */
 declare const CardLink: ({ className: _className, href, ...restProps }: CardLinkProps) => react_jsx_runtime.JSX.Element;
 
-type CarouselProps = Omit<HTMLProps<HTMLDivElement>, 'onChange'> & {
-    /** The <CarouselItem/> components to be displayed within the carousel. */
-    children: React.ReactNode;
+type CarouselProps = Omit<HTMLProps<HTMLDivElement>, 'onChange' | 'onSelect'> & {
+    children?: React.ReactNode;
+    /**
+     * Alignment of the items relative to the carousel viewport.
+     * @default 'center'
+     */
+    align?: 'start' | 'center' | 'end';
+    /** Delay in milliseconds between each automatic transition of the carousel. Any interaction with the carousel will immediately stop the autoplay. */
+    autoPlayDelay?: number;
+    /**
+     * The initial snapped index of the carousel.
+     * @default 0
+     */
+    initialIndex?: number;
+    /**
+     * Whether the carousel infinitely loops.
+     * @default false
+     */
+    loop?: boolean;
+    /**
+     * Orientation of the carousel.
+     * @default 'horizontal'
+     */
+    orientation?: 'horizontal' | 'vertical';
+    /**
+     * Callback invoked when the snapped index changes.
+     */
+    onSelect?: (index: number) => void;
     /**
-     * Callback that is triggered when a user navigates to new item in the Carousel.
-     * The argument to the callback is an object containing `index` of the new item scrolled into view and the `id` of that item (if set on the `<CarouselItem>`)
-     * It also provides `prevIndex` which is the index of the previous item that was in view
-     * And `prevId`, which is the id of the previous item that was in view (if set on the `<CarouselItem>`)
-     * @param item { index: number; id?: string; prevIndex: number; prevId?: string }
+     * Callback invoked after the carousel scrolling "settles". Think of this as the debounced version of `onSelect`.
      */
-    onChange?: (item: CarouselItem) => void;
+    onSettled?: (index: number) => void;
+    /**
+     * Whether the carousel should scroll with regular mouse/trackpad scroll gestures, in addition to swipe gestures.
+     * @default false
+     */
+    scrollGestures?: boolean;
 };
-declare const Carousel: ({ className, children, onChange, ...rest }: CarouselProps) => react_jsx_runtime.JSX.Element;
+declare const Carousel: ({ autoPlayDelay, align, children, initialIndex, orientation, onSelect, onSettled, loop, scrollGestures, ref, ...rest }: CarouselProps) => react_jsx_runtime.JSX.Element;
+type CarouselContextValue = {
+    slidesInView: number[];
+    orientation: 'horizontal' | 'vertical';
+    /**
+     * @private
+     */
+    '~emblaRef': EmblaViewportRefType | null;
+};
+declare const CarouselContext: react.Context<CarouselContextValue>;
+type CarouselItemsContainer = HTMLProps<HTMLDivElement> & {
+    children: React.ReactNode;
+};
+declare const CarouselItemsContainer: ({ children, className, ...rest }: CarouselItemsContainer) => react_jsx_runtime.JSX.Element;
 type CarouselItemsProps = HTMLProps<HTMLDivElement> & {
     /** The <CarouselItem/> components to be displayed within the carousel. */
     children: React.ReactNode;
 };
 declare const CarouselItems: ({ className, children }: CarouselItemsProps) => react_jsx_runtime.JSX.Element;
+type CarouselControlsProps = HTMLProps<HTMLDivElement> & {
+    /** The <CarouselItem/> components to be displayed within the carousel. */
+    children: React.ReactNode;
+};
+/**
+ * This is internal for now, but we will expose it in the future when we support more flexible positioning of prev/next and other actions.
+ * It is used to render the prev/next buttons in the carousel for now.
+ */
+declare const CarouselControls: ({ children, className, ...rest }: CarouselControlsProps) => react_jsx_runtime.JSX.Element;
+type CarouselButtonProps = ButtonProps & {
+    slot: 'next' | 'prev';
+};
+declare const CarouselButton: ({ className, isIconOnly, slot, ...rest }: CarouselButtonProps) => react_jsx_runtime.JSX.Element;
 type CarouselItemProps = HTMLProps<HTMLDivElement> & {
     /** The component/components to display as the <CarouselItem/>. */
-    children: JSX.Element | JSX.Element[];
-};
-type CarouselItem = Pick<CarouselItemProps, 'id'> & {
-    /** The index of the item that is currently in view */
-    index: number;
-    /** The index of the previous item that was in view */
-    prevIndex: number;
-    /** The id of the previous item that was in view */
-    prevId?: CarouselItemProps['id'];
+    children: React.ReactNode;
 };
 declare const CarouselItem: ({ className, children, ...rest }: CarouselItemProps) => react_jsx_runtime.JSX.Element;
 
@@ -422,6 +502,10 @@ declare function GrunnmurenProvider({ children, locale, navigate, useHref, }: Gr
 type HeroProps = HTMLProps<HTMLDivElement> & VariantProps<typeof variants> & {
     children: React.ReactNode;
 };
+type HeroContextValue = {
+    variant: HeroProps['variant'];
+};
+declare const HeroContext: react.Context<HeroContextValue | null>;
 declare const variants: (props?: ({
     variant?: "standard" | "full-bleed" | "two-column" | undefined;
 } & ({
@@ -758,5 +842,5 @@ type VideoLoopProps = {
 };
 declare const VideoLoop: ({ src, format, alt, className }: VideoLoopProps) => react_jsx_runtime.JSX.Element;
 
-export { Accordion, AccordionItem, Alertbox, Avatar, Backlink, Badge, Breadcrumb, Breadcrumbs, Button, ButtonContext, Caption, Card, CardLink, Checkbox, CheckboxGroup, Combobox, ListBoxHeader as ComboboxHeader, ListBoxItem as ComboboxItem, ListBoxSection as ComboboxSection, Content, ContentContext, DateFormatter, Description, Disclosure, DisclosureButton, DisclosurePanel, DisclosureStateContext, ErrorMessage, Footer, GrunnmurenProvider, Heading, HeadingContext, Label, LinkList, LinkListContainer, LinkListItem, Media, MediaContext, NumberField, Radio, RadioGroup, Select, ListBoxHeader as SelectHeader, ListBoxItem as SelectItem, ListBoxSection as SelectSection, Tag, TagGroup, TagList, TextArea, TextField, Carousel as UNSAFE_Carousel, CarouselItem as UNSAFE_CarouselItem, CarouselItems as UNSAFE_CarouselItems, Dialog as UNSAFE_Dialog, DialogTrigger as UNSAFE_DialogTrigger, FileUpload as UNSAFE_FileUpload, Hero as UNSAFE_Hero, Link as UNSAFE_Link, Modal as UNSAFE_Modal, ProgressBar as UNSAFE_ProgressBar, ProgressBarValueText as UNSAFE_ProgressBarValueText, Tab as UNSAFE_Tab, TabList as UNSAFE_TabList, TabPanel as UNSAFE_TabPanel, Table as UNSAFE_Table, TableBody as UNSAFE_TableBody, TableCell as UNSAFE_TableCell, TableColumn as UNSAFE_TableColumn, TableColumnResizer as UNSAFE_TableColumnResizer, TableContainer as UNSAFE_TableContainer, TableHeader as UNSAFE_TableHeader, TableRow as UNSAFE_TableRow, Tabs as UNSAFE_Tabs, VideoLoop, _LinkContext, _useLocale as useLocale };
-export type { AccordionItemProps, AccordionProps, Props as AlertboxProps, AvatarProps, BacklinkProps, BadgeProps, BreadcrumbProps, BreadcrumbsProps, ButtonProps, CaptionProps, CardLinkProps, CardProps, CheckboxGroupProps, CheckboxProps, ComboboxProps, ContentProps, DateFormatterProps, DescriptionProps, DisclosureButtonProps, DisclosurePanelProps, DisclosureProps, ErrorMessageProps, FooterProps, GrunnmurenProviderProps, HeadingProps, LinkListContainerProps, LinkListItemProps, LinkListProps, Locale, MediaProps, NumberFieldProps, RadioGroupProps, RadioProps, SelectProps, TagGroupProps, TagListProps, TagProps, TextAreaProps, TextFieldProps, CarouselItemProps as UNSAFE_CarouselItemProps, CarouselItemsProps as UNSAFE_CarouselItemsProps, CarouselProps as UNSAFE_CarouselProps, DialogProps as UNSAFE_DialogProps, DialogTriggerProps as UNSAFE_DialogTriggerProps, FileUploadProps as UNSAFE_FileUploadProps, HeroProps as UNSAFE_HeroProps, LinkProps as UNSAFE_LinkProps, ModalProps as UNSAFE_ModalProps, ProgressBarProps as UNSAFE_ProgressBarProps, ProgressBarValueTextProps as UNSAFE_ProgressBarValueTextProps, TabListProps as UNSAFE_TabListProps, TabPanelProps as UNSAFE_TabPanelProps, TabProps as UNSAFE_TabProps, TableBodyProps as UNSAFE_TableBodyProps, TableCellProps as UNSAFE_TableCellProps, TableColumnProps as UNSAFE_TableColumnProps, TableColumnResizerProps as UNSAFE_TableColumnResizerProps, TableContainerProps as UNSAFE_TableContainerProps, TableHeaderProps as UNSAFE_TableHeaderProps, TableProps as UNSAFE_TableProps, TableRowProps as UNSAFE_TableRowProps, TabsProps as UNSAFE_TabsProps };
+export { Accordion, AccordionItem, Alertbox, Avatar, Backlink, Badge, Breadcrumb, Breadcrumbs, Button, ButtonContext, Caption, Card, CardLink, Checkbox, CheckboxGroup, Combobox, ListBoxHeader as ComboboxHeader, ListBoxItem as ComboboxItem, ListBoxSection as ComboboxSection, Content, ContentContext, DateFormatter, Description, Disclosure, DisclosureButton, DisclosurePanel, DisclosureStateContext, ErrorMessage, Footer, GrunnmurenProvider, Heading, HeadingContext, Label, LinkList, LinkListContainer, LinkListItem, Media, MediaContext, NumberField, Radio, RadioGroup, Select, ListBoxHeader as SelectHeader, ListBoxItem as SelectItem, ListBoxSection as SelectSection, Tag, TagGroup, TagList, TextArea, TextField, Carousel as UNSAFE_Carousel, CarouselButton as UNSAFE_CarouselButton, CarouselContext as UNSAFE_CarouselContext, CarouselControls as UNSAFE_CarouselControls, CarouselItem as UNSAFE_CarouselItem, CarouselItems as UNSAFE_CarouselItems, CarouselItemsContainer as UNSAFE_CarouselItemsContainer, CarouselItemsContainer as UNSAFE_CarouselItemsContainerProps, Dialog as UNSAFE_Dialog, DialogTrigger as UNSAFE_DialogTrigger, FileUpload as UNSAFE_FileUpload, Hero as UNSAFE_Hero, HeroContext as UNSAFE_HeroContext, Link as UNSAFE_Link, Modal as UNSAFE_Modal, ProgressBar as UNSAFE_ProgressBar, ProgressBarValueText as UNSAFE_ProgressBarValueText, Tab as UNSAFE_Tab, TabList as UNSAFE_TabList, TabPanel as UNSAFE_TabPanel, Table as UNSAFE_Table, TableBody as UNSAFE_TableBody, TableCell as UNSAFE_TableCell, TableColumn as UNSAFE_TableColumn, TableColumnResizer as UNSAFE_TableColumnResizer, TableContainer as UNSAFE_TableContainer, TableHeader as UNSAFE_TableHeader, TableRow as UNSAFE_TableRow, Tabs as UNSAFE_Tabs, VideoLoop, _LinkContext, _useLocale as useLocale };
+export type { AccordionItemProps, AccordionProps, Props as AlertboxProps, AvatarProps, BacklinkProps, BadgeProps, BreadcrumbProps, BreadcrumbsProps, ButtonProps, CaptionProps, CardLinkProps, CardProps, CheckboxGroupProps, CheckboxProps, ComboboxProps, ContentProps, DateFormatterProps, DescriptionProps, DisclosureButtonProps, DisclosurePanelProps, DisclosureProps, ErrorMessageProps, FooterProps, GrunnmurenProviderProps, HeadingProps, LinkListContainerProps, LinkListItemProps, LinkListProps, Locale, MediaProps, NumberFieldProps, RadioGroupProps, RadioProps, SelectProps, TagGroupProps, TagListProps, TagProps, TextAreaProps, TextFieldProps, CarouselButtonProps as UNSAFE_CarouselButtonProps, CarouselContextValue as UNSAFE_CarouselContextValue, CarouselControlsProps as UNSAFE_CarouselControlsProps, CarouselItemProps as UNSAFE_CarouselItemProps, CarouselItemsProps as UNSAFE_CarouselItemsProps, CarouselProps as UNSAFE_CarouselProps, DialogProps as UNSAFE_DialogProps, DialogTriggerProps as UNSAFE_DialogTriggerProps, FileUploadProps as UNSAFE_FileUploadProps, HeroContextValue as UNSAFE_HeroContextValue, HeroProps as UNSAFE_HeroProps, LinkProps as UNSAFE_LinkProps, ModalProps as UNSAFE_ModalProps, ProgressBarProps as UNSAFE_ProgressBarProps, ProgressBarValueTextProps as UNSAFE_ProgressBarValueTextProps, TabListProps as UNSAFE_TabListProps, TabPanelProps as UNSAFE_TabPanelProps, TabProps as UNSAFE_TabProps, TableBodyProps as UNSAFE_TableBodyProps, TableCellProps as UNSAFE_TableCellProps, TableColumnProps as UNSAFE_TableColumnProps, TableColumnResizerProps as UNSAFE_TableColumnResizerProps, TableContainerProps as UNSAFE_TableContainerProps, TableHeaderProps as UNSAFE_TableHeaderProps, TableProps as UNSAFE_TableProps, TableRowProps as UNSAFE_TableRowProps, TabsProps as UNSAFE_TabsProps };