@oaknational/oak-components 1.178.0 → 1.178.1

package/dist/types.d.ts

@@ -2667,6 +2667,34 @@ type OakJauntyAngleLabelProps = {
 } & ComponentProps<typeof OakBox>;
 declare const OakJauntyAngleLabel: (props: OakJauntyAngleLabelProps) => React__default.JSX.Element;
 
+type OakLeftAlignedButtonProps = Omit<InternalShadowRectButtonProps, "defaultBorderColor" | "defaultBackground" | "defaultTextColor" | "hoverBackground" | "hoverBorderColor" | "hoverTextColor" | "disabledBackground" | "disabledBorderColor" | "disabledTextColor"> & {
+    /**
+     * Whether to align the icon to the right with space-between justification
+     */
+    rightAlignIcon?: boolean;
+};
+/**
+ * A left-aligned button styled similarly to OakSmallPrimaryInvertedButton
+ * with configurable icon alignment.
+ *
+ * The following callbacks are available for tracking focus events:
+ *
+ * ### onClick
+ * `onClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;`
+ *
+ * ### onHovered
+ * `onHovered?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, duration: number) => void;`
+ * called after a mouseEnter and mouseLeave event has happened
+ */
+declare const OakLeftAlignedButton: <C extends React__default.ElementType = "button">(props: Omit<InternalShadowRectButtonProps, "defaultBackground" | "defaultBorderColor" | "defaultTextColor" | "disabledTextColor" | "hoverTextColor" | "hoverBackground" | "hoverBorderColor" | "disabledBackground" | "disabledBorderColor"> & {
+    /**
+     * Whether to align the icon to the right with space-between justification
+     */
+    rightAlignIcon?: boolean | undefined;
+} & {
+    element?: C | undefined;
+} & React__default.PropsWithoutRef<React__default.ComponentProps<C>>) => React__default.JSX.Element;
+
 type OakInfoCardProps = {
     children: React__default.ReactNode;
 };
@@ -5239,4 +5267,4 @@ declare function installMockResizeObserver(): void;
 
 declare const rgbToHex: (rgb: string) => string;
 
-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, oakLIDefaults, oakOpacityTokens, oakPlaceholder, oakSpaceBetweenTokens, oakTransitionTokens, oakUiRoleTokens, oakZIndexTokens, placeholderStyles, removedGuidanceDuplicates, rgbToHex, useCookieConsent };
+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, OakLeftAlignedButton, type OakLeftAlignedButtonProps, 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, oakLIDefaults, oakOpacityTokens, oakPlaceholder, oakSpaceBetweenTokens, oakTransitionTokens, oakUiRoleTokens, oakZIndexTokens, placeholderStyles, removedGuidanceDuplicates, rgbToHex, useCookieConsent };

package/package.json

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