@oaknational/oak-components 2.31.0 → 2.33.0

package/dist/types.d.ts

@@ -3065,6 +3065,22 @@ declare const OakKbd: ({ children }: OakKbdProps) => React__default.JSX.Element;
  */
 declare const OakScreenReader: styled_components.StyledComponent<"span", styled_components.DefaultTheme, {}, never>;
 
+type OakLoadingSpinnerProps = Pick<SizeStyleProps, "$width"> & ColorStyleProps & {
+    loaderColor?: OakUiRoleToken;
+    /**
+     * Delay the appearance of the spinner
+     *
+     * Accepts a number in milliseconds
+     */
+    $delay?: number;
+};
+/**
+ *
+ * A loading spinner of variable size.
+ *
+ */
+declare const OakLoadingSpinner: (props: OakLoadingSpinnerProps) => React__default.JSX.Element;
+
 declare const oakHeadingTagsConst: readonly ["div", "h1", "h2", "h3", "h4", "h5", "h6"];
 type OakHeadingTag = (typeof oakHeadingTagsConst)[number];
 declare const oakHeadingTags: ("div" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6")[];
@@ -3117,6 +3133,10 @@ type OakInlineBannerProps = OakFlexProps & {
      * The color filter to apply to the icon
      */
     iconColorFilter?: OakUiRoleToken;
+    /**
+     * If true show a loading spinner instead of an icon
+     */
+    isLoading?: boolean;
     /**
      * The optional call to action to display in the banner
      */
@@ -3150,7 +3170,8 @@ type BannerTypes = {
 declare const bannerTypes: BannerTypes;
 type OakInlineBannerVariantProps = {
     [key in OakInlineBannerVariants]: {
-        icon: Partial<OakIconProps>;
+        defaultIconDimensions: Partial<SizeStyleProps>;
+        loadingSpinnerDimensions: Partial<OakLoadingSpinnerProps>;
         heading: Partial<OakHeadingProps>;
         closeButtonWrapper?: Partial<OakBoxProps>;
         ctaWrapper?: Partial<OakBoxProps>;
@@ -3171,6 +3192,7 @@ declare const bannerVariants: OakInlineBannerVariantProps;
  * - **type?** \-                       Optional type of banner to display (info, neutral, success, alert, error, warning) (default: info)
  * - **icon?** \-                       Optional icon to display in the banner
  * - **iconColorFilter?** \-            Optional color filter to apply to the icon
+ * - **isLoading?** \-                  If true show a loading spinner instead of an icon
  * - **cta?** \-                        Optional call to action to display in the banner (ReactNode)
  * - **canDismiss?** \-                 If true the banner can be dismissed (show close icon) (default: false)
  * - **onDismiss?** \-                  Function called when the banner is dismissed
@@ -3178,23 +3200,7 @@ declare const bannerVariants: OakInlineBannerVariantProps;
  * - **variant?** \-                    The variant of the inline banner to display (regular, large) (default: regular)
  * - **...rest** \-                     Other props to be passed to the wrapper OakFlex component (can be used to override styles of the banner)
  */
-declare const OakInlineBanner: ({ isOpen, title, message, type, cta, canDismiss, onDismiss, icon, iconColorFilter, closeButtonOverrideProps, variant, titleTag, ...props }: OakInlineBannerProps) => React__default.JSX.Element;
-
-type OakLoadingSpinnerProps = Pick<SizeStyleProps, "$width"> & ColorStyleProps & {
-    loaderColor?: OakUiRoleToken;
-    /**
-     * Delay the appearance of the spinner
-     *
-     * Accepts a number in milliseconds
-     */
-    $delay?: number;
-};
-/**
- *
- * A loading spinner of variable size.
- *
- */
-declare const OakLoadingSpinner: (props: OakLoadingSpinnerProps) => React__default.JSX.Element;
+declare const OakInlineBanner: ({ isOpen, title, message, type, icon, iconColorFilter, isLoading, cta, canDismiss, onDismiss, closeButtonOverrideProps, variant, titleTag, ...props }: OakInlineBannerProps) => React__default.JSX.Element;
 
 type OakModalCenterProps = {
     /**
@@ -3445,6 +3451,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 +3462,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 +3527,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.33.0",
   "licence": "MIT",
   "description": "Shared components for Oak applications",
   "main": "dist/cjs/index.js",