@oaknational/oak-components 1.170.0 → 1.172.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 +3 -3
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/index.js +3 -3
- package/dist/esm/index.js.map +1 -1
- package/dist/types.d.ts +28 -26
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -4043,31 +4043,6 @@ type OakPupilJourneyProgrammeOptionsProps = {
|
|
|
4043
4043
|
*/
|
|
4044
4044
|
declare const OakPupilJourneyProgrammeOptions: ({ children, phase, titleSlot, optionTitleSlot, }: OakPupilJourneyProgrammeOptionsProps) => React__default.JSX.Element;
|
|
4045
4045
|
|
|
4046
|
-
type OakPupilJourneySubjectButtonProps = {
|
|
4047
|
-
phase: "primary" | "secondary" | "non-curriculum";
|
|
4048
|
-
subjectIconName: OakIconName;
|
|
4049
|
-
} & Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor" | "pv" | "ph" | "font">;
|
|
4050
|
-
/**
|
|
4051
|
-
*
|
|
4052
|
-
* A specific implementation of InternalRectButton
|
|
4053
|
-
*
|
|
4054
|
-
* Changes colour according to the phase prop. Can be used as a link or a button.
|
|
4055
|
-
* The following callbacks are available for tracking focus events:
|
|
4056
|
-
*
|
|
4057
|
-
* ### onClick
|
|
4058
|
-
* `onClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;`
|
|
4059
|
-
*
|
|
4060
|
-
* ### onHovered
|
|
4061
|
-
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
4062
|
-
* called after a mouseEnter and mouseLeave event has happened
|
|
4063
|
-
*/
|
|
4064
|
-
declare const OakPupilJourneySubjectButton: <C extends React__default.ElementType = "button">({ phase, element, subjectIconName, ...rest }: {
|
|
4065
|
-
phase: "primary" | "secondary" | "non-curriculum";
|
|
4066
|
-
subjectIconName: OakIconName;
|
|
4067
|
-
} & Omit<InternalShadowRectButtonProps, "font" | "defaultBackground" | "defaultBorderColor" | "defaultTextColor" | "disabledTextColor" | "hoverTextColor" | "hoverBackground" | "hoverBorderColor" | "disabledBackground" | "disabledBorderColor" | "pv" | "ph"> & {
|
|
4068
|
-
element?: C | undefined;
|
|
4069
|
-
} & React__default.PropsWithoutRef<React__default.ComponentProps<C>>) => React__default.JSX.Element;
|
|
4070
|
-
|
|
4071
4046
|
type MenuItem = {
|
|
4072
4047
|
displayText: string;
|
|
4073
4048
|
value: string;
|
|
@@ -5105,6 +5080,33 @@ type OakSubjectIconProps = Pick<OakHandDrawnBoxWithIconProps, "iconName" | "fill
|
|
|
5105
5080
|
*/
|
|
5106
5081
|
declare const OakSubjectIcon: ({ showPromoTag, ...rest }: OakSubjectIconProps) => React__default.JSX.Element;
|
|
5107
5082
|
|
|
5083
|
+
type OakSubjectIconButtonProps = {
|
|
5084
|
+
phase: "primary" | "secondary" | "non-curriculum";
|
|
5085
|
+
subjectIconName: OakIconName;
|
|
5086
|
+
variant: "vertical" | "horizontal";
|
|
5087
|
+
} & Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor" | "pv" | "ph" | "font">;
|
|
5088
|
+
/**
|
|
5089
|
+
*
|
|
5090
|
+
* A specific implementation of InternalRectButton
|
|
5091
|
+
*
|
|
5092
|
+
* Changes colour according to the phase prop. Can be used as a link or a button.
|
|
5093
|
+
* The following callbacks are available for tracking focus events:
|
|
5094
|
+
*
|
|
5095
|
+
* ### onClick
|
|
5096
|
+
* `onClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;`
|
|
5097
|
+
*
|
|
5098
|
+
* ### onHovered
|
|
5099
|
+
* `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`<br>
|
|
5100
|
+
* called after a mouseEnter and mouseLeave event has happened
|
|
5101
|
+
*/
|
|
5102
|
+
declare const OakSubjectIconButton: <C extends React__default.ElementType = "button">({ phase, element, subjectIconName, variant, ...rest }: {
|
|
5103
|
+
phase: "primary" | "secondary" | "non-curriculum";
|
|
5104
|
+
subjectIconName: OakIconName;
|
|
5105
|
+
variant: "vertical" | "horizontal";
|
|
5106
|
+
} & Omit<InternalShadowRectButtonProps, "font" | "defaultBackground" | "defaultBorderColor" | "defaultTextColor" | "disabledTextColor" | "hoverTextColor" | "hoverBackground" | "hoverBorderColor" | "disabledBackground" | "disabledBorderColor" | "pv" | "ph"> & {
|
|
5107
|
+
element?: C | undefined;
|
|
5108
|
+
} & React__default.PropsWithoutRef<React__default.ComponentProps<C>>) => React__default.JSX.Element;
|
|
5109
|
+
|
|
5108
5110
|
type OakVideoTranscriptProps = {
|
|
5109
5111
|
/**
|
|
5110
5112
|
* The transcript content
|
|
@@ -5215,4 +5217,4 @@ declare function installMockResizeObserver(): void;
|
|
|
5215
5217
|
|
|
5216
5218
|
declare const rgbToHex: (rgb: string) => string;
|
|
5217
5219
|
|
|
5218
|
-
export { type BannerTypes, type Consent, HeadingTagComponent, IconDown, IconUp, type InternalQuizResultItemProps, type LessonSectionName$1 as LessonSectionName, type MenuItemProps, OakAccordion, type OakAccordionProps, type OakAllSpacingToken, OakAnchorTarget, type OakAnchorTargetProps, OakAspectRatio, type OakAspectRatioProps, OakBackLink, type OakBackLinkProps, OakBasicAccordion, type OakBasicAccordionProps, type OakBorderRadiusToken, type OakBorderWidthToken, OakBox, type OakBoxProps, OakBulletList, type OakBulletListProps, OakButtonAsRadioGroup, OakButtonWithDropdown, type OakButtonWithDropdownProps, OakCATQuestion, type OakCATQuestionProps, OakCaptionCard, type OakCaptionCardProps, OakCaptionSearch, type OakCaptionSearchProps, OakCardHeader, type OakCardHeaderprops, OakCardWithHandDrawnBorder, type OakCardWithHandDrawnBorderProps, OakCarousel, type OakCarouselProps, OakCheckBox, type OakCheckBoxProps, OakCloseButton, type OakCloseButtonProps, OakCloudinaryConfigProvider, OakCloudinaryImage, type OakCloudinaryImageProps, OakCodeRenderer, type OakCodeRendererProps, OakCollapsibleContent, type OakCollapsibleContentProps, type OakColorFilterToken, type OakColorToken, type OakCombinedColorToken, type OakCombinedSpacingToken, OakCookieBanner, type OakCookieBannerProps, OakCookieConsent, OakCookieConsentContext, type OakCookieConsentProps, OakCookieConsentProvider, OakCookieSettingsModal, type OakCookieSettingsModalProps, OakCopyLinkButton, OakDownloadCard, type OakDownloadCardProps, OakDownloadsAccordion, type OakDownloadsAccordionProps, 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, OakFormInput, type OakFormInputProps, OakFormInputWithLabels, type OakFormInputWithLabelsProps, 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, OakHoverLink, type OakHoverLinkProps, OakIcon, type OakIconName, type OakIconProps, OakImage, type OakImageProps, OakInfo, OakInfoButton, type OakInfoButtonProps, type OakInfoCardProps, type OakInfoProps, OakInformativeModal, OakInformativeModalBody, type OakInformativeModalBodyProps, OakInformativeModalBorderColor, type OakInformativeModalCloseAction, OakInformativeModalFooter, type OakInformativeModalFooterProps, type OakInformativeModalProps, OakInlineBanner, type OakInlineBannerProps, type OakInlineBannerTypes, type OakInlineBannerVariantProps, type OakInlineBannerVariants, OakInlineRegistrationBanner, type OakInlineRegistrationBannerProps, 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, OakLinkCard, type OakLinkCardProps, type OakLinkProps, OakListItem, type OakListItemProps, OakLoadingSpinner, type OakLoadingSpinnerProps, OakMaxWidth, OakMediaClip, OakMediaClipList, OakMediaClipListAccordion, type OakMediaClipListProps, type OakMediaClipProps, OakMediaClipStackListItem, type OakMediaClipStackListItemProps, OakModalCenter, OakModalCenterBody, type OakModalCenterBodyProps, type OakModalCenterProps, OakMultilineText, type OakMultilineTextProps, OakOL, type OakOLProps, type OakOpacityToken, OakOptGroup, type OakOptGroupProps, OakOption, type OakOptionProps, 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,
|
|
5220
|
+
export { type BannerTypes, type Consent, HeadingTagComponent, IconDown, IconUp, type InternalQuizResultItemProps, type LessonSectionName$1 as LessonSectionName, type MenuItemProps, OakAccordion, type OakAccordionProps, type OakAllSpacingToken, OakAnchorTarget, type OakAnchorTargetProps, OakAspectRatio, type OakAspectRatioProps, OakBackLink, type OakBackLinkProps, OakBasicAccordion, type OakBasicAccordionProps, type OakBorderRadiusToken, type OakBorderWidthToken, OakBox, type OakBoxProps, OakBulletList, type OakBulletListProps, OakButtonAsRadioGroup, OakButtonWithDropdown, type OakButtonWithDropdownProps, OakCATQuestion, type OakCATQuestionProps, OakCaptionCard, type OakCaptionCardProps, OakCaptionSearch, type OakCaptionSearchProps, OakCardHeader, type OakCardHeaderprops, OakCardWithHandDrawnBorder, type OakCardWithHandDrawnBorderProps, OakCarousel, type OakCarouselProps, OakCheckBox, type OakCheckBoxProps, OakCloseButton, type OakCloseButtonProps, OakCloudinaryConfigProvider, OakCloudinaryImage, type OakCloudinaryImageProps, OakCodeRenderer, type OakCodeRendererProps, OakCollapsibleContent, type OakCollapsibleContentProps, type OakColorFilterToken, type OakColorToken, type OakCombinedColorToken, type OakCombinedSpacingToken, OakCookieBanner, type OakCookieBannerProps, OakCookieConsent, OakCookieConsentContext, type OakCookieConsentProps, OakCookieConsentProvider, OakCookieSettingsModal, type OakCookieSettingsModalProps, OakCopyLinkButton, OakDownloadCard, type OakDownloadCardProps, OakDownloadsAccordion, type OakDownloadsAccordionProps, 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, OakFormInput, type OakFormInputProps, OakFormInputWithLabels, type OakFormInputWithLabelsProps, 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, OakHoverLink, type OakHoverLinkProps, OakIcon, type OakIconName, type OakIconProps, OakImage, type OakImageProps, OakInfo, OakInfoButton, type OakInfoButtonProps, type OakInfoCardProps, type OakInfoProps, OakInformativeModal, OakInformativeModalBody, type OakInformativeModalBodyProps, OakInformativeModalBorderColor, type OakInformativeModalCloseAction, OakInformativeModalFooter, type OakInformativeModalFooterProps, type OakInformativeModalProps, OakInlineBanner, type OakInlineBannerProps, type OakInlineBannerTypes, type OakInlineBannerVariantProps, type OakInlineBannerVariants, OakInlineRegistrationBanner, type OakInlineRegistrationBannerProps, 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, OakLinkCard, type OakLinkCardProps, type OakLinkProps, OakListItem, type OakListItemProps, OakLoadingSpinner, type OakLoadingSpinnerProps, OakMaxWidth, OakMediaClip, OakMediaClipList, OakMediaClipListAccordion, type OakMediaClipListProps, type OakMediaClipProps, OakMediaClipStackListItem, type OakMediaClipStackListItemProps, OakModalCenter, OakModalCenterBody, type OakModalCenterBodyProps, type OakModalCenterProps, OakMultilineText, type OakMultilineTextProps, OakOL, type OakOLProps, type OakOpacityToken, OakOptGroup, type OakOptGroupProps, OakOption, type OakOptionProps, 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, OakPupilJourneyUnitsFilter, type OakPupilJourneyUnitsFilterProps, OakPupilJourneyYearButton, type OakPupilJourneyYearButtonProps, OakQuizCheckBox, type OakQuizCheckBoxProps, OakQuizCounter, type OakQuizCounterProps, OakQuizFeedback, type OakQuizFeedbackProps, OakQuizHint, type OakQuizHintProps, OakQuizMatch, OakQuizMatchItemId, type OakQuizMatchProps, OakQuizOrder, type OakQuizOrderProps, OakQuizOrderitemId, OakQuizPrintableHeader, type OakQuizPrintableHeaderProps, OakQuizPrintableSubHeader, type OakQuizPrintableSubHeaderProps, OakQuizRadioButton, type OakQuizRadioButtonProps, OakQuizResultItem, OakQuizTextInput, OakQuote, type OakQuoteProps, OakRadioAsButton, type OakRadioAsButtonProps, OakRadioButton, OakRadioGroup, type OakRadioGroupProps, OakRadioTile, type OakRadioTileProps, OakRoundIcon, type OakRoundIconProps, OakSaveButton, type OakSaveButtonProps, OakSaveCount, type OakSaveCountProps, OakScaleImageButton, type OakScaleImageButtonProps, OakScreenReader, OakSearchFilterCheckBox, type OakSearchFilterCheckBoxProps, OakSecondaryButton, OakSecondaryButtonAsRadio, type OakSecondaryButtonAsRadioProps, type OakSecondaryButtonProps, OakSecondaryButtonWithDropdown, type OakSecondaryButtonWithDropdownProps, OakSecondaryLink, type OakSecondaryLinkProps, OakSelect, type OakSelectProps, OakSideMenuNav, OakSideMenuNavLink, type OakSideMenuNavLinkProps, type OakSideMenuNavProps, OakSignLanguageButton, OakSmallPrimaryButton, type OakSmallPrimaryButtonProps, OakSmallPrimaryInvertedButton, type OakSmallPrimaryInvertedButtonProps, OakSmallSecondaryButton, type OakSmallSecondaryButtonProps, OakSmallSecondaryButtonWithDropdown, type OakSmallSecondaryButtonWithDropdownProps, OakSmallSecondaryToggleButton, type OakSmallSecondaryToggleButtonProps, OakSmallTertiaryInvertedButton, type OakSmallTertiaryInvertedButtonProps, type OakSolidBorderAccordionProps, type OakSpaceBetweenToken, OakSpan, type OakSpanProps, OakStaticMessageCard, OakSubjectIcon, OakSubjectIconButton, type OakSubjectIconButtonProps, type OakSubjectIconProps, OakSvg, type OakSvgNames, type OakSvgProps, OakTagFunctional, type OakTagFunctionalProps, OakTeacherNotesInline, type OakTeacherNotesInlineProps, OakTeacherNotesModal, type OakTeacherNotesModalProps, OakTertiaryButton, OakTertiaryInvertedButton, OakTertiaryOLNav, type OakTertiaryOLNavProps, OakTextArea, type OakTextAreaProps, OakTextInput, type OakTextInputProps, type OakTheme, OakThemeProvider, type OakThemeProviderProps, OakTimer, type OakTimerProps, OakToast, type OakToastProps, 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, RadioContext, ReviewItemContainer, ReviewItemTitleSection, StyledMediaClipImage, type Subject, type Tier, type TileItem, announcements, bannerTypes, bannerVariants, formatTimeCode, generateOakIconURL, getBackgroundUrlForSection, getDefaultContextState, installMockIntersectionObserver, installMockResizeObserver, isTileItem, isValidIconName, lessonSectionNames, oakAllSpacingTokens, oakBorderRadiusTokens, oakBorderWidthTokens, oakBoxCss, oakColorTokens, oakDarkTheme, oakDefaultTheme, oakDropShadowTokens, oakFlexCss, oakFontSizeTokens, oakFontTokens, oakHeadingTags, oakIconNames, oakInnerPaddingTokens, oakOpacityTokens, oakPlaceholder, oakSpaceBetweenTokens, oakTransitionTokens, oakUiRoleTokens, oakZIndexTokens, placeholderStyles, removedGuidanceDuplicates, rgbToHex, useCookieConsent };
|