@oaknational/oak-components 2.20.0 → 2.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.js +2 -2
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/index.js +2 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/types.d.ts +10 -1
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -866,6 +866,7 @@ declare const icons: {
|
|
|
866
866
|
readonly list: "v1774882349/icons/List.svg";
|
|
867
867
|
readonly "media-clips": "v1774884267/icons/media-clips_nw3zpt.svg";
|
|
868
868
|
readonly retake: "v1775141914/icons/retake-icon_xgqxzv.svg";
|
|
869
|
+
readonly globe: "v1776851811/icons/globe.svg";
|
|
869
870
|
};
|
|
870
871
|
type IconName = keyof typeof icons;
|
|
871
872
|
|
|
@@ -3499,6 +3500,10 @@ type OakCardProps = {
|
|
|
3499
3500
|
* The heading text of the card.
|
|
3500
3501
|
*/
|
|
3501
3502
|
heading: string;
|
|
3503
|
+
/**
|
|
3504
|
+
* The heading level of the card.
|
|
3505
|
+
*/
|
|
3506
|
+
headingLevel?: OakHeadingTag;
|
|
3502
3507
|
/**
|
|
3503
3508
|
* The URL that the card links to.
|
|
3504
3509
|
*/
|
|
@@ -3543,6 +3548,10 @@ type OakCardProps = {
|
|
|
3543
3548
|
* The name of the icon to be displayed next to the link text in the card.
|
|
3544
3549
|
*/
|
|
3545
3550
|
linkIconName?: OakIconName;
|
|
3551
|
+
/**
|
|
3552
|
+
* The background colour of the card on hover.
|
|
3553
|
+
*/
|
|
3554
|
+
hoverBackground?: OakUiRoleToken;
|
|
3546
3555
|
};
|
|
3547
3556
|
/**
|
|
3548
3557
|
* A highly customisable card component that displays a heading and takes a href at minimum.
|
|
@@ -3552,7 +3561,7 @@ type OakCardProps = {
|
|
|
3552
3561
|
* The card can be oriented in a row or column layout and its width can be adjusted using spacing tokens.
|
|
3553
3562
|
* The image aspect ratio can be set to either 1:1 or 4:3.
|
|
3554
3563
|
*/
|
|
3555
|
-
declare const OakCard: ({ heading, href, cardOrientation, cardWidth, imageSrc, imageAlt, aspectRatio, subCopy, tagName, tagBackground, linkText, linkIconName, }: OakCardProps) => React__default.JSX.Element;
|
|
3564
|
+
declare const OakCard: ({ heading, headingLevel, href, cardOrientation, cardWidth, imageSrc, imageAlt, aspectRatio, subCopy, tagName, tagBackground, linkText, linkIconName, hoverBackground, }: OakCardProps) => React__default.JSX.Element;
|
|
3556
3565
|
|
|
3557
3566
|
type OakBreadcrumb = {
|
|
3558
3567
|
text: string;
|