@oaknational/oak-components 2.31.0 → 2.32.0

package/dist/types.d.ts

@@ -3445,6 +3445,9 @@ type OakHoverLinkComponent = <C extends React__default.ElementType = "a">(props:
     displayDisabled?: boolean;
 } & PolymorphicPropsWithRef<C> & OakHoverLinkProps) => React__default.ReactNode;
 /**
+ * deprecated - use `<OakLink />` instead
+ * @deprecated
+ *
  * A link with an optional icon where underline is shown on hover.
  *
  * Defaulting to a `HTMLAnchorElement` this component is polymorphic and can be rendered as a button or any other element.
@@ -3453,16 +3456,23 @@ type OakHoverLinkComponent = <C extends React__default.ElementType = "a">(props:
  */
 declare const OakHoverLink: OakHoverLinkComponent;
 
+type Variant = "primary" | "secondary";
+
 type OakLinkProps = Pick<InternalLinkProps, "iconName" | "isTrailingIcon" | "isLoading"> & {
     iconWidth?: OakAllSpacingToken;
     iconHeight?: OakAllSpacingToken;
-};
+    /**
+     * Style variant of the OakLink component: "primary" | "secondary"
+     *
+     * @default "primary"
+     */
+    variant?: Variant;
+} & Pick<TypographyStyleProps, "$font">;
 type OakLinkComponent$1 = <C extends React__default.ElementType = "a">(props: PolymorphicPropsWithRef<C> & OakLinkProps) => React__default.ReactNode;
 /**
- * A blue link with an optional icon and loading state.
+ * A link with an optional icon and loading state.
  *
  * Defaulting to a `HTMLAnchorElement` this component is polymorphic and can be rendered as a button or any other element.
- * ą
  */
 declare const OakLink: OakLinkComponent$1;
 
@@ -3511,6 +3521,9 @@ type OakSecondaryLinkProps = {
 } & Pick<InternalLinkProps, "iconName" | "isTrailingIcon" | "isLoading">;
 type OakLinkComponent = <C extends React__default.ElementType = "a">(props: PolymorphicPropsWithRef<C> & OakSecondaryLinkProps) => React__default.ReactNode;
 /**
+ * deprecated - use `<OakLink variant="secondary"/>` instead
+ * @deprecated
+ *
  * A black link with an optional icon and loading state.
  *
  * Defaulting to a `HTMLAnchorElement` this component is polymorphic and can be rendered as a button or any other element.

package/package.json

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