@oaknational/oak-components 1.76.0 → 1.78.0

package/dist/types.d.ts

@@ -3720,6 +3720,76 @@ type OakDownloadsJourneyChildSubjectTierSelectorProps = {
  */
 declare const OakDownloadsJourneyChildSubjectTierSelector: styled_components.StyledComponent<(props: OakDownloadsJourneyChildSubjectTierSelectorProps) => React__default.JSX.Element, styled_components.DefaultTheme, {}, never>;
 
+/**
+ *
+ * These components can be used with InternalRadioWrapper which allows for customisable icons
+ *
+ * Several flavours of Radio are created here:
+ *  - Default
+ *  - Hover decorations
+ *  - Focus decorations
+ *  - Hover + Focus decorations
+ *
+ * As they are styled components they can be further customised in implementation. Alternatively additional
+ * components can be created here.
+ *
+ */
+type BaseRadioProps = {
+    id: string;
+    disabled?: boolean;
+    value: string;
+    name?: string;
+    /**
+     * Uncontrolled checked state
+     */
+    defaultChecked?: boolean;
+    /**
+     * Controlled checked state
+     */
+    checked?: boolean;
+    onHovered?: (value: string, id: string, duration: number) => void;
+    onChange?: (event: React__default.ChangeEvent<HTMLInputElement>) => void;
+    onFocus?: (event: React__default.FocusEvent<HTMLInputElement>) => void;
+    onBlur?: (event: React__default.FocusEvent<HTMLInputElement>) => void;
+    "aria-label"?: string;
+    "aria-labelledby"?: string;
+    "data-testid"?: string;
+};
+
+type OakRadioAsButtonProps = Omit<BaseRadioProps, "defaultChecked" | "id"> & {
+    innerRef?: React__default.RefObject<HTMLInputElement>;
+    displayValue: string;
+    icon?: OakIconName;
+    keepIconColor?: boolean;
+    disabled?: HTMLInputElement["disabled"];
+    checked?: HTMLInputElement["checked"];
+    value?: HTMLInputElement["value"];
+    "aria-labelledby"?: React__default.AriaAttributes["aria-labelledby"];
+    "aria-label"?: React__default.AriaAttributes["aria-label"];
+};
+/**
+ * A radio input styled as a button, to be used within `<RadioGroup/>` this is
+ * the radio inputs version of `<OakSearchFilterCheckBox/>`
+ *
+ * ## Events
+ * The following callbacks are available for tracking focus events:
+ *
+ * ### onChange
+ *  onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+ *
+ * ### onFocus
+ *   onFocus?: (event: React.FocusEvent<HTMLInputElement>) => void;
+ *
+ * ### onBlur
+ *    onBlur?: (event: React.FocusEvent<HTMLInputElement>) => void;
+ *
+ * ### onHovered
+ *  `onHovered?: (id, value, duration: number) => void;`<br>
+ *  called after a mouseEnter and mouseLeave event has happened
+ *
+ */
+declare const OakRadioAsButton: (props: OakRadioAsButtonProps) => React__default.JSX.Element;
+
 type OakCookieBannerProps = {
     /**
      * Triggered when the user clicks the "Hide this message" button.
@@ -4186,4 +4256,4 @@ declare function installMockIntersectionObserver(): void;
  */
 declare function installMockResizeObserver(): void;
 
-export { type BannerTypes, type Consent, HeadingTagComponent, type InternalQuizResultItemProps, type LessonSectionName$1 as LessonSectionName, OakAccordion, type OakAccordionProps, type OakAllSpacingToken, OakAnchorTarget, type OakAnchorTargetProps, OakAspectRatio, type OakAspectRatioProps, OakBackLink, type OakBackLinkProps, type OakBorderRadiusToken, type OakBorderWidthToken, OakBox, type OakBoxProps, OakBulletList, type OakBulletListProps, OakButtonAsRadioGroup, OakCardHeader, type OakCardHeaderprops, OakCardWithHandDrawnBorder, type OakCardWithHandDrawnBorderProps, OakCheckBox, type OakCheckBoxProps, OakCloudinaryConfigProvider, OakCloudinaryImage, type OakCloudinaryImageProps, OakCodeRenderer, OakCollapsibleContent, type OakCollapsibleContentProps, type OakColorFilterToken, type OakColorToken, type OakCombinedColorToken, type OakCombinedSpacingToken, OakCookieBanner, type OakCookieBannerProps, OakCookieConsent, OakCookieConsentContext, type OakCookieConsentProps, OakCookieConsentProvider, OakCookieSettingsModal, type OakCookieSettingsModalProps, OakCopyLinkButton, OakDownloadsJourneyChildSubjectTierSelector, type OakDownloadsJourneyChildSubjectTierSelectorProps, OakDragAndDropInstructions, OakDraggable, OakDraggableFeedback, type OakDropShadowToken, OakDroppable, type OakDroppableProps, OakFieldError, type OakFieldErrorProps, OakFieldset, type OakFieldsetProps, OakFilterDrawer, OakFlex, type OakFlexProps, type OakFontSizeToken, type OakFontToken, OakForm, type OakFormProps, OakGlobalStyle, OakGrid, OakGridArea, type OakGridAreaProps, type OakGridProps, type OakHandDrawnBoxWithIconProps, OakHandDrawnCard, type OakHandDrawnCardProps, OakHandDrawnCardWithIcon, OakHandDrawnFocusUnderline, type OakHandDrawnFocusUnderlineProps, OakHandDrawnHR, type OakHandDrawnHRProps, OakHeaderHero, type OakHeaderHeroProps, OakHeading, type OakHeadingProps, type OakHeadingTag, OakHintButton, type OakHintButtonProps, OakHomepageTabButton, type OakHomepageTabButtonProps, OakIcon, type OakIconName, type OakIconProps, OakImage, type OakImageProps, OakInfo, OakInfoButton, type OakInfoButtonProps, type OakInfoCardProps, type OakInfoProps, OakInlineBanner, type OakInlineBannerProps, type OakInnerPaddingToken, OakJauntyAngleLabel, type OakJauntyAngleLabelProps, OakKbd, type OakKbdProps, OakLI, type OakLIProps, OakLabel, type OakLabelProps, OakLessonBottomNav, type OakLessonBottomNavProps, OakLessonInfoCard, OakLessonLayout, type OakLessonLayoutProps, OakLessonNavItem, type OakLessonNavItemProps, OakLessonReviewIntroVideo, type OakLessonReviewIntroVideoProps, OakLessonReviewItem, type OakLessonReviewItemProps, OakLessonReviewQuiz, OakLessonTopNav, type OakLessonTopNavProps, OakLessonVideoTranscript, OakLink, type OakLinkProps, OakLoadingSpinner, type OakLoadingSpinnerProps, OakMaxWidth, OakMediaClip, OakMediaClipList, type OakMediaClipListProps, type OakMediaClipProps, OakMediaClipStackListItem, type OakMediaClipStackListItemProps, OakModal, OakModalBody, type OakModalBodyProps, OakModalCenter, OakModalCenterBody, type OakModalCenterBodyProps, type OakModalCenterProps, OakModalFooter, type OakModalFooterProps, type OakModalProps, OakOL, type OakOLProps, type OakOpacityToken, OakOutlineAccordion, type OakOutlineAccordionProps, OakP, type OakPProps, OakPagination, type OakPaginationProps, OakPrimaryButton, type OakPrimaryButtonProps, OakPrimaryInvertedButton, type OakPrimaryInvertedButtonProps, OakPrimaryNav, OakPrimaryNavItem, type OakPrimaryNavItemProps, type OakPrimaryNavProps, OakPromoTag, type OakPromoTagProps, type OakPupilContentGuidance, OakPupilJourneyContentGuidance, type OakPupilJourneyContentGuidanceProps, OakPupilJourneyHeader, type OakPupilJourneyHeaderProps, OakPupilJourneyLayout, type OakPupilJourneyLayoutProps, OakPupilJourneyList, OakPupilJourneyListCounter, OakPupilJourneyListItem, OakPupilJourneyListItemSubheading, type OakPupilJourneyListItemSubheadingProps, type OakPupilJourneyListProps, OakPupilJourneyOptionalityButton, OakPupilJourneyOptionalityItem, type OakPupilJourneyOptionalityItemProps, OakPupilJourneyProgrammeOptions, type OakPupilJourneyProgrammeOptionsProps, OakPupilJourneySubjectButton, type OakPupilJourneySubjectButtonProps, OakPupilJourneyUnitsFilter, type OakPupilJourneyUnitsFilterProps, OakPupilJourneyYearButton, type OakPupilJourneyYearButtonProps, OakQuizCheckBox, type OakQuizCheckBoxProps, OakQuizCounter, type OakQuizCounterProps, OakQuizFeedback, type OakQuizFeedbackProps, OakQuizHint, type OakQuizHintProps, OakQuizMatch, type OakQuizMatchProps, OakQuizOrder, type OakQuizOrderProps, OakQuizPrintableHeader, type OakQuizPrintableHeaderProps, OakQuizPrintableSubHeader, type OakQuizPrintableSubHeaderProps, OakQuizRadioButton, type OakQuizRadioButtonProps, OakQuizResultItem, OakQuizTextInput, OakQuote, type OakQuoteProps, OakRadioButton, OakRadioGroup, OakRadioTile, type OakRadioTileProps, OakRoundIcon, type OakRoundIconProps, OakScaleImageButton, type OakScaleImageButtonProps, OakScreenReader, OakSearchFilterCheckBox, type OakSearchFilterCheckBoxProps, OakSecondaryButton, OakSecondaryButtonAsRadio, type OakSecondaryButtonAsRadioProps, type OakSecondaryButtonProps, OakSecondaryLink, type OakSecondaryLinkProps, OakSignLanguageButton, OakSmallPrimaryButton, type OakSmallPrimaryButtonProps, OakSmallPrimaryInvertedButton, type OakSmallPrimaryInvertedButtonProps, OakSmallSecondaryButton, type OakSmallSecondaryButtonProps, type OakSpaceBetweenToken, OakSpan, type OakSpanProps, OakStaticMessageCard, OakSubjectIcon, type OakSubjectIconProps, OakSvg, type OakSvgNames, type OakSvgProps, OakTagFunctional, type OakTagFunctionalProps, OakTeacherNotesInline, type OakTeacherNotesInlineProps, OakTeacherNotesModal, type OakTeacherNotesModalProps, OakTertiaryButton, OakTertiaryOLNav, type OakTertiaryOLNavProps, OakTextInput, type OakTextInputProps, type OakTheme, OakThemeProvider, type OakThemeProviderProps, OakTimer, type OakTimerProps, OakTooltip, type OakTooltipProps, type OakTransitionToken, OakTypography, type OakTypographyProps, OakUL, type OakULProps, type OakUiRoleToken, OakUnitListItem, type OakUnitListItemProps, OakUnitListOptionalityItem, OakUnitListOptionalityItemCard, type OakUnitListOptionalityItemCardProps, type OakUnitListOptionalityItemProps, OakUnitsContainer, type OakUnitsContainerProps, OakUnitsHeader, type OakUnitsHeaderProps, OakVideoTranscript, type OakZIndexToken, type Phase$1 as Phase, type PolicyConsent, type PupilJourneySectionName, ReviewItemContainer, ReviewItemTitleSection, StyledMediaClipImage, type Subject, type Tier, type TileItem, bannerTypes, formatTimeCode, generateOakIconURL, getBackgroundUrlForSection, getDefaultContextState, installMockIntersectionObserver, installMockResizeObserver, isTileItem, isValidIconName, lessonSectionNames, oakAllSpacingTokens, oakBorderRadiusTokens, oakBorderWidthTokens, oakBoxCss, oakColorTokens, oakDefaultTheme, oakDropShadowTokens, oakFlexCss, oakFontSizeTokens, oakFontTokens, oakHeadingTags, oakIconNames, oakInnerPaddingTokens, oakOpacityTokens, oakPlaceholder, oakSpaceBetweenTokens, oakTransitionTokens, oakUiRoleTokens, oakZIndexTokens, placeholderStyles, removedGuidanceDuplicates, useCookieConsent };
+export { type BannerTypes, type Consent, HeadingTagComponent, type InternalQuizResultItemProps, type LessonSectionName$1 as LessonSectionName, OakAccordion, type OakAccordionProps, type OakAllSpacingToken, OakAnchorTarget, type OakAnchorTargetProps, OakAspectRatio, type OakAspectRatioProps, OakBackLink, type OakBackLinkProps, type OakBorderRadiusToken, type OakBorderWidthToken, OakBox, type OakBoxProps, OakBulletList, type OakBulletListProps, OakButtonAsRadioGroup, OakCardHeader, type OakCardHeaderprops, OakCardWithHandDrawnBorder, type OakCardWithHandDrawnBorderProps, OakCheckBox, type OakCheckBoxProps, OakCloudinaryConfigProvider, OakCloudinaryImage, type OakCloudinaryImageProps, OakCodeRenderer, OakCollapsibleContent, type OakCollapsibleContentProps, type OakColorFilterToken, type OakColorToken, type OakCombinedColorToken, type OakCombinedSpacingToken, OakCookieBanner, type OakCookieBannerProps, OakCookieConsent, OakCookieConsentContext, type OakCookieConsentProps, OakCookieConsentProvider, OakCookieSettingsModal, type OakCookieSettingsModalProps, OakCopyLinkButton, OakDownloadsJourneyChildSubjectTierSelector, type OakDownloadsJourneyChildSubjectTierSelectorProps, OakDragAndDropInstructions, OakDraggable, OakDraggableFeedback, type OakDropShadowToken, OakDroppable, type OakDroppableProps, OakFieldError, type OakFieldErrorProps, OakFieldset, type OakFieldsetProps, OakFilterDrawer, OakFlex, type OakFlexProps, type OakFontSizeToken, type OakFontToken, OakForm, type OakFormProps, OakGlobalStyle, OakGrid, OakGridArea, type OakGridAreaProps, type OakGridProps, type OakHandDrawnBoxWithIconProps, OakHandDrawnCard, type OakHandDrawnCardProps, OakHandDrawnCardWithIcon, OakHandDrawnFocusUnderline, type OakHandDrawnFocusUnderlineProps, OakHandDrawnHR, type OakHandDrawnHRProps, OakHeaderHero, type OakHeaderHeroProps, OakHeading, type OakHeadingProps, type OakHeadingTag, OakHintButton, type OakHintButtonProps, OakHomepageTabButton, type OakHomepageTabButtonProps, OakIcon, type OakIconName, type OakIconProps, OakImage, type OakImageProps, OakInfo, OakInfoButton, type OakInfoButtonProps, type OakInfoCardProps, type OakInfoProps, OakInlineBanner, type OakInlineBannerProps, type OakInnerPaddingToken, OakJauntyAngleLabel, type OakJauntyAngleLabelProps, OakKbd, type OakKbdProps, OakLI, type OakLIProps, OakLabel, type OakLabelProps, OakLessonBottomNav, type OakLessonBottomNavProps, OakLessonInfoCard, OakLessonLayout, type OakLessonLayoutProps, OakLessonNavItem, type OakLessonNavItemProps, OakLessonReviewIntroVideo, type OakLessonReviewIntroVideoProps, OakLessonReviewItem, type OakLessonReviewItemProps, OakLessonReviewQuiz, OakLessonTopNav, type OakLessonTopNavProps, OakLessonVideoTranscript, OakLink, type OakLinkProps, OakLoadingSpinner, type OakLoadingSpinnerProps, OakMaxWidth, OakMediaClip, OakMediaClipList, type OakMediaClipListProps, type OakMediaClipProps, OakMediaClipStackListItem, type OakMediaClipStackListItemProps, OakModal, OakModalBody, type OakModalBodyProps, OakModalCenter, OakModalCenterBody, type OakModalCenterBodyProps, type OakModalCenterProps, OakModalFooter, type OakModalFooterProps, type OakModalProps, OakOL, type OakOLProps, type OakOpacityToken, OakOutlineAccordion, type OakOutlineAccordionProps, OakP, type OakPProps, OakPagination, type OakPaginationProps, OakPrimaryButton, type OakPrimaryButtonProps, OakPrimaryInvertedButton, type OakPrimaryInvertedButtonProps, OakPrimaryNav, OakPrimaryNavItem, type OakPrimaryNavItemProps, type OakPrimaryNavProps, OakPromoTag, type OakPromoTagProps, type OakPupilContentGuidance, OakPupilJourneyContentGuidance, type OakPupilJourneyContentGuidanceProps, OakPupilJourneyHeader, type OakPupilJourneyHeaderProps, OakPupilJourneyLayout, type OakPupilJourneyLayoutProps, OakPupilJourneyList, OakPupilJourneyListCounter, OakPupilJourneyListItem, OakPupilJourneyListItemSubheading, type OakPupilJourneyListItemSubheadingProps, type OakPupilJourneyListProps, OakPupilJourneyOptionalityButton, OakPupilJourneyOptionalityItem, type OakPupilJourneyOptionalityItemProps, OakPupilJourneyProgrammeOptions, type OakPupilJourneyProgrammeOptionsProps, OakPupilJourneySubjectButton, type OakPupilJourneySubjectButtonProps, OakPupilJourneyUnitsFilter, type OakPupilJourneyUnitsFilterProps, OakPupilJourneyYearButton, type OakPupilJourneyYearButtonProps, OakQuizCheckBox, type OakQuizCheckBoxProps, OakQuizCounter, type OakQuizCounterProps, OakQuizFeedback, type OakQuizFeedbackProps, OakQuizHint, type OakQuizHintProps, OakQuizMatch, type OakQuizMatchProps, OakQuizOrder, type OakQuizOrderProps, OakQuizPrintableHeader, type OakQuizPrintableHeaderProps, OakQuizPrintableSubHeader, type OakQuizPrintableSubHeaderProps, OakQuizRadioButton, type OakQuizRadioButtonProps, OakQuizResultItem, OakQuizTextInput, OakQuote, type OakQuoteProps, OakRadioAsButton, type OakRadioAsButtonProps, OakRadioButton, OakRadioGroup, OakRadioTile, type OakRadioTileProps, OakRoundIcon, type OakRoundIconProps, OakScaleImageButton, type OakScaleImageButtonProps, OakScreenReader, OakSearchFilterCheckBox, type OakSearchFilterCheckBoxProps, OakSecondaryButton, OakSecondaryButtonAsRadio, type OakSecondaryButtonAsRadioProps, type OakSecondaryButtonProps, OakSecondaryLink, type OakSecondaryLinkProps, OakSignLanguageButton, OakSmallPrimaryButton, type OakSmallPrimaryButtonProps, OakSmallPrimaryInvertedButton, type OakSmallPrimaryInvertedButtonProps, OakSmallSecondaryButton, type OakSmallSecondaryButtonProps, type OakSpaceBetweenToken, OakSpan, type OakSpanProps, OakStaticMessageCard, OakSubjectIcon, type OakSubjectIconProps, OakSvg, type OakSvgNames, type OakSvgProps, OakTagFunctional, type OakTagFunctionalProps, OakTeacherNotesInline, type OakTeacherNotesInlineProps, OakTeacherNotesModal, type OakTeacherNotesModalProps, OakTertiaryButton, OakTertiaryOLNav, type OakTertiaryOLNavProps, OakTextInput, type OakTextInputProps, type OakTheme, OakThemeProvider, type OakThemeProviderProps, OakTimer, type OakTimerProps, OakTooltip, type OakTooltipProps, type OakTransitionToken, OakTypography, type OakTypographyProps, OakUL, type OakULProps, type OakUiRoleToken, OakUnitListItem, type OakUnitListItemProps, OakUnitListOptionalityItem, OakUnitListOptionalityItemCard, type OakUnitListOptionalityItemCardProps, type OakUnitListOptionalityItemProps, OakUnitsContainer, type OakUnitsContainerProps, OakUnitsHeader, type OakUnitsHeaderProps, OakVideoTranscript, type OakZIndexToken, type Phase$1 as Phase, type PolicyConsent, type PupilJourneySectionName, ReviewItemContainer, ReviewItemTitleSection, StyledMediaClipImage, type Subject, type Tier, type TileItem, bannerTypes, formatTimeCode, generateOakIconURL, getBackgroundUrlForSection, getDefaultContextState, installMockIntersectionObserver, installMockResizeObserver, isTileItem, isValidIconName, lessonSectionNames, oakAllSpacingTokens, oakBorderRadiusTokens, oakBorderWidthTokens, oakBoxCss, oakColorTokens, oakDefaultTheme, oakDropShadowTokens, oakFlexCss, oakFontSizeTokens, oakFontTokens, oakHeadingTags, oakIconNames, oakInnerPaddingTokens, oakOpacityTokens, oakPlaceholder, oakSpaceBetweenTokens, oakTransitionTokens, oakUiRoleTokens, oakZIndexTokens, placeholderStyles, removedGuidanceDuplicates, useCookieConsent };

package/package.json

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