@digdir/designsystemet-react 1.0.0-rc.9 → 1.0.0

package/dist/cjs/components/Popover/Popover.js

@@ -2,67 +2,134 @@
 'use strict';
 
 var jsxRuntime = require('react/jsx-runtime');
-var React = require('react');
+var dom = require('@floating-ui/dom');
+var react$1 = require('@floating-ui/react');
+var reactSlot = require('@radix-ui/react-slot');
+var cl = require('clsx/lite');
+var react = require('react');
+var PopoverTriggerContext = require('./PopoverTriggerContext.js');
 
-function _interopNamespaceDefault(e) {
-    var n = Object.create(null);
-    if (e) {
-        Object.keys(e).forEach(function (k) {
-            if (k !== 'default') {
-                var d = Object.getOwnPropertyDescriptor(e, k);
-                Object.defineProperty(n, k, d.get ? d : {
-                    enumerable: true,
-                    get: function () { return e[k]; }
-                });
+/**
+ * Popover component, used to display content in a popover over an element.
+ *
+ * @example with TriggerContext
+ * <Popover.TriggerContext>
+ *   <Popover.Trigger>Open Popover</Popover.Trigger>
+ *   <Popover>
+ *     Content
+ *   </Popover>
+ * </Popover.TriggerContext>
+ *
+ * @example without TriggerContext
+ * <Button popovertarget="my-popover">Open Popover</Button>
+ * <Popover id="my-popover">
+ *   Content
+ * </Popover>
+ */
+const Popover = react.forwardRef(function Popover({ id, className, onClose, onOpen, open, variant = 'default', placement = 'top', autoPlacement = true, asChild = false, ...rest }, ref) {
+    const Component = asChild ? reactSlot.Slot : 'div';
+    const popoverRef = react.useRef(null);
+    const mergedRefs = react$1.useMergeRefs([popoverRef, ref]);
+    const { popoverId, setPopoverId } = react.useContext(PopoverTriggerContext.Context);
+    const [internalOpen, setInternalOpen] = react.useState(false);
+    const controlledOpen = open ?? internalOpen;
+    // NOTE: This code is purely to add React controlled component ability to Popover API
+    react.useEffect(() => {
+        const popover = popoverRef.current;
+        const handleClick = (event) => {
+            const el = event.target;
+            const isTrigger = el?.closest?.(`[popovertarget="${popover?.id}"]`);
+            const isOutside = !isTrigger && !popover?.contains(el);
+            if (isTrigger) {
+                event.preventDefault(); // Prevent native Popover API
+                setInternalOpen((open) => !open);
+                onOpen?.();
             }
-        });
-    }
-    n.default = e;
-    return Object.freeze(n);
-}
-
-var React__namespace = /*#__PURE__*/_interopNamespaceDefault(React);
-
-const Popover = ({ children, placement = 'top', open, variant = 'default', portal, size = 'md', onOpenChange, onClose, }) => {
-    const triggerRef = React.useRef(null);
-    const [internalOpen, setInternalOpen] = React.useState(open ?? false);
-    const randomPopoverId = React.useId();
-    const [popoverId, setPopoverId] = React.useState(randomPopoverId);
-    const randomTriggerId = React.useId();
-    const [triggerId, setTriggerId] = React.useState(randomTriggerId);
-    const isControlled = typeof open === 'boolean';
-    React__namespace.useEffect(() => {
-        setInternalOpen(open ?? false);
-    }, [open]);
-    const anchorEl = triggerRef.current;
-    return (jsxRuntime.jsx(PopoverContext.Provider, { value: {
-            triggerRef,
-            anchorEl,
-            portal,
-            internalOpen,
-            isControlled,
-            setInternalOpen,
-            size,
-            variant,
-            placement,
-            onOpenChange,
-            onClose,
-            popoverId,
-            setPopoverId,
-            triggerId,
-            setTriggerId,
-        }, children: children }));
-};
-const PopoverContext = React__namespace.createContext({
-    size: 'sm',
-    variant: 'default',
-    anchorEl: null,
-    placement: 'top',
-    triggerRef: { current: null },
-    internalOpen: false,
-    setInternalOpen: () => { },
+            if (isOutside) {
+                setInternalOpen(false);
+                onClose?.();
+            }
+        };
+        const handleKeydown = (event) => {
+            if (event.key !== 'Escape' || !controlledOpen)
+                return;
+            event.preventDefault(); // Prevent closing fullscreen in Safari
+            setInternalOpen(false);
+            onClose?.();
+        };
+        popover?.togglePopover?.(controlledOpen);
+        document.addEventListener('click', handleClick, true); // Use capture to execute before React event API
+        document.addEventListener('keydown', handleKeydown);
+        return () => {
+            document.removeEventListener('click', handleClick, true);
+            document.removeEventListener('keydown', handleKeydown);
+        };
+    }, [controlledOpen]);
+    // Position with floating-ui
+    react.useEffect(() => {
+        const popover = popoverRef.current;
+        const trigger = document.querySelector(`[popovertarget="${popover?.id}"]`);
+        if (popover && trigger && controlledOpen)
+            return dom.autoUpdate(trigger, popover, () => {
+                dom.computePosition(trigger, popover, {
+                    placement,
+                    strategy: 'fixed',
+                    middleware: [
+                        dom.offset((data) => {
+                            // get pseudo element arrow size
+                            const styles = getComputedStyle(data.elements.floating, '::before');
+                            return parseFloat(styles.height);
+                        }),
+                        ...(autoPlacement
+                            ? [dom.flip({ fallbackAxisSideDirection: 'start' }), dom.shift()]
+                            : []),
+                        arrowPseudoElement,
+                    ],
+                }).then(({ x, y }) => {
+                    popover.style.translate = `${x}px ${y}px`;
+                });
+            });
+    }, [controlledOpen, placement, id, autoPlacement]);
+    // Update context with id
+    react.useEffect(() => {
+        if (id)
+            setPopoverId?.(id);
+    }, [id]);
+    return (jsxRuntime.jsx(Component, { className: cl('ds-popover', className), id: id || popoverId, 
+        // @ts-ignore @types/react-dom does not understand popover yet
+        popover: 'manual', "data-variant": variant, ref: mergedRefs, ...rest }));
 });
-Popover.displayName = 'Popover';
+const arrowPseudoElement = {
+    name: 'ArrowPseudoElement',
+    fn(data) {
+        const { elements, rects, placement } = data;
+        let arrowX = `${Math.round(rects.reference.width / 2 + rects.reference.x - data.x)}px`;
+        let arrowY = `${Math.round(rects.reference.height / 2 + rects.reference.y - data.y)}px`;
+        if (rects.reference.width > rects.floating.width) {
+            arrowX = `${Math.round(rects.floating.width / 2)}px`;
+        }
+        if (rects.reference.height > rects.floating.height) {
+            arrowY = `${Math.round(rects.floating.height / 2)}px`;
+        }
+        switch (placement.split('-')[0]) {
+            case 'top':
+                arrowY = '100%';
+                break;
+            case 'right':
+                arrowX = '0';
+                break;
+            case 'bottom':
+                arrowY = '0';
+                break;
+            case 'left':
+                arrowX = '100%';
+                break;
+        }
+        elements.floating.setAttribute('data-placement', placement.split('-')[0]); // We only need top/left/right/bottom
+        elements.floating.style.setProperty('--ds-popover-arrow-x', arrowX);
+        elements.floating.style.setProperty('--ds-popover-arrow-y', arrowY);
+        return data;
+    },
+};
 
 exports.Popover = Popover;
-exports.PopoverContext = PopoverContext;

package/dist/cjs/components/Popover/PopoverTrigger.js

@@ -2,24 +2,44 @@
 'use strict';
 
 var jsxRuntime = require('react/jsx-runtime');
-var React = require('react');
-var floatingUi_react = require('../../node_modules/@floating-ui/react/dist/floating-ui.react.js');
-var index = require('../../node_modules/@radix-ui/react-slot/dist/index.js');
-var Popover = require('./Popover.js');
+var reactSlot = require('@radix-ui/react-slot');
+var react = require('react');
 var Button = require('../Button/Button.js');
+var PopoverTriggerContext = require('./PopoverTriggerContext.js');
 
-const PopoverTrigger = React.forwardRef(({ id, asChild, ...rest }, ref) => {
-    const { triggerRef, internalOpen, setInternalOpen, isControlled, popoverId, triggerId, setTriggerId, } = React.useContext(Popover.PopoverContext);
-    const mergedRefs = floatingUi_react.useMergeRefs([ref, triggerRef]);
-    React.useEffect(() => {
-        id && setTriggerId?.(id);
-    }, [id, setTriggerId]);
-    const Component = asChild ? index.Slot : Button.Button;
-    return (jsxRuntime.jsx(Component, { ref: mergedRefs, onClick: () => {
-            if (!isControlled)
-                setInternalOpen(!internalOpen);
-        }, "aria-expanded": internalOpen, "aria-controls": internalOpen ? popoverId : undefined, id: triggerId, ...rest }));
+/**
+ * PopoverTrigger component, used to trigger a popover.
+ *
+ * @example
+ * <Popover.TriggerContext>
+ *   <Popover.Trigger>Open Popover</Popover.Trigger>
+ *   <Popover>
+ *     Content
+ *   </Popover>
+ * </Popover.TriggerContext>
+ *
+ * @example inline
+ * <Popover.TriggerContext>
+ *   <Paragraph>
+ *    We can use it <Popover.Trigger inline={true}>inline</Popover.Trigger>.
+ *   </Paragraph>
+ *   <Popover>
+ *     Content
+ *   </Popover>
+ * </Popover.TriggerContext>
+ */
+const PopoverTrigger = react.forwardRef(function PopoverTrigger({ id, inline, asChild, ...rest }, ref) {
+    const { popoverId } = react.useContext(PopoverTriggerContext.Context);
+    const Component = asChild ? reactSlot.Slot : inline ? 'button' : Button.Button;
+    const popoverProps = Object.assign({
+        [react.version.startsWith('19') ? 'popoverTarget' : 'popovertarget']: popoverId,
+        ...(inline
+            ? {
+                'data-popover': 'inline',
+            }
+            : {}),
+    }, rest);
+    return jsxRuntime.jsx(Component, { ref: ref, ...popoverProps });
 });
-PopoverTrigger.displayName = 'PopoverTrigger';
 
 exports.PopoverTrigger = PopoverTrigger;

package/dist/cjs/components/Popover/PopoverTriggerContext.js

@@ -0,0 +1,27 @@
+'use client';
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var react = require('react');
+
+/**
+ * PopoverTriggerContext component, use to wrap a Popover.Trigger and Popover.
+ *
+ * @example
+ * <Popover.TriggerContext>
+ *   <Popover.Trigger>Open Popover</Popover.Trigger>
+ *   <Popover>
+ *     Content
+ *   </Popover>
+ * </Popover.TriggerContext>
+ */
+const PopoverTriggerContext = ({ children, }) => {
+    const randomPopoverId = react.useId();
+    const [popoverId, setPopoverId] = react.useState(randomPopoverId);
+    return (jsxRuntime.jsx(Context.Provider, { value: { popoverId, setPopoverId }, children: children }));
+};
+PopoverTriggerContext.displayName = 'PopoverTriggerContext';
+const Context = react.createContext({});
+
+exports.Context = Context;
+exports.PopoverTriggerContext = PopoverTriggerContext;

package/dist/cjs/components/Popover/index.js

@@ -2,15 +2,27 @@
 'use strict';
 
 var Popover$1 = require('./Popover.js');
-var PopoverContent = require('./PopoverContent.js');
 var PopoverTrigger = require('./PopoverTrigger.js');
+var PopoverTriggerContext = require('./PopoverTriggerContext.js');
 
-const Popover = Popover$1.Popover;
-Popover.Content = PopoverContent.PopoverContent;
-Popover.Trigger = PopoverTrigger.PopoverTrigger;
-Popover.Content.displayName = 'Popover.Content';
+/**
+ * Popover component, used to display content in a popover over an element.
+ *
+ * @example
+ * <Popover.TriggerContext>
+ *   <Popover.Trigger>Open Popover</Popover.Trigger>
+ *   <Popover>
+ *     Content
+ *   </Popover>
+ * </Popover.TriggerContext>
+ */
+const Popover = Object.assign(Popover$1.Popover, {
+    TriggerContext: PopoverTriggerContext.PopoverTriggerContext,
+    Trigger: PopoverTrigger.PopoverTrigger,
+});
+Popover.TriggerContext.displayName = 'Popover.TriggerContext';
 Popover.Trigger.displayName = 'Popover.Trigger';
 
-exports.PopoverContent = PopoverContent.PopoverContent;
 exports.PopoverTrigger = PopoverTrigger.PopoverTrigger;
+exports.PopoverTriggerContext = PopoverTriggerContext.PopoverTriggerContext;
 exports.Popover = Popover;

package/dist/cjs/components/Radio/Radio.js

@@ -0,0 +1,21 @@
+'use client';
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var react = require('react');
+var index = require('../Field/index.js');
+var Input = require('../Input/Input.js');
+var Label = require('../Label/Label.js');
+var ValidationMessage = require('../ValidationMessage/ValidationMessage.js');
+
+/**
+ * Radio used to select multiple options.
+ *
+ * @example
+ * <Radio label="I agree" value="agree" />
+ */
+const Radio = react.forwardRef(function Radio({ 'data-size': size, className, style, children, label, description, error, ...rest }, ref) {
+    return (jsxRuntime.jsxs(index.Field, { "data-size": size, className: className, style: style, children: [jsxRuntime.jsx(Input.Input, { type: 'radio', ref: ref, ...rest }), !!label && jsxRuntime.jsx(Label.Label, { weight: 'regular', children: label }), !!description && jsxRuntime.jsx("div", { "data-field": 'description', children: description }), !!error && jsxRuntime.jsx(ValidationMessage.ValidationMessage, { children: error })] }));
+});
+
+exports.Radio = Radio;

package/dist/cjs/components/Search/Search.js

@@ -0,0 +1,28 @@
+'use client';
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var cl = require('clsx/lite');
+var react = require('react');
+
+/**
+ * Search component, use to display different variations of a search input
+ *
+ * @example with button
+ * <Search>
+ *   <Search.Input aria-label='Søk' />
+ *   <Search.Clear />
+ *   <Search.Button />
+ * </Search>
+ *
+ * @example with icon
+ * <Search>
+ *   <Search.Input aria-label='Søk' />
+ *   <Search.Clear />
+ * </Search>
+ */
+const Search = react.forwardRef(function Search({ className, ...rest }, ref) {
+    return jsxRuntime.jsx("div", { ref: ref, className: cl('ds-search', className), ...rest });
+});
+
+exports.Search = Search;

package/dist/cjs/components/Search/SearchButton.js

@@ -0,0 +1,21 @@
+'use client';
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var react = require('react');
+var Button = require('../Button/Button.js');
+
+/**
+ * SearchButton component, used to display a search button within a Search component.
+ *
+ * @example
+ * <Search>
+ *   <Search.Input aria-label='Søk' />
+ *   <Search.Button>Søk</Search.Button>
+ * </Search>
+ */
+const SearchButton = react.forwardRef(function SearchButton({ children = 'Søk', ...rest }, ref) {
+    return (jsxRuntime.jsx(Button.Button, { ref: ref, type: 'submit', ...rest, children: children }));
+});
+
+exports.SearchButton = SearchButton;

package/dist/cjs/components/Search/SearchClear.js

@@ -0,0 +1,37 @@
+'use client';
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var react = require('react');
+var utilities = require('../Combobox/utilities.js');
+var Button = require('../Button/Button.js');
+
+/**
+ * SearchClear component, used to display a clear buttun when the search input is not empty.
+ *
+ * @example
+ * <Search>
+ *   <Search.Input aria-label='Søk' />
+ *   <Search.Clear />
+ * </Search>
+ */
+const SearchClear = react.forwardRef(function SearchClear({ 'aria-label': label = 'Tøm', onClick, ...rest }, ref) {
+    const handleClear = (e) => {
+        const target = e.target;
+        let input = null;
+        if (target instanceof HTMLElement)
+            input = target.closest('.ds-search')?.querySelector('input');
+        if (!input)
+            throw new Error('Input is missing');
+        /* narrow type to make TS happy */
+        if (!(input instanceof HTMLInputElement))
+            throw new Error('Input is not an input element');
+        e.preventDefault();
+        utilities.setReactInputValue(input, '');
+        input.focus();
+        onClick?.(e);
+    };
+    return (jsxRuntime.jsx(Button.Button, { ref: ref, variant: 'tertiary', type: 'reset', "aria-label": label, onClick: handleClear, icon: true, ...rest }));
+});
+
+exports.SearchClear = SearchClear;

package/dist/cjs/components/Search/SearchInput.js

@@ -0,0 +1,22 @@
+'use client';
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var react = require('react');
+var Input = require('../Input/Input.js');
+
+/**
+ * SearchInput component, used to display a search input within the Search component.
+ *
+ * @example
+ * <Search>
+ *   <Search.Input aria-label='Søk' />
+ * </Search>
+ */
+const SearchInput = react.forwardRef(function SearchInput({ ...rest }, ref) {
+    return (jsxRuntime.jsx(Input.Input, { ref: ref, type: 'search', 
+        /* We need an empty placeholder for the clear button to be able to show/hide */
+        placeholder: '', ...rest }));
+});
+
+exports.SearchInput = SearchInput;

package/dist/cjs/components/Search/index.js

@@ -0,0 +1,37 @@
+'use client';
+'use strict';
+
+var Search$1 = require('./Search.js');
+var SearchButton = require('./SearchButton.js');
+var SearchClear = require('./SearchClear.js');
+var SearchInput = require('./SearchInput.js');
+
+/**
+ * Search component, use to display different variations of a search input
+ *
+ * @example with button
+ * <Search>
+ *   <Search.Input aria-label='Søk' />
+ *   <Search.Clear />
+ *   <Search.Button />
+ * </Search>
+ *
+ * @example with icon
+ * <Search>
+ *   <Search.Input aria-label='Søk' />
+ *   <Search.Clear />
+ * </Search>
+ */
+const Search = Object.assign(Search$1.Search, {
+    Clear: SearchClear.SearchClear,
+    Button: SearchButton.SearchButton,
+    Input: SearchInput.SearchInput,
+});
+Search.Clear.displayName = 'Search.Clear';
+Search.Button.displayName = 'Search.Button';
+Search.Input.displayName = 'Search.Input';
+
+exports.SearchButton = SearchButton.SearchButton;
+exports.SearchClear = SearchClear.SearchClear;
+exports.SearchInput = SearchInput.SearchInput;
+exports.Search = Search;

package/dist/cjs/components/Select/Select.js

@@ -0,0 +1,31 @@
+'use client';
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var cl = require('clsx/lite');
+var react = require('react');
+
+/**
+ * Select component, used to display a native select.
+ *
+ * @example
+ * <Select>
+ *   <Select.Option value='1'>Option 1</Select.Option>
+ *   <Select.Option value='2'>Option 2</Select.Option>
+ * </Select>
+ */
+const Select = react.forwardRef(function Select({ className, onKeyDown, onMouseDown, width, ...rest }, ref) {
+    return (jsxRuntime.jsx("select", { className: cl('ds-input', className), "data-width": width, ref: ref, onKeyDown: (event) => {
+            if (event.key === 'Tab')
+                return;
+            if (rest.readOnly)
+                event.preventDefault(); // Make readonly work for select
+            onKeyDown?.(event);
+        }, onMouseDown: (event) => {
+            if (rest.readOnly)
+                event.preventDefault(); // Make readonly work for select
+            onMouseDown?.(event);
+        }, ...rest }));
+});
+
+exports.Select = Select;

package/dist/cjs/components/Select/SelectOptgroup.js

@@ -0,0 +1,24 @@
+'use client';
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var reactSlot = require('@radix-ui/react-slot');
+var react = require('react');
+
+/**
+ * SelectOptgroup component, used to display a native optgroup within a select.
+ *
+ * @example
+ * <Select>
+ *   <Select.Optgroup label='Group 1'>
+ *     <Select.Option value='1'>Option 1</Select.Option>
+ *     <Select.Option value='2'>Option 2</Select.Option>
+ *   </Select.Optgroup>
+ * </Select>
+ */
+const SelectOptgroup = react.forwardRef(function SelectOptgroup({ asChild, ...rest }, ref) {
+    const Component = asChild ? reactSlot.Slot : 'optgroup';
+    return jsxRuntime.jsx(Component, { ...rest, ref: ref });
+});
+
+exports.SelectOptgroup = SelectOptgroup;

package/dist/cjs/components/Select/SelectOption.js

@@ -0,0 +1,22 @@
+'use client';
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var reactSlot = require('@radix-ui/react-slot');
+var react = require('react');
+
+/**
+ * SelectOption component, used to display a native option within a select.
+ *
+ * @example
+ * <Select>
+ *   <Select.Option value='1'>Option 1</Select.Option>
+ *   <Select.Option value='2'>Option 2</Select.Option>
+ * </Select>
+ */
+const SelectOption = react.forwardRef(function SelectOption({ asChild, ...rest }, ref) {
+    const Component = asChild ? reactSlot.Slot : 'option';
+    return jsxRuntime.jsx(Component, { ...rest, ref: ref });
+});
+
+exports.SelectOption = SelectOption;

package/dist/cjs/components/Select/index.js

@@ -0,0 +1,26 @@
+'use client';
+'use strict';
+
+var Select$1 = require('./Select.js');
+var SelectOptgroup = require('./SelectOptgroup.js');
+var SelectOption = require('./SelectOption.js');
+
+/**
+ * Select component, used to display a native select.
+ *
+ * @example
+ * <Select>
+ *   <Select.Option value='1'>Option 1</Select.Option>
+ *   <Select.Option value='2'>Option 2</Select.Option>
+ * </Select>
+ */
+const Select = Object.assign(Select$1.Select, {
+    Option: SelectOption.SelectOption,
+    Optgroup: SelectOptgroup.SelectOptgroup,
+});
+Select.Option.displayName = 'Select.Option';
+Select.Optgroup.displayName = 'Select.Optgroup';
+
+exports.SelectOptgroup = SelectOptgroup.SelectOptgroup;
+exports.SelectOption = SelectOption.SelectOption;
+exports.Select = Select;

package/dist/cjs/components/Skeleton/Skeleton.js

@@ -0,0 +1,27 @@
+'use client';
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var react$1 = require('@floating-ui/react');
+var reactSlot = require('@radix-ui/react-slot');
+var cl = require('clsx/lite');
+var react = require('react');
+var useSynchronizedAnimation = require('../../utilities/hooks/useSynchronizedAnimation/useSynchronizedAnimation.js');
+
+/**
+ * Skeleton is used to represent a draft of page while the content loads.
+ *
+ * @example
+ * <Skeleton variant="circle" />
+ * <Skeleton variant="text" />
+ * <Skeleton variant="rectangle" />
+ */
+const Skeleton = react.forwardRef(function Skeleton({ asChild, className, height, style, variant = 'rectangle', width, ...rest }, ref) {
+    const Component = asChild ? reactSlot.Slot : 'span';
+    const isText = variant === 'text';
+    const animationRef = useSynchronizedAnimation.useSynchronizedAnimation('ds-skeleton-opacity-fade');
+    const mergedRefs = react$1.useMergeRefs([animationRef, ref]);
+    return (jsxRuntime.jsx(Component, { "aria-hidden": 'true', className: cl('ds-skeleton', className), "data-text": isText ? '-'.repeat(Number(width) || 1) : undefined, "data-variant": variant, ref: mergedRefs, style: isText ? style : { width, height, ...style }, ...rest }));
+});
+
+exports.Skeleton = Skeleton;

package/dist/cjs/components/SkipLink/SkipLink.js

@@ -2,11 +2,18 @@
 'use strict';
 
 var jsxRuntime = require('react/jsx-runtime');
-var lite = require('../../node_modules/clsx/dist/lite.js');
+var cl = require('clsx/lite');
+var react = require('react');
 
-const SkipLink = ({ href, children, className, ...rest }) => {
-    return (jsxRuntime.jsx("a", { href: href, className: lite.clsx(`ds-sr-only`, 'ds-skiplink', className), ...rest, children: jsxRuntime.jsx("p", { className: 'ds-skiplink__content', children: children }) }));
-};
-SkipLink.displayName = 'SkipLink';
+/**
+ * SkipLink component, used to display a skip link within the page.
+ * Place it at the top of the page to allow users to skip to the main content.
+ *
+ * @example
+ * <SkipLink href='#main-content'>Skip to main content</SkipLink>
+ */
+const SkipLink = react.forwardRef(function SkipLink({ children, className, ...rest }, ref) {
+    return (jsxRuntime.jsx("a", { className: cl('ds-skiplink', className), ...rest, ref: ref, children: children }));
+});
 
 exports.SkipLink = SkipLink;