@oaknational/oak-components 2.3.0 → 2.4.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 +12 -2
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as React$1 from 'react';
|
|
2
|
-
import React__default, { CSSProperties as CSSProperties$1, ElementType, ComponentPropsWithoutRef, ComponentPropsWithRef, MouseEventHandler, FC, ReactNode, HTMLAttributes, DetailedHTMLProps, TextareaHTMLAttributes, FocusEvent, InputHTMLAttributes, ChangeEventHandler, ComponentProps, ReactElement, MutableRefObject, ButtonHTMLAttributes } from 'react';
|
|
2
|
+
import React__default, { CSSProperties as CSSProperties$1, ElementType, ComponentPropsWithoutRef, ComponentPropsWithRef, MouseEventHandler, FC, ReactNode, HTMLAttributes, DetailedHTMLProps, TextareaHTMLAttributes, FocusEvent, InputHTMLAttributes, ChangeEventHandler, ComponentProps, ReactElement, MutableRefObject, ButtonHTMLAttributes, PropsWithChildren } from 'react';
|
|
3
3
|
import * as styled_components from 'styled-components';
|
|
4
4
|
import { ThemedStyledProps, DefaultTheme, CSSProperties } from 'styled-components';
|
|
5
5
|
import * as next_image from 'next/image';
|
|
@@ -104,6 +104,7 @@ type OakTheme = {
|
|
|
104
104
|
};
|
|
105
105
|
type PropsWithTheme<Props = unknown> = ThemedStyledProps<Props, DefaultTheme>;
|
|
106
106
|
|
|
107
|
+
type Device = "mobile" | "tablet" | "desktop";
|
|
107
108
|
type ResponsiveValues<Value> = (Value | null) | (Value | null)[];
|
|
108
109
|
|
|
109
110
|
declare const oakZIndexTokens: {
|
|
@@ -5483,4 +5484,13 @@ declare function installMockResizeObserver(): void;
|
|
|
5483
5484
|
|
|
5484
5485
|
declare const rgbToHex: (rgb: string) => string;
|
|
5485
5486
|
|
|
5486
|
-
|
|
5487
|
+
declare const useMediaQuery: (device: Device) => boolean;
|
|
5488
|
+
|
|
5489
|
+
declare const useMounted: () => boolean;
|
|
5490
|
+
|
|
5491
|
+
declare const useIsScrolled: () => {
|
|
5492
|
+
isScrolled: boolean;
|
|
5493
|
+
ObserveScroll: ({ children }: PropsWithChildren) => React__default.JSX.Element;
|
|
5494
|
+
};
|
|
5495
|
+
|
|
5496
|
+
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, OakCard, OakCardHeader, type OakCardHeaderprops, type OakCardProps, 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 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, OakFocusIndicator, type OakFocusIndicatorProps, 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, OakTabs, type OakTabsProps, 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, colorSchemes, 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, parseBorder, parseColor, parseColorFilter, parseDropShadow, parseFontSize, parseFontWeight, parseLetterSpacing, parseLineHeight, parseOpacity, parseSpacing, parseTransitions, parseZIndex, placeholderStyles, removedGuidanceDuplicates, rgbToHex, useCookieConsent, useIsScrolled, useMediaQuery, useMounted };
|