@oaknational/oak-components 2.28.1 → 2.29.0

package/dist/types.d.ts

@@ -4473,19 +4473,35 @@ type OakCopyLinkButtonProps = {
 declare const OakCopyLinkButton: ({ href }: OakCopyLinkButtonProps) => React__default.JSX.Element;
 
 type OakDownloadCardProps = BaseCheckBoxProps & {
-    titleSlot: React__default.ReactNode;
-    fileSizeSlot?: React__default.ReactNode;
-    formatSlot: React__default.ReactNode;
-    iconName: IconName;
-    displayValue?: string;
-    asRadio?: boolean;
-} & InternalCheckBoxLabelProps;
+    /**
+     * The primary title content for the download.
+     */
+    title: React__default.ReactNode;
+    /**
+     * Optional file size content shown beneath the title.
+     */
+    fileSize?: React__default.ReactNode;
+    /**
+     * The file format or secondary metadata shown beneath the title.
+     */
+    format: React__default.ReactNode;
+    /**
+     * The icon used to represent the download type.
+     */
+    iconName: IconName | IconName[];
+    /**
+     * If true, renders the selection control as a radio button instead of a checkbox.
+     *
+     * @default false
+     */
+    isRadio?: boolean;
+};
 /**
- *
- * Used for choosing teaching resources, curriculum maps, or any downloadable items.
- *
+ * Download cards present a downloadable resource with metadata and a selectable control.
+ * ## Usage
+ * Use this component when users need to select one or more downloadable resources,
+ * such as lesson plans, slide decks, or worksheets.
  * Design document: <https://www.figma.com/design/YcWQMMhHPVVmc47cHHEEAl/Oak-Design-Kit?node-id=14795-5603>
- *
  */
 declare const OakDownloadCard: (props: OakDownloadCardProps) => React__default.JSX.Element;
 
@@ -5170,6 +5186,7 @@ type OakSubjectIconButtonProps = {
     phase: "primary" | "secondary" | "non-curriculum";
     subjectIconName: OakIconName;
     variant: "vertical" | "horizontal";
+    selected?: boolean;
 } & Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor" | "pv" | "ph" | "font">;
 /**
  *
@@ -5185,7 +5202,7 @@ type OakSubjectIconButtonProps = {
  *  `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
  *  called after a mouseEnter and mouseLeave event has happened
  */
-declare const OakSubjectIconButton: <C extends ElementType = "button">({ phase, element, subjectIconName, variant, ...rest }: OakSubjectIconButtonProps & PolymorphicPropsWithoutRef<C>) => React__default.JSX.Element;
+declare const OakSubjectIconButton: <C extends ElementType = "button">({ phase, element, subjectIconName, variant, selected, ...rest }: OakSubjectIconButtonProps & PolymorphicPropsWithoutRef<C>) => React__default.JSX.Element;
 
 type OakVideoTranscriptProps = {
     /**

package/package.json

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