@navikt/ds-react 5.10.1 → 5.10.2

package/esm/util/OverridableComponent.d.ts

@@ -1,7 +1,24 @@
 import React from "react";
+/**
+ * This interface represents a component that can be overridden with different props and elements.
+ * @template Component The type of the props for the component.
+ * @template Element The type of the HTML element that the component renders.
+ */
 export interface OverridableComponent<Component, Element extends HTMLElement> {
+    /**
+     * This is a function type that takes props and returns a React functional component.
+     * @param props The props for the component, which are a combination of the Component type and React.RefAttributes for the Element type.
+     * @returns A React functional component.
+     */
     (props: Component & React.RefAttributes<Element>): ReturnType<React.FC>;
+    /**
+     * This is a function type that takes props and returns a React functional component.
+     * It allows for the 'as' prop to override the type of element that the component renders.
+     * @template As The type of the element that the component should render as.
+     * @param props The props for the component, which are a combination of the Component type, the 'as' prop, and any other props that are not part of the Component type or the 'as' prop.
+     * @returns A React functional component.
+     */
     <As extends React.ElementType>(props: {
-        as: As;
+        as?: As;
     } & Component & Omit<React.ComponentPropsWithRef<As>, keyof Component | "as">): ReturnType<React.FC>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@navikt/ds-react",
-  "version": "5.10.1",
+  "version": "5.10.2",
   "description": "Aksel react-components for NAV designsystem",
   "author": "Aksel | NAV designsystem team",
   "license": "MIT",
@@ -38,8 +38,8 @@
   },
   "dependencies": {
     "@floating-ui/react": "0.25.4",
-    "@navikt/aksel-icons": "^5.10.1",
-    "@navikt/ds-tokens": "^5.10.1",
+    "@navikt/aksel-icons": "^5.10.2",
+    "@navikt/ds-tokens": "^5.10.2",
     "@radix-ui/react-tabs": "1.0.0",
     "@radix-ui/react-toggle-group": "1.0.0",
     "clsx": "^1.2.1",

package/src/layout/bleed/Bleed.stories.tsx

@@ -1,8 +1,8 @@
-import React from "react";
 import type { Meta } from "@storybook/react";
+import React from "react";
+import { Box, HStack, VStack } from "../..";
 import { BodyLong } from "../../typography";
 import { Bleed } from "./Bleed";
-import { Box, HStack, VStack } from "../..";
 
 export default {
   title: "ds-react/Primitives/Bleed",

package/src/util/OverridableComponent.ts

@@ -1,11 +1,28 @@
 import React from "react";
 
+/**
+ * This interface represents a component that can be overridden with different props and elements.
+ * @template Component The type of the props for the component.
+ * @template Element The type of the HTML element that the component renders.
+ */
 export interface OverridableComponent<Component, Element extends HTMLElement> {
+  /**
+   * This is a function type that takes props and returns a React functional component.
+   * @param props The props for the component, which are a combination of the Component type and React.RefAttributes for the Element type.
+   * @returns A React functional component.
+   */
   (props: Component & React.RefAttributes<Element>): ReturnType<React.FC>;
 
+  /**
+   * This is a function type that takes props and returns a React functional component.
+   * It allows for the 'as' prop to override the type of element that the component renders.
+   * @template As The type of the element that the component should render as.
+   * @param props The props for the component, which are a combination of the Component type, the 'as' prop, and any other props that are not part of the Component type or the 'as' prop.
+   * @returns A React functional component.
+   */
   <As extends React.ElementType>(
     props: {
-      as: As;
+      as?: As;
     } & Component &
       Omit<React.ComponentPropsWithRef<As>, keyof Component | "as">
   ): ReturnType<React.FC>;