@oaknational/oak-components 2.2.4 → 2.3.0

package/dist/types.d.ts

@@ -3563,12 +3563,28 @@ type OakLinkComponent = <C extends React__default.ElementType = "a">(props: Poly
  */
 declare const OakSecondaryLink: OakLinkComponent;
 
+type Tab<T> = {
+    label: T;
+} & ({
+    type: "button";
+} | {
+    type: "link";
+    href: string;
+});
 type OakTabsProps<T extends string> = {
     sizeVariant: ResponsiveValues<"default" | "compact">;
     colorVariant: "black" | "white";
-    tabs: Array<T>;
+    /**
+     * A list of the tabs to be rendered.
+     * Accepts a `label` and a `type` property for each tab. If the type is `link` then a `href` is required.
+     */
+    tabs: Array<Tab<T>>;
     activeTab: T;
-    onTabClick: (tab: T) => void;
+    /**
+     * Optional callback fn for the tab buttons.
+     *
+     */
+    onTabClick?: (tab: T, event: Event) => void;
 };
 declare function OakTabs<T extends string>(props: Readonly<OakTabsProps<T>>): React__default.JSX.Element;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oaknational/oak-components",
-  "version": "2.2.4",
+  "version": "2.3.0",
   "licence": "MIT",
   "description": "Shared components for Oak applications",
   "main": "dist/cjs/index.js",